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.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a ROI.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`ROI`	The casted element, or nullptr if the cast fails

`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, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setID(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`hasName()` ¶

Checks whether the Name attribute is present.

The Name identifies the ROI to the user. [plain-text string]

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

The Name identifies the ROI to the user. [plain-text string]

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setAnnotationRef_List(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`clearAnnotationRef_List()` ¶

`setDescription(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`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

ROI¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setID(value, validate=True) ¶

getID() ¶

resetID() ¶

hasID() ¶

setName(value, validate=True) ¶

getName() ¶

resetName() ¶

hasName() ¶

getNameAllowedValues() staticmethod ¶

setAnnotationRef_List(value, validate=True) ¶

getAnnotationRef_List() ¶

addToAnnotationRef_List(value, validate=True) ¶

clearAnnotationRef_List() ¶

setDescription(value, validate=True) ¶

getDescription() ¶

resetDescription() ¶

hasDescription() ¶

setroi_choice(value, validate=True) ¶

getroi_choice() ¶

resetroi_choice() ¶

hasroi_choice() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setID(value, validate=True)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setName(value, validate=True)` ¶

`getName()` ¶

`resetName()` ¶

`hasName()` ¶

`getNameAllowedValues()` `staticmethod` ¶

`setAnnotationRef_List(value, validate=True)` ¶

`getAnnotationRef_List()` ¶

`addToAnnotationRef_List(value, validate=True)` ¶

`clearAnnotationRef_List()` ¶

`setDescription(value, validate=True)` ¶

`getDescription()` ¶

`resetDescription()` ¶

`hasDescription()` ¶

`setroi_choice(value, validate=True)` ¶

`getroi_choice()` ¶

`resetroi_choice()` ¶

`hasroi_choice()` ¶