ChromaticRegistrationEvaluation

Bases: NBOBaseClass

Represents the XML element ChromaticRegistrationEvaluation.

According to ISO 21073:2019, co-registration accuracy measures the capacity of a microscope system to image a fluorescent object with different excitation and emission Wavelengths at the same position in the Image. Hence, the spatial distance of the Image positions of a Point-like object (i.e., Spot or Point Emitter) located in the centre of the Field of View (FOV) for different excitation and detection Wavelength bands is denoted as co-registration accuracy. The co-registration accuracy shall be calculated from the Intensity maxima or the Intensity centre of gravity of the Image of the Point-like object for the different Wavelengths. The lateral co-registration accuracy is expressed as: ∆lateral

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

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LSID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setReferenceWavelength(value)

Sets the value of the ReferenceWavelength attribute.

This field captures the Wavelength of the Reference Channel against which the Chromatic Registration Accuracy is being calculated in this procedure.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getReferenceWavelength()

Returns the value of the ReferenceWavelength attribute.

This field captures the Wavelength of the Reference Channel against which the Chromatic Registration Accuracy is being calculated in this procedure.

Returns:

Type	Description
float	The value of the attribute

setReferenceWavelengthUnit(value)

Sets the value of the ReferenceWavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getReferenceWavelengthUnit()

Returns the value of the ReferenceWavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetReferenceWavelengthUnit()

Resets the ReferenceWavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasReferenceWavelengthUnit()

Checks whether the optional ReferenceWavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTestWavelength(value)

Sets the value of the TestWavelength attribute.

This field captures the Wavelength of the Test Channel whose Chromatic Registration Accuracy is being calculated in this procedure.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTestWavelength()

Returns the value of the TestWavelength attribute.

This field captures the Wavelength of the Test Channel whose Chromatic Registration Accuracy is being calculated in this procedure.

Returns:

Type	Description
float	The value of the attribute

setTestWavelengthUnit(value)

Sets the value of the TestWavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getTestWavelengthUnit()

Returns the value of the TestWavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetTestWavelengthUnit()

Resets the TestWavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasTestWavelengthUnit()

Checks whether the optional TestWavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setXChromaticShift_RT(value)

Sets the value of the XChromaticShift_RT attribute.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getXChromaticShift_RT()

Returns the value of the XChromaticShift_RT attribute.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetXChromaticShift_RT()

Resets the XChromaticShift_RT attribute to an unset state.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasXChromaticShift_RT()

Checks whether the optional XChromaticShift_RT attribute is present.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setXChromaticShift_RTUnit(value)

Sets the value of the XChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getXChromaticShift_RTUnit()

Returns the value of the XChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetXChromaticShift_RTUnit()

Resets the XChromaticShift_RTUnit attribute to an unset state.

No description available in the XSD standard.

hasXChromaticShift_RTUnit()

Checks whether the optional XChromaticShift_RTUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setYChromaticShift_RT(value)

Sets the value of the YChromaticShift_RT attribute.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getYChromaticShift_RT()

Returns the value of the YChromaticShift_RT attribute.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetYChromaticShift_RT()

Resets the YChromaticShift_RT attribute to an unset state.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasYChromaticShift_RT()

Checks whether the optional YChromaticShift_RT attribute is present.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(xλT - xλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setYChromaticShift_RTUnit(value)

Sets the value of the YChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getYChromaticShift_RTUnit()

Returns the value of the YChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetYChromaticShift_RTUnit()

Resets the YChromaticShift_RTUnit attribute to an unset state.

No description available in the XSD standard.

hasYChromaticShift_RTUnit()

Checks whether the optional YChromaticShift_RTUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setXChromaticShift_TR(value)

Sets the value of the XChromaticShift_TR attribute.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getXChromaticShift_TR()

Returns the value of the XChromaticShift_TR attribute.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetXChromaticShift_TR()

Resets the XChromaticShift_TR attribute to an unset state.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasXChromaticShift_TR()

Checks whether the optional XChromaticShift_TR attribute is present.

This field captures the offset in the the observed X-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setXChromaticShift_TRUnit(value)

Sets the value of the XChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getXChromaticShift_TRUnit()

Returns the value of the XChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetXChromaticShift_TRUnit()

Resets the XChromaticShift_TRUnit attribute to an unset state.

No description available in the XSD standard.

hasXChromaticShift_TRUnit()

Checks whether the optional XChromaticShift_TRUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setYChromaticShift_TR(value)

Sets the value of the YChromaticShift_TR attribute.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getYChromaticShift_TR()

Returns the value of the YChromaticShift_TR attribute.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetYChromaticShift_TR()

Resets the YChromaticShift_TR attribute to an unset state.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasYChromaticShift_TR()

Checks whether the optional YChromaticShift_TR attribute is present.

This field captures the offset in the the observed Y-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(xλR - xλT)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setYChromaticShift_TRUnit(value)

Sets the value of the YChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getYChromaticShift_TRUnit()

Returns the value of the YChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetYChromaticShift_TRUnit()

Resets the YChromaticShift_TRUnit attribute to an unset state.

No description available in the XSD standard.

hasYChromaticShift_TRUnit()

Checks whether the optional YChromaticShift_TRUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAxialChromaticShift_RT(value)

Sets the value of the AxialChromaticShift_RT attribute.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAxialChromaticShift_RT()

Returns the value of the AxialChromaticShift_RT attribute.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetAxialChromaticShift_RT()

Resets the AxialChromaticShift_RT attribute to an unset state.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasAxialChromaticShift_RT()

Checks whether the optional AxialChromaticShift_RT attribute is present.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Reference vs. the Test Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setAxialChromaticShift_RTUnit(value)

Sets the value of the AxialChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getAxialChromaticShift_RTUnit()

Returns the value of the AxialChromaticShift_RTUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetAxialChromaticShift_RTUnit()

Resets the AxialChromaticShift_RTUnit attribute to an unset state.

No description available in the XSD standard.

hasAxialChromaticShift_RTUnit()

Checks whether the optional AxialChromaticShift_RTUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAxialChromaticShift_TR(value)

Sets the value of the AxialChromaticShift_TR attribute.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAxialChromaticShift_TR()

Returns the value of the AxialChromaticShift_TR attribute.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

Type	Description
float	The value of the attribute

resetAxialChromaticShift_TR()

Resets the AxialChromaticShift_TR attribute to an unset state.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

hasAxialChromaticShift_TR()

Checks whether the optional AxialChromaticShift_TR attribute is present.

This field captures the offset in the the observed Z-coordinate of the Intensity maxima or the Intensity centre of gravity of the Image of a Point-like object (i.e., Spot or Point Emitter) when comparing the Test vs. the Reference Wavelengths. This shall be calculates as: √(zλT - zλR)^2, where This offset could be reported either in number of Pixels or in physical Distance, when a sub-Pixel offset needs to be calculated.

Returns:

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

setAxialChromaticShift_TRUnit(value)

Sets the value of the AxialChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getAxialChromaticShift_TRUnit()

Returns the value of the AxialChromaticShift_TRUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetAxialChromaticShift_TRUnit()

Resets the AxialChromaticShift_TRUnit attribute to an unset state.

No description available in the XSD standard.

hasAxialChromaticShift_TRUnit()

Checks whether the optional AxialChromaticShift_TRUnit attribute is present.

No description available in the XSD standard.

Returns:

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