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) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
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) Sets the value of the IlluminationIntensity attribute.
float	getIlluminationIntensity() Returns the value of the IlluminationIntensity attribute.
void	setNrOfImages(int value) Sets the value of the NrOfImages attribute.
int	getNrOfImages() Returns the value of the NrOfImages attribute.
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) Adds a new Row element to this object.
void	clearRow_List() Clear the list of Row.
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)

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

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function CalibrationMap

public CalibrationMap()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.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.NBOBaseClass.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
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

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

public void resetMetricType()

Resets the MetricType attribute to an unset state.

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

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
)

Sets the value of the IlluminationIntensity attribute.

Parameters:

value The value to set

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function getIlluminationIntensity

public float getIlluminationIntensity()

Returns the value of the IlluminationIntensity attribute.

Return: The value of the attribute

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function setNrOfImages

public void setNrOfImages(
    int value
)

Sets the value of the NrOfImages attribute.

Parameters:

value The value to set

This field represents the number of images that were employed to generate this calibration matrix.

function getNrOfImages

public int getNrOfImages()

Returns the value of the NrOfImages attribute.

Return: The value of the attribute

This field represents the number of images that were employed to generate this calibration matrix.

function setRow_List

public void setRow_List(
    rowType_TypeVector value
)

Sets the list of Row elements.

Parameters:

value The new list of Row elements