Mask

Bases: Shape_Type

Represents the XML element Mask.

The Mask ROI shape is a link to a BinData object that is a BIT mask drawn on top of the Image as an ROI. It is applied at the same scale, Pixel to Pixel, as the Image the ROI is applied to, unless a transform is applied at the shape level.

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

setX(value)

Sets the value of the X attribute.

The X coordinate of the left side of the Image. [units pixels]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getX()

Returns the value of the X attribute.

The X coordinate of the left side of the Image. [units pixels]

Returns:

Type	Description
float	The value of the attribute

setY(value)

Sets the value of the Y attribute.

The Y coordinate of the top side of the Image. [units pixels]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getY()

Returns the value of the Y attribute.

The Y coordinate of the top side of the Image. [units pixels]

Returns:

Type	Description
float	The value of the attribute

setWidth(value)

Sets the value of the Width attribute.

The width of the mask. [units pixels]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getWidth()

Returns the value of the Width attribute.

The width of the mask. [units pixels]

Returns:

Type	Description
float	The value of the attribute

setHeight(value)

Sets the value of the Height attribute.

The height of the mask. [units pixels]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getHeight()

Returns the value of the Height attribute.

The height of the mask. [units pixels]

Returns:

Type	Description
float	The value of the attribute

setBinData(value)

Sets the value of the BinData element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	BinData	The value to set	required

getBinData()

Returns the value of the BinData element.

No description available in the XSD standard.

Returns:

Type	Description
BinData	The value of the element

resetBinData()

Resets the BinData element to an unset state.

No description available in the XSD standard.

hasBinData()

Checks whether the optional BinData element is present.

No description available in the XSD standard.

Returns:

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