com.inscoper.nbo.Mask¶

Represents the XML element Mask. More...

Inherits from com.inscoper.nbo.Shape_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Mask()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setX(float value, boolean validate) Sets the value of the X attribute.
void	setX(float value) Sets the value of the X attribute.
float	getX() Returns the value of the X attribute.
void	resetX() Resets the X attribute to an unset state.
boolean	hasX() Checks whether the X attribute is present.
void	setY(float value, boolean validate) Sets the value of the Y attribute.
void	setY(float value) Sets the value of the Y attribute.
float	getY() Returns the value of the Y attribute.
void	resetY() Resets the Y attribute to an unset state.
boolean	hasY() Checks whether the Y attribute is present.
void	setWidth(float value, boolean validate) Sets the value of the Width attribute.
void	setWidth(float value) Sets the value of the Width attribute.
float	getWidth() Returns the value of the Width attribute.
void	resetWidth() Resets the Width attribute to an unset state.
boolean	hasWidth() Checks whether the Width attribute is present.
void	setHeight(float value, boolean validate) Sets the value of the Height attribute.
void	setHeight(float value) Sets the value of the Height attribute.
float	getHeight() Returns the value of the Height attribute.
void	resetHeight() Resets the Height attribute to an unset state.
boolean	hasHeight() Checks whether the Height attribute is present.
void	setBinData(BinData value, boolean validate) Sets the value of the BinData element.
void	setBinData(BinData value) Sets the value of the BinData element.
BinData	getBinData() Returns the value of the BinData element.
void	resetBinData() Resets the BinData element to an unset state.
boolean	hasBinData() Checks whether the optional BinData element is present.
Mask	__internal_create(long cPtr, boolean own)
Mask	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	Mask(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Mask obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Shape_Type

	Name
	Shape_Type()
void	setFillColor(Color_Type value, boolean validate) Sets the value of the FillColor attribute.
void	setFillColor(Color_Type value) Sets the value of the FillColor attribute.
Color_Type	getFillColor() Returns the value of the FillColor attribute.
void	resetFillColor() Resets the FillColor attribute to an unset state.
boolean	hasFillColor() Checks whether the optional FillColor attribute is present.
void	setFillRule(String value, boolean validate) Sets the value of the FillRule attribute.
void	setFillRule(String value) Sets the value of the FillRule attribute.
String	getFillRule() Returns the value of the FillRule attribute.
void	resetFillRule() Resets the FillRule attribute to an unset state.
boolean	hasFillRule() Checks whether the FillRule attribute is present.
void	setStrokeColor(Color_Type value, boolean validate) Sets the value of the StrokeColor attribute.
void	setStrokeColor(Color_Type value) Sets the value of the StrokeColor attribute.
Color_Type	getStrokeColor() Returns the value of the StrokeColor attribute.
void	resetStrokeColor() Resets the StrokeColor attribute to an unset state.
boolean	hasStrokeColor() Checks whether the optional StrokeColor attribute is present.
void	setStrokeWidth(float value, boolean validate) Sets the value of the StrokeWidth attribute.
void	setStrokeWidth(float value) Sets the value of the StrokeWidth attribute.
float	getStrokeWidth() Returns the value of the StrokeWidth attribute.
void	resetStrokeWidth() Resets the StrokeWidth attribute to an unset state.
boolean	hasStrokeWidth() Checks whether the StrokeWidth attribute is present.
void	setStrokeWidthUnit(UnitsLength_Type value, boolean validate) Sets the value of the StrokeWidthUnit attribute.
void	setStrokeWidthUnit(UnitsLength_Type value) Sets the value of the StrokeWidthUnit attribute.
UnitsLength_Type	getStrokeWidthUnit() Returns the value of the StrokeWidthUnit attribute.
void	resetStrokeWidthUnit() Resets the StrokeWidthUnit attribute to an unset state.
boolean	hasStrokeWidthUnit() Checks whether the optional StrokeWidthUnit attribute is present.
void	setStrokeDashArray(String value, boolean validate) Sets the value of the StrokeDashArray attribute.
void	setStrokeDashArray(String value) Sets the value of the StrokeDashArray attribute.
String	getStrokeDashArray() Returns the value of the StrokeDashArray attribute.
void	resetStrokeDashArray() Resets the StrokeDashArray attribute to an unset state.
boolean	hasStrokeDashArray() Checks whether the StrokeDashArray attribute is present.
void	setText(String value, boolean validate) Sets the value of the Text attribute.
void	setText(String value) Sets the value of the Text attribute.
String	getText() Returns the value of the Text attribute.
void	resetText() Resets the Text attribute to an unset state.
boolean	hasText() Checks whether the Text attribute is present.
void	setFontFamily(String value, boolean validate) Sets the value of the FontFamily attribute.
void	setFontFamily(String value) Sets the value of the FontFamily attribute.
String	getFontFamily() Returns the value of the FontFamily attribute.
void	resetFontFamily() Resets the FontFamily attribute to an unset state.
boolean	hasFontFamily() Checks whether the FontFamily attribute is present.
void	setFontSize(NonNegativeInt_Type value, boolean validate) Sets the value of the FontSize attribute.
void	setFontSize(NonNegativeInt_Type value) Sets the value of the FontSize attribute.
NonNegativeInt_Type	getFontSize() Returns the value of the FontSize attribute.
void	resetFontSize() Resets the FontSize attribute to an unset state.
boolean	hasFontSize() Checks whether the optional FontSize attribute is present.
void	setFontSizeUnit(UnitsLength_Type value, boolean validate) Sets the value of the FontSizeUnit attribute.
void	setFontSizeUnit(UnitsLength_Type value) Sets the value of the FontSizeUnit attribute.
UnitsLength_Type	getFontSizeUnit() Returns the value of the FontSizeUnit attribute.
void	resetFontSizeUnit() Resets the FontSizeUnit attribute to an unset state.
boolean	hasFontSizeUnit() Checks whether the optional FontSizeUnit attribute is present.
void	setFontStyle(String value, boolean validate) Sets the value of the FontStyle attribute.
void	setFontStyle(String value) Sets the value of the FontStyle attribute.
String	getFontStyle() Returns the value of the FontStyle attribute.
void	resetFontStyle() Resets the FontStyle attribute to an unset state.
boolean	hasFontStyle() Checks whether the FontStyle attribute is present.
void	setLocked(boolean value, boolean validate) Sets the value of the Locked attribute.
void	setLocked(boolean value) Sets the value of the Locked attribute.
boolean	getLocked() Returns the value of the Locked attribute.
void	resetLocked() Resets the Locked attribute to an unset state.
boolean	hasLocked() Checks whether the Locked attribute is present.
void	setID(ShapeID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ShapeID_Type value) Sets the value of the ID attribute.
ShapeID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setTheZ(NonNegativeInt_Type value, boolean validate) Sets the value of the TheZ attribute.
void	setTheZ(NonNegativeInt_Type value) Sets the value of the TheZ attribute.
NonNegativeInt_Type	getTheZ() Returns the value of the TheZ attribute.
void	resetTheZ() Resets the TheZ attribute to an unset state.
boolean	hasTheZ() Checks whether the optional TheZ attribute is present.
void	setTheT(NonNegativeInt_Type value, boolean validate) Sets the value of the TheT attribute.
void	setTheT(NonNegativeInt_Type value) Sets the value of the TheT attribute.
NonNegativeInt_Type	getTheT() Returns the value of the TheT attribute.
void	resetTheT() Resets the TheT attribute to an unset state.
boolean	hasTheT() Checks whether the optional TheT attribute is present.
void	setTheC(NonNegativeInt_Type value, boolean validate) Sets the value of the TheC attribute.
void	setTheC(NonNegativeInt_Type value) Sets the value of the TheC attribute.
NonNegativeInt_Type	getTheC() Returns the value of the TheC attribute.
void	resetTheC() Resets the TheC attribute to an unset state.
boolean	hasTheC() Checks whether the optional TheC attribute is present.
void	setTransform(AffineTransform_Type value, boolean validate) Sets the value of the Transform element.
void	setTransform(AffineTransform_Type value) Sets the value of the Transform element.
AffineTransform_Type	getTransform() Returns the value of the Transform element.
void	resetTransform() Resets the Transform element to an unset state.
boolean	hasTransform() Checks whether the optional Transform element is present.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
StringSet	getFillRuleAllowedValues() Returns the allowed values for this attribut.
StringSet	getStrokeDashArrayAllowedValues() Returns the allowed values for this attribut.
StringSet	getTextAllowedValues() Returns the allowed values for this attribut.
StringSet	getFontFamilyAllowedValues() Returns the allowed values for this attribut.
StringSet	getFontStyleAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.Shape_Type

	Name
	Shape_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Mask;

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.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.Shape_Type.delete

function Mask¶

public Mask()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Shape_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Shape_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Shape_Type.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.Shape_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.Shape_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Shape_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.Shape_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Shape_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.Shape_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Shape_Type.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.Shape_Type.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Shape_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.Shape_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Shape_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.Shape_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.Shape_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.Shape_Type.toXmlString

function setX¶

public void setX(
    float value,
    boolean validate
)

Sets the value of the X attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setX¶

public void setX(
    float value
)

Sets the value of the X attribute.

Parameters:

value The value to set

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

function getX¶

public float getX()

Returns the value of the X attribute.

Return: The value of the attribute

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

function resetX¶

public void resetX()

Resets the X attribute to an unset state.

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

function hasX¶

public boolean hasX()

Checks whether the X attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setY¶

public void setY(
    float value,
    boolean validate
)

Sets the value of the Y attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setY¶

public void setY(
    float value
)

Sets the value of the Y attribute.

Parameters:

value The value to set

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

function getY¶

public float getY()

Returns the value of the Y attribute.

Return: The value of the attribute

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

function resetY¶

public void resetY()

Resets the Y attribute to an unset state.

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

function hasY¶

public boolean hasY()

Checks whether the Y attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setWidth¶

public void setWidth(
    float value,
    boolean validate
)

Sets the value of the Width attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The width of the mask. [units pixels]

function setWidth¶

public void setWidth(
    float value
)

Sets the value of the Width attribute.

Parameters:

value The value to set

The width of the mask. [units pixels]

function getWidth¶

public float getWidth()

Returns the value of the Width attribute.

Return: The value of the attribute

The width of the mask. [units pixels]

function resetWidth¶

public void resetWidth()

Resets the Width attribute to an unset state.

The width of the mask. [units pixels]

function hasWidth¶

public boolean hasWidth()

Checks whether the Width attribute is present.

Return: true if the attribute has been set, false otherwise

The width of the mask. [units pixels]

function setHeight¶

public void setHeight(
    float value,
    boolean validate
)

Sets the value of the Height attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The height of the mask. [units pixels]

function setHeight¶

public void setHeight(
    float value
)

Sets the value of the Height attribute.

Parameters:

value The value to set

The height of the mask. [units pixels]

function getHeight¶

public float getHeight()

Returns the value of the Height attribute.

Return: The value of the attribute

The height of the mask. [units pixels]

function resetHeight¶

public void resetHeight()

Resets the Height attribute to an unset state.

The height of the mask. [units pixels]

function hasHeight¶

public boolean hasHeight()

Checks whether the Height attribute is present.

Return: true if the attribute has been set, false otherwise

The height of the mask. [units pixels]

function setBinData¶

public void setBinData(
    BinData value,
    boolean validate
)

Sets the value of the BinData element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.