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.

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)

setX(value, validate=True)

getX()

resetX()

hasX()

setY(value, validate=True)

getY()

resetY()

hasY()

setWidth(value, validate=True)

getWidth()

resetWidth()

hasWidth()

setHeight(value, validate=True)

getHeight()

resetHeight()

hasHeight()

setBinData(value, validate=True)

getBinData()

resetBinData()

hasBinData()