CalibrationMap

Bases: NBOBaseClass

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.

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

setMetricType(value)

Sets the value of the MetricType attribute.

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

Parameters:

Name	Type	Description	Default
value	MatrixTypeEnum_Type	The value to set	required

getMetricType()

Returns the value of the MetricType attribute.

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

Returns:

Type	Description
MatrixTypeEnum_Type	The value of the attribute

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.

hasMetricType()

Checks whether the optional MetricType attribute is present.

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

Returns:

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

setIlluminationIntensity(value)

Sets the value of the IlluminationIntensity 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.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getIlluminationIntensity()

Returns the value of the IlluminationIntensity 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.

Returns:

Type	Description
float	The value of the attribute

setNrOfImages(value)

Sets the value of the NrOfImages attribute.

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

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getNrOfImages()

Returns the value of the NrOfImages attribute.

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

Returns:

Type	Description
int	The value of the attribute

setRow_List(value)

Sets the list of Row elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[rowType_Type]	The new list of Row elements	required

getRow_List()

Returns the list of Row elements.

No description available in the XSD standard.

Returns:

Type	Description
List[rowType_Type]	The list of Row elements

addToRow_List(value)

Adds a new Row element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	rowType_Type	The element to add	required

clearRow_List()

Clear the list of Row.

No description available in the XSD standard.

setDescription(value)

Sets the value of the Description element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Description	The value to set	required

getDescription()

Returns the value of the Description element.

No description available in the XSD standard.

Returns:

Type	Description
Description	The value of the element

resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

hasDescription()

Checks whether the optional Description element is present.

No description available in the XSD standard.

Returns:

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