com.inscoper.nbo.CalibrationMap¶

Represents the XML element CalibrationMap. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	CalibrationMap()
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	setMetricType(MatrixTypeEnum_Type value, boolean validate) Sets the value of the MetricType attribute.
void	setMetricType(MatrixTypeEnum_Type value) Sets the value of the MetricType attribute.
MatrixTypeEnum_Type	getMetricType() Returns the value of the MetricType attribute.
void	resetMetricType() Resets the MetricType attribute to an unset state.
boolean	hasMetricType() Checks whether the optional MetricType attribute is present.
void	setIlluminationIntensity(float value, boolean validate) Sets the value of the IlluminationIntensity attribute.
void	setIlluminationIntensity(float value) Sets the value of the IlluminationIntensity attribute.
float	getIlluminationIntensity() Returns the value of the IlluminationIntensity attribute.
void	resetIlluminationIntensity() Resets the IlluminationIntensity attribute to an unset state.
boolean	hasIlluminationIntensity() Checks whether the IlluminationIntensity attribute is present.
void	setNrOfImages(int value, boolean validate) Sets the value of the NrOfImages attribute.
void	setNrOfImages(int value) Sets the value of the NrOfImages attribute.
int	getNrOfImages() Returns the value of the NrOfImages attribute.
void	resetNrOfImages() Resets the NrOfImages attribute to an unset state.
boolean	hasNrOfImages() Checks whether the NrOfImages attribute is present.
void	setRow_List(rowType_TypeVector value, boolean validate) Sets the list of Row elements.
void	setRow_List(rowType_TypeVector value) Sets the list of Row elements.
rowType_TypeVector	getRow_List() Returns the list of Row elements.
void	addToRow_List(rowType_Type value, boolean validate) Adds a new Row element to this object.
void	addToRow_List(rowType_Type value) Adds a new Row element to this object.
void	clearRow_List() Clear the list of Row.
void	setDescription(Description value, boolean validate) Sets the value of the Description element.
void	setDescription(Description value) Sets the value of the Description element.
Description	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
CalibrationMap	__internal_create(long cPtr, boolean own)
CalibrationMap	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CalibrationMap.

Protected Functions¶

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

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.CalibrationMap;

Represents the XML element CalibrationMap.

This element describes a 2D matrix containing values computed as a resulut of the calibration procedure. This matrix is the same size of the experimental Image this calibration refers to.

Public Functions Documentation¶

function delete¶

function CalibrationMap¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.NBOBaseClass.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.

function 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.

function 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.

function 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.

function 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.

function 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

function toXmlString¶

function setMetricType¶

public void setMetricType(
    MatrixTypeEnum_Type value,
    boolean validate
)

Sets the value of the MetricType attribute.

Parameters:

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

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function setMetricType¶

public void setMetricType(
    MatrixTypeEnum_Type value
)

Sets the value of the MetricType attribute.

Parameters:

value The value to set

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function getMetricType¶

public MatrixTypeEnum_Type getMetricType()

Returns the value of the MetricType attribute.

Return: The value of the attribute

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function resetMetricType¶

function hasMetricType¶

public boolean hasMetricType()

Checks whether the optional MetricType attribute is present.

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

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function setIlluminationIntensity¶

public void setIlluminationIntensity(
    float value,
    boolean validate
)

Sets the value of the IlluminationIntensity attribute.

Parameters:

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