ExcitationCalibration

Bases: IntensityCalibration_Type

Represents the XML element ExcitationCalibration.

This element describes the procedure used to measure and calibrate the Wavelength and Irradiance of the Excitation Light Source used to Acquire this experimental Image and the resulting calibration measurements.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
ExcitationCalibration	The casted element, or nullptr if the cast fails

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, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setSpinningDiskInLightPath(value, validate=True)

Sets the value of the SpinningDiskInLightPath attribute.

In case of a Spinning Disk Confocal Microscope, this field records whether (True) or not (False) the Spinning Disk was placed in the Light Path during this Calibration Procedure.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getSpinningDiskInLightPath()

Returns the value of the SpinningDiskInLightPath attribute.

In case of a Spinning Disk Confocal Microscope, this field records whether (True) or not (False) the Spinning Disk was placed in the Light Path during this Calibration Procedure.

Returns:

Type	Description
boolean	The value of the attribute

resetSpinningDiskInLightPath()

Resets the SpinningDiskInLightPath attribute to an unset state.

In case of a Spinning Disk Confocal Microscope, this field records whether (True) or not (False) the Spinning Disk was placed in the Light Path during this Calibration Procedure.

hasSpinningDiskInLightPath()

Checks whether the SpinningDiskInLightPath attribute is present.

In case of a Spinning Disk Confocal Microscope, this field records whether (True) or not (False) the Spinning Disk was placed in the Light Path during this Calibration Procedure.

Returns:

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

setNominalEx_Wavelength(value, validate=True)

Sets the value of the NominalEx_Wavelength attribute.

In case this is different from the Excitation Wavelength of the Channel this Calibration Procedure is associated with, this field records the Nominal Peak Excitation Wavelength that is employed during this Procedure.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getNominalEx_Wavelength()

Returns the value of the NominalEx_Wavelength attribute.

In case this is different from the Excitation Wavelength of the Channel this Calibration Procedure is associated with, this field records the Nominal Peak Excitation Wavelength that is employed during this Procedure.

Returns:

Type	Description
float	The value of the attribute

resetNominalEx_Wavelength()

Resets the NominalEx_Wavelength attribute to an unset state.

In case this is different from the Excitation Wavelength of the Channel this Calibration Procedure is associated with, this field records the Nominal Peak Excitation Wavelength that is employed during this Procedure.

hasNominalEx_Wavelength()

Checks whether the NominalEx_Wavelength attribute is present.

In case this is different from the Excitation Wavelength of the Channel this Calibration Procedure is associated with, this field records the Nominal Peak Excitation Wavelength that is employed during this Procedure.

Returns:

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

setNominalEx_WavelengthUnit(value, validate=True)

Sets the value of the NominalEx_WavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getNominalEx_WavelengthUnit()

Returns the value of the NominalEx_WavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetNominalEx_WavelengthUnit()

Resets the NominalEx_WavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasNominalEx_WavelengthUnit()

Checks whether the optional NominalEx_WavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setObservedEx_Wavelength(value, validate=True)

Sets the value of the ObservedEx_Wavelength attribute.

This field records the observed Peak Excitation Wavelength at the Back Objective as measured by using this Calibration Procedure.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedEx_Wavelength()

Returns the value of the ObservedEx_Wavelength attribute.

This field records the observed Peak Excitation Wavelength at the Back Objective as measured by using this Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetObservedEx_Wavelength()

Resets the ObservedEx_Wavelength attribute to an unset state.

This field records the observed Peak Excitation Wavelength at the Back Objective as measured by using this Calibration Procedure.

hasObservedEx_Wavelength()

Checks whether the ObservedEx_Wavelength attribute is present.

This field records the observed Peak Excitation Wavelength at the Back Objective as measured by using this Calibration Procedure.

Returns:

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

setObservedEx_WavelengthUnit(value, validate=True)

Sets the value of the ObservedEx_WavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedEx_WavelengthUnit()

Returns the value of the ObservedEx_WavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetObservedEx_WavelengthUnit()

Resets the ObservedEx_WavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasObservedEx_WavelengthUnit()

Checks whether the optional ObservedEx_WavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPercentageNominalPowerSettings(value, validate=True)

Sets the value of the PercentageNominalPowerSettings attribute.

This field records the input % Nominal Illumination Power that was set during this Calibration Procedure as by the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getPercentageNominalPowerSettings()

Returns the value of the PercentageNominalPowerSettings attribute.

This field records the input % Nominal Illumination Power that was set during this Calibration Procedure as by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetPercentageNominalPowerSettings()

Resets the PercentageNominalPowerSettings attribute to an unset state.

This field records the input % Nominal Illumination Power that was set during this Calibration Procedure as by the Manufacturer.

hasPercentageNominalPowerSettings()

Checks whether the PercentageNominalPowerSettings attribute is present.

This field records the input % Nominal Illumination Power that was set during this Calibration Procedure as by the Manufacturer.

Returns:

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

setObservedIlluminationPowerAtBackOfObjective(value, validate=True)

Sets the value of the ObservedIlluminationPowerAtBackOfObjective attribute.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the back focal plane of the Objective by using this Calibration Procedure. In order to collect this metric it is necessary to remove the Objective.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedIlluminationPowerAtBackOfObjective()

Returns the value of the ObservedIlluminationPowerAtBackOfObjective attribute.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the back focal plane of the Objective by using this Calibration Procedure. In order to collect this metric it is necessary to remove the Objective.

Returns:

Type	Description
float	The value of the attribute

resetObservedIlluminationPowerAtBackOfObjective()

Resets the ObservedIlluminationPowerAtBackOfObjective attribute to an unset state.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the back focal plane of the Objective by using this Calibration Procedure. In order to collect this metric it is necessary to remove the Objective.

hasObservedIlluminationPowerAtBackOfObjective()

Checks whether the ObservedIlluminationPowerAtBackOfObjective attribute is present.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the back focal plane of the Objective by using this Calibration Procedure. In order to collect this metric it is necessary to remove the Objective.

Returns:

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

setObservedIlluminationPowerAtBackObjectiveUnit(value, validate=True)

Sets the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsPower_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedIlluminationPowerAtBackObjectiveUnit()

Returns the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsPower_Type	The value of the attribute

resetObservedIlluminationPowerAtBackObjectiveUnit()

Resets the ObservedIlluminationPowerAtBackObjectiveUnit attribute to an unset state.

No description available in the XSD standard.

hasObservedIlluminationPowerAtBackObjectiveUnit()

Checks whether the optional ObservedIlluminationPowerAtBackObjectiveUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setObseredIlluminationPowerAtSample(value, validate=True)

Sets the value of the ObseredIlluminationPowerAtSample attribute.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the Sample (also referred to as the Front of the Objective) by using this Calibration Procedure. This metric is typically recorded with the Objective in place.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObseredIlluminationPowerAtSample()

Returns the value of the ObseredIlluminationPowerAtSample attribute.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the Sample (also referred to as the Front of the Objective) by using this Calibration Procedure. This metric is typically recorded with the Objective in place.

Returns:

Type	Description
float	The value of the attribute

resetObseredIlluminationPowerAtSample()

Resets the ObseredIlluminationPowerAtSample attribute to an unset state.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the Sample (also referred to as the Front of the Objective) by using this Calibration Procedure. This metric is typically recorded with the Objective in place.

hasObseredIlluminationPowerAtSample()

Checks whether the ObseredIlluminationPowerAtSample attribute is present.

This field records the observed excitation Illumination Power (also known as Power Output or Illumination Intensity) as recorded at the Sample (also referred to as the Front of the Objective) by using this Calibration Procedure. This metric is typically recorded with the Objective in place.

Returns:

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

setObseredIlluminationPowerAtSampleUnit(value, validate=True)

Sets the value of the ObseredIlluminationPowerAtSampleUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsPower_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObseredIlluminationPowerAtSampleUnit()

Returns the value of the ObseredIlluminationPowerAtSampleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsPower_Type	The value of the attribute

resetObseredIlluminationPowerAtSampleUnit()

Resets the ObseredIlluminationPowerAtSampleUnit attribute to an unset state.

No description available in the XSD standard.

hasObseredIlluminationPowerAtSampleUnit()

Checks whether the optional ObseredIlluminationPowerAtSampleUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setShortTermIlluminationStability(value, validate=True)

Sets the value of the ShortTermIlluminationStability attribute.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getShortTermIlluminationStability()

Returns the value of the ShortTermIlluminationStability attribute.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Returns:

Type	Description
float	The value of the attribute

resetShortTermIlluminationStability()

Resets the ShortTermIlluminationStability attribute to an unset state.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

hasShortTermIlluminationStability()

Checks whether the ShortTermIlluminationStability attribute is present.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Returns:

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

setLongTermIlluminationStability(value, validate=True)

Sets the value of the LongTermIlluminationStability attribute.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getLongTermIlluminationStability()

Returns the value of the LongTermIlluminationStability attribute.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Returns:

Type	Description
float	The value of the attribute

resetLongTermIlluminationStability()

Resets the LongTermIlluminationStability attribute to an unset state.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

hasLongTermIlluminationStability()

Checks whether the LongTermIlluminationStability attribute is present.

According to ISO 21073:2019, Illumination Stability is defined as the percentage deviation of Minimum and Maximum Illumination Power from the Average Power during the time interval considered. Specifically, SATB [%]

Returns:

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

setIlluminationLinearity(value, validate=True)

Sets the value of the IlluminationLinearity attribute.

This field captures the Linear Correlation Coefficient of observed Output Illumination Power response to different input Power settings, as measured at the back of the Objective.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getIlluminationLinearity()

Returns the value of the IlluminationLinearity attribute.

This field captures the Linear Correlation Coefficient of observed Output Illumination Power response to different input Power settings, as measured at the back of the Objective.

Returns:

Type	Description
float	The value of the attribute

resetIlluminationLinearity()

Resets the IlluminationLinearity attribute to an unset state.

This field captures the Linear Correlation Coefficient of observed Output Illumination Power response to different input Power settings, as measured at the back of the Objective.

hasIlluminationLinearity()

Checks whether the IlluminationLinearity attribute is present.

This field captures the Linear Correlation Coefficient of observed Output Illumination Power response to different input Power settings, as measured at the back of the Objective.

Returns:

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

setObservedIrradianceAtSample(value, validate=True)

Sets the value of the ObservedIrradianceAtSample attribute.

Observed mean excitation light irradiance (radiant power per unit area) as measured at the sample plane over the Field of View (FOV).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedIrradianceAtSample()

Returns the value of the ObservedIrradianceAtSample attribute.

Observed mean excitation light irradiance (radiant power per unit area) as measured at the sample plane over the Field of View (FOV).

Returns:

Type	Description
float	The value of the attribute

resetObservedIrradianceAtSample()

Resets the ObservedIrradianceAtSample attribute to an unset state.

Observed mean excitation light irradiance (radiant power per unit area) as measured at the sample plane over the Field of View (FOV).

hasObservedIrradianceAtSample()

Checks whether the ObservedIrradianceAtSample attribute is present.

Observed mean excitation light irradiance (radiant power per unit area) as measured at the sample plane over the Field of View (FOV).

Returns:

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

setObservedIrradianceAtSampleUnit(value, validate=True)

Sets the value of the ObservedIrradianceAtSampleUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsIrradiance_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedIrradianceAtSampleUnit()

Returns the value of the ObservedIrradianceAtSampleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsIrradiance_Type	The value of the attribute

resetObservedIrradianceAtSampleUnit()

Resets the ObservedIrradianceAtSampleUnit attribute to an unset state.

No description available in the XSD standard.

hasObservedIrradianceAtSampleUnit()

Checks whether the optional ObservedIrradianceAtSampleUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setObservedIrradianceVariance(value, validate=True)

Sets the value of the ObservedIrradianceVariance attribute.

Observed excitation light irradiance (radiant power per unit area) variation over the Field of View (FOV).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getObservedIrradianceVariance()

Returns the value of the ObservedIrradianceVariance attribute.

Observed excitation light irradiance (radiant power per unit area) variation over the Field of View (FOV).

Returns:

Type	Description
float	The value of the attribute

resetObservedIrradianceVariance()

Resets the ObservedIrradianceVariance attribute to an unset state.

Observed excitation light irradiance (radiant power per unit area) variation over the Field of View (FOV).

hasObservedIrradianceVariance()

Checks whether the ObservedIrradianceVariance attribute is present.

Observed excitation light irradiance (radiant power per unit area) variation over the Field of View (FOV).

Returns:

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