ROI
Bases: NBOBaseClass
Represents the XML element ROI.
A four dimensional 'Region of Interest'. If they are not used, and the Image has more than one Plane, the entire set of Planes is assumed to be included in the ROI. Multiple ROIs may be specified.
getTypeName()
Returns the class type name.
Returns:
| Type | Description |
|---|---|
string
|
The class type name |
getXMLName()
Returns the XML element name corresponding to this class.
Returns:
| Type | Description |
|---|---|
string
|
The XML element name |
getNBOType()
Returns the NBO Type corresponding to this class.
Returns:
| Type | Description |
|---|---|
int
|
The NBO Type value |
getChildren()
Returns a list of all classes derived from this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of derived classes |
getSubElements()
Returns a list of all child elements contained in this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of child classes |
fromJsonFile(path)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setID(value)
Sets the value of the ID attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ROIID_Type
|
The value to set |
required |
getID()
Returns the value of the ID attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
ROIID_Type
|
The value of the attribute |
resetID()
Resets the ID attribute to an unset state.
No description available in the XSD standard.
hasID()
Checks whether the optional ID attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setName(value)
Sets the value of the Name attribute.
The Name identifies the ROI to the user. [plain-text string]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getName()
Returns the value of the Name attribute.
The Name identifies the ROI to the user. [plain-text string]
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetName()
Resets the Name attribute to an unset state.
The Name identifies the ROI to the user. [plain-text string]
hasName()
Checks whether the optional Name attribute is present.
The Name identifies the ROI to the user. [plain-text string]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAnnotationRef_List(value)
Sets the list of AnnotationRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[AnnotationRef]
|
The new list of AnnotationRef elements |
required |
getAnnotationRef_List()
Returns the list of AnnotationRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[AnnotationRef]
|
The list of AnnotationRef elements |
addToAnnotationRef_List(value)
Adds a new AnnotationRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AnnotationRef
|
The element to add |
required |
clearAnnotationRef_List()
Clear the list of AnnotationRef.
No description available in the XSD standard.
setDescription(value)
Sets the value of the Description element.
A description for the ROI. [plain-text multi-line string]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ROI_InlineDescription
|
The value to set |
required |
getDescription()
Returns the value of the Description element.
A description for the ROI. [plain-text multi-line string]
Returns:
| Type | Description |
|---|---|
ROI_InlineDescription
|
The value of the element |
resetDescription()
Resets the Description element to an unset state.
A description for the ROI. [plain-text multi-line string]
hasDescription()
Checks whether the optional Description element is present.
A description for the ROI. [plain-text multi-line string]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setroi_choice(value)
Sets the value of the roi_choice element.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ROI_Choice
|
The value to set |
required |
getroi_choice()
Returns the value of the roi_choice element.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
ROI_Choice
|
The value of the element |
resetroi_choice()
Resets the roi_choice element to an unset state.
No description available in the XSD standard.
hasroi_choice()
Checks whether the optional roi_choice element is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |