com.inscoper.nbo.ExcitationCalibration¶

Represents the XML element ExcitationCalibration. More...

Inherits from com.inscoper.nbo.IntensityCalibration_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	ExcitationCalibration()
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	setSpinningDiskInLightPath(boolean value, boolean validate) Sets the value of the SpinningDiskInLightPath attribute.
void	setSpinningDiskInLightPath(boolean value) Sets the value of the SpinningDiskInLightPath attribute.
boolean	getSpinningDiskInLightPath() Returns the value of the SpinningDiskInLightPath attribute.
void	resetSpinningDiskInLightPath() Resets the SpinningDiskInLightPath attribute to an unset state.
boolean	hasSpinningDiskInLightPath() Checks whether the SpinningDiskInLightPath attribute is present.
void	setNominalEx_Wavelength(float value, boolean validate) Sets the value of the NominalEx_Wavelength attribute.
void	setNominalEx_Wavelength(float value) Sets the value of the NominalEx_Wavelength attribute.
float	getNominalEx_Wavelength() Returns the value of the NominalEx_Wavelength attribute.
void	resetNominalEx_Wavelength() Resets the NominalEx_Wavelength attribute to an unset state.
boolean	hasNominalEx_Wavelength() Checks whether the NominalEx_Wavelength attribute is present.
void	setNominalEx_WavelengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the NominalEx_WavelengthUnit attribute.
void	setNominalEx_WavelengthUnit(UnitsLength_Type value) Sets the value of the NominalEx_WavelengthUnit attribute.
UnitsLength_Type	getNominalEx_WavelengthUnit() Returns the value of the NominalEx_WavelengthUnit attribute.
void	resetNominalEx_WavelengthUnit() Resets the NominalEx_WavelengthUnit attribute to an unset state.
boolean	hasNominalEx_WavelengthUnit() Checks whether the optional NominalEx_WavelengthUnit attribute is present.
void	setObservedEx_Wavelength(float value, boolean validate) Sets the value of the ObservedEx_Wavelength attribute.
void	setObservedEx_Wavelength(float value) Sets the value of the ObservedEx_Wavelength attribute.
float	getObservedEx_Wavelength() Returns the value of the ObservedEx_Wavelength attribute.
void	resetObservedEx_Wavelength() Resets the ObservedEx_Wavelength attribute to an unset state.
boolean	hasObservedEx_Wavelength() Checks whether the ObservedEx_Wavelength attribute is present.
void	setObservedEx_WavelengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the ObservedEx_WavelengthUnit attribute.
void	setObservedEx_WavelengthUnit(UnitsLength_Type value) Sets the value of the ObservedEx_WavelengthUnit attribute.
UnitsLength_Type	getObservedEx_WavelengthUnit() Returns the value of the ObservedEx_WavelengthUnit attribute.
void	resetObservedEx_WavelengthUnit() Resets the ObservedEx_WavelengthUnit attribute to an unset state.
boolean	hasObservedEx_WavelengthUnit() Checks whether the optional ObservedEx_WavelengthUnit attribute is present.
void	setPercentageNominalPowerSettings(float value, boolean validate) Sets the value of the PercentageNominalPowerSettings attribute.
void	setPercentageNominalPowerSettings(float value) Sets the value of the PercentageNominalPowerSettings attribute.
float	getPercentageNominalPowerSettings() Returns the value of the PercentageNominalPowerSettings attribute.
void	resetPercentageNominalPowerSettings() Resets the PercentageNominalPowerSettings attribute to an unset state.
boolean	hasPercentageNominalPowerSettings() Checks whether the PercentageNominalPowerSettings attribute is present.
void	setObservedIlluminationPowerAtBackOfObjective(float value, boolean validate) Sets the value of the ObservedIlluminationPowerAtBackOfObjective attribute.
void	setObservedIlluminationPowerAtBackOfObjective(float value) Sets the value of the ObservedIlluminationPowerAtBackOfObjective attribute.
float	getObservedIlluminationPowerAtBackOfObjective() Returns the value of the ObservedIlluminationPowerAtBackOfObjective attribute.
void	resetObservedIlluminationPowerAtBackOfObjective() Resets the ObservedIlluminationPowerAtBackOfObjective attribute to an unset state.
boolean	hasObservedIlluminationPowerAtBackOfObjective() Checks whether the ObservedIlluminationPowerAtBackOfObjective attribute is present.
void	setObservedIlluminationPowerAtBackObjectiveUnit(UnitsPower_Type value, boolean validate) Sets the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.
void	setObservedIlluminationPowerAtBackObjectiveUnit(UnitsPower_Type value) Sets the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.
UnitsPower_Type	getObservedIlluminationPowerAtBackObjectiveUnit() Returns the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.
void	resetObservedIlluminationPowerAtBackObjectiveUnit() Resets the ObservedIlluminationPowerAtBackObjectiveUnit attribute to an unset state.
boolean	hasObservedIlluminationPowerAtBackObjectiveUnit() Checks whether the optional ObservedIlluminationPowerAtBackObjectiveUnit attribute is present.
void	setObseredIlluminationPowerAtSample(float value, boolean validate) Sets the value of the ObseredIlluminationPowerAtSample attribute.
void	setObseredIlluminationPowerAtSample(float value) Sets the value of the ObseredIlluminationPowerAtSample attribute.
float	getObseredIlluminationPowerAtSample() Returns the value of the ObseredIlluminationPowerAtSample attribute.
void	resetObseredIlluminationPowerAtSample() Resets the ObseredIlluminationPowerAtSample attribute to an unset state.
boolean	hasObseredIlluminationPowerAtSample() Checks whether the ObseredIlluminationPowerAtSample attribute is present.
void	setObseredIlluminationPowerAtSampleUnit(UnitsPower_Type value, boolean validate) Sets the value of the ObseredIlluminationPowerAtSampleUnit attribute.
void	setObseredIlluminationPowerAtSampleUnit(UnitsPower_Type value) Sets the value of the ObseredIlluminationPowerAtSampleUnit attribute.
UnitsPower_Type	getObseredIlluminationPowerAtSampleUnit() Returns the value of the ObseredIlluminationPowerAtSampleUnit attribute.
void	resetObseredIlluminationPowerAtSampleUnit() Resets the ObseredIlluminationPowerAtSampleUnit attribute to an unset state.
boolean	hasObseredIlluminationPowerAtSampleUnit() Checks whether the optional ObseredIlluminationPowerAtSampleUnit attribute is present.
void	setShortTermIlluminationStability(float value, boolean validate) Sets the value of the ShortTermIlluminationStability attribute.
void	setShortTermIlluminationStability(float value) Sets the value of the ShortTermIlluminationStability attribute.
float	getShortTermIlluminationStability() Returns the value of the ShortTermIlluminationStability attribute.
void	resetShortTermIlluminationStability() Resets the ShortTermIlluminationStability attribute to an unset state.
boolean	hasShortTermIlluminationStability() Checks whether the ShortTermIlluminationStability attribute is present.
void	setLongTermIlluminationStability(float value, boolean validate) Sets the value of the LongTermIlluminationStability attribute.
void	setLongTermIlluminationStability(float value) Sets the value of the LongTermIlluminationStability attribute.
float	getLongTermIlluminationStability() Returns the value of the LongTermIlluminationStability attribute.
void	resetLongTermIlluminationStability() Resets the LongTermIlluminationStability attribute to an unset state.
boolean	hasLongTermIlluminationStability() Checks whether the LongTermIlluminationStability attribute is present.
void	setIlluminationLinearity(float value, boolean validate) Sets the value of the IlluminationLinearity attribute.
void	setIlluminationLinearity(float value) Sets the value of the IlluminationLinearity attribute.
float	getIlluminationLinearity() Returns the value of the IlluminationLinearity attribute.
void	resetIlluminationLinearity() Resets the IlluminationLinearity attribute to an unset state.
boolean	hasIlluminationLinearity() Checks whether the IlluminationLinearity attribute is present.
void	setObservedIrradianceAtSample(float value, boolean validate) Sets the value of the ObservedIrradianceAtSample attribute.
void	setObservedIrradianceAtSample(float value) Sets the value of the ObservedIrradianceAtSample attribute.
float	getObservedIrradianceAtSample() Returns the value of the ObservedIrradianceAtSample attribute.
void	resetObservedIrradianceAtSample() Resets the ObservedIrradianceAtSample attribute to an unset state.
boolean	hasObservedIrradianceAtSample() Checks whether the ObservedIrradianceAtSample attribute is present.
void	setObservedIrradianceAtSampleUnit(UnitsIrradiance_Type value, boolean validate) Sets the value of the ObservedIrradianceAtSampleUnit attribute.
void	setObservedIrradianceAtSampleUnit(UnitsIrradiance_Type value) Sets the value of the ObservedIrradianceAtSampleUnit attribute.
UnitsIrradiance_Type	getObservedIrradianceAtSampleUnit() Returns the value of the ObservedIrradianceAtSampleUnit attribute.
void	resetObservedIrradianceAtSampleUnit() Resets the ObservedIrradianceAtSampleUnit attribute to an unset state.
boolean	hasObservedIrradianceAtSampleUnit() Checks whether the optional ObservedIrradianceAtSampleUnit attribute is present.
void	setObservedIrradianceVariance(float value, boolean validate) Sets the value of the ObservedIrradianceVariance attribute.
void	setObservedIrradianceVariance(float value) Sets the value of the ObservedIrradianceVariance attribute.
float	getObservedIrradianceVariance() Returns the value of the ObservedIrradianceVariance attribute.
void	resetObservedIrradianceVariance() Resets the ObservedIrradianceVariance attribute to an unset state.
boolean	hasObservedIrradianceVariance() Checks whether the ObservedIrradianceVariance attribute is present.
ExcitationCalibration	__internal_create(long cPtr, boolean own)
ExcitationCalibration	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a ExcitationCalibration.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.IntensityCalibration_Type

	Name
	IntensityCalibration_Type()
void	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setDate(String value, boolean validate) Sets the value of the Date attribute.
void	setDate(String value) Sets the value of the Date attribute.
String	getDate() Returns the value of the Date attribute.
void	resetDate() Resets the Date attribute to an unset state.
boolean	hasDate() Checks whether the Date attribute is present.
void	setSampleSize(PositiveInt_Type value, boolean validate) Sets the value of the SampleSize attribute.
void	setSampleSize(PositiveInt_Type value) Sets the value of the SampleSize attribute.
PositiveInt_Type	getSampleSize() Returns the value of the SampleSize attribute.
void	resetSampleSize() Resets the SampleSize attribute to an unset state.
boolean	hasSampleSize() Checks whether the optional SampleSize attribute is present.
void	setMethod(String value, boolean validate) Sets the value of the Method attribute.
void	setMethod(String value) Sets the value of the Method attribute.
String	getMethod() Returns the value of the Method attribute.
void	resetMethod() Resets the Method attribute to an unset state.
boolean	hasMethod() Checks whether the Method attribute is present.
void	setIntensityCalibrationToolRef_List(IntensityCalibration_Type_InlineIntensityCalibrationToolRefVector value, boolean validate) Sets the list of IntensityCalibrationToolRef elements.
void	setIntensityCalibrationToolRef_List(IntensityCalibration_Type_InlineIntensityCalibrationToolRefVector value) Sets the list of IntensityCalibrationToolRef elements.
IntensityCalibration_Type_InlineIntensityCalibrationToolRefVector	getIntensityCalibrationToolRef_List() Returns the list of IntensityCalibrationToolRef elements.
void	addToIntensityCalibrationToolRef_List(IntensityCalibration_Type_InlineIntensityCalibrationToolRef value, boolean validate) Adds a new IntensityCalibrationToolRef element to this object.
void	addToIntensityCalibrationToolRef_List(IntensityCalibration_Type_InlineIntensityCalibrationToolRef value) Adds a new IntensityCalibrationToolRef element to this object.
void	clearIntensityCalibrationToolRef_List() Clear the list of IntensityCalibrationToolRef.
void	setIntensityCalibrationReport_List(FileAnnotation_TypeVector value, boolean validate) Sets the list of IntensityCalibrationReport elements.
void	setIntensityCalibrationReport_List(FileAnnotation_TypeVector value) Sets the list of IntensityCalibrationReport elements.
FileAnnotation_TypeVector	getIntensityCalibrationReport_List() Returns the list of IntensityCalibrationReport elements.
void	addToIntensityCalibrationReport_List(FileAnnotation_Type value, boolean validate) Adds a new IntensityCalibrationReport element to this object.
void	addToIntensityCalibrationReport_List(FileAnnotation_Type value) Adds a new IntensityCalibrationReport element to this object.
void	clearIntensityCalibrationReport_List() Clear the list of IntensityCalibrationReport.
void	setCalibrationSoftware_List(CalibrationSoftwareVector value, boolean validate) Sets the list of CalibrationSoftware elements.
void	setCalibrationSoftware_List(CalibrationSoftwareVector value) Sets the list of CalibrationSoftware elements.
CalibrationSoftwareVector	getCalibrationSoftware_List() Returns the list of CalibrationSoftware elements.
void	addToCalibrationSoftware_List(CalibrationSoftware value, boolean validate) Adds a new CalibrationSoftware element to this object.
void	addToCalibrationSoftware_List(CalibrationSoftware value) Adds a new CalibrationSoftware element to this object.
void	clearCalibrationSoftware_List() Clear the list of CalibrationSoftware.
void	setAnnotationRef(IntensityCalibration_Type_InlineAnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(IntensityCalibration_Type_InlineAnnotationRef value) Sets the value of the AnnotationRef element.
IntensityCalibration_Type_InlineAnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
StringSet	getDateAllowedValues() Returns the allowed values for this attribut.
StringSet	getMethodAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.IntensityCalibration_Type

	Name
	IntensityCalibration_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.ExcitationCalibration;

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.

Public Functions Documentation¶

function delete¶

function ExcitationCalibration¶

function getTypeName¶

function getXMLName¶

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

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

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

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

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

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.fromXmlFile

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.

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

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

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

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

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.toXmlString

function setSpinningDiskInLightPath¶

public void setSpinningDiskInLightPath(
    boolean value,
    boolean validate
)

Sets the value of the SpinningDiskInLightPath attribute.

Parameters:

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

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.

function setSpinningDiskInLightPath¶

public void setSpinningDiskInLightPath(
    boolean value
)

Sets the value of the SpinningDiskInLightPath attribute.

Parameters:

value The value to set

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.

function getSpinningDiskInLightPath¶

public boolean getSpinningDiskInLightPath()

Returns the value of the SpinningDiskInLightPath attribute.

Return: The value of the 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.

function resetSpinningDiskInLightPath¶

public void 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.

function hasSpinningDiskInLightPath¶

public boolean hasSpinningDiskInLightPath()

Checks whether the SpinningDiskInLightPath attribute is present.

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

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.

function setNominalEx_Wavelength¶

public void setNominalEx_Wavelength(
    float value,
    boolean validate
)

Sets the value of the NominalEx_Wavelength attribute.

Parameters:

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

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.

function setNominalEx_Wavelength¶

public void setNominalEx_Wavelength(
    float value
)

Sets the value of the NominalEx_Wavelength attribute.

Parameters:

value The value to set

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.

function getNominalEx_Wavelength¶

public float getNominalEx_Wavelength()

Returns the value of the NominalEx_Wavelength attribute.

Return: The value of the 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.

function resetNominalEx_Wavelength¶

public void 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.

function hasNominalEx_Wavelength¶

public boolean hasNominalEx_Wavelength()

Checks whether the NominalEx_Wavelength attribute is present.

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

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.

function setNominalEx_WavelengthUnit¶

public void setNominalEx_WavelengthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the NominalEx_WavelengthUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setNominalEx_WavelengthUnit¶

public void setNominalEx_WavelengthUnit(
    UnitsLength_Type value
)

Sets the value of the NominalEx_WavelengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getNominalEx_WavelengthUnit¶

public UnitsLength_Type getNominalEx_WavelengthUnit()

Returns the value of the NominalEx_WavelengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetNominalEx_WavelengthUnit¶

function hasNominalEx_WavelengthUnit¶

public boolean hasNominalEx_WavelengthUnit()

Checks whether the optional NominalEx_WavelengthUnit attribute is present.

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

No description available in the XSD standard.

function setObservedEx_Wavelength¶

public void setObservedEx_Wavelength(
    float value,
    boolean validate
)

Sets the value of the ObservedEx_Wavelength attribute.

Parameters:

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

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

function setObservedEx_Wavelength¶

public void setObservedEx_Wavelength(
    float value
)

Sets the value of the ObservedEx_Wavelength attribute.

Parameters:

value The value to set

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

function getObservedEx_Wavelength¶

public float getObservedEx_Wavelength()

Returns the value of the ObservedEx_Wavelength attribute.

Return: The value of the attribute

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

function resetObservedEx_Wavelength¶

public void 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.

function hasObservedEx_Wavelength¶

public boolean hasObservedEx_Wavelength()

Checks whether the ObservedEx_Wavelength attribute is present.

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

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

function setObservedEx_WavelengthUnit¶

public void setObservedEx_WavelengthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the ObservedEx_WavelengthUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setObservedEx_WavelengthUnit¶

public void setObservedEx_WavelengthUnit(
    UnitsLength_Type value
)

Sets the value of the ObservedEx_WavelengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getObservedEx_WavelengthUnit¶

public UnitsLength_Type getObservedEx_WavelengthUnit()

Returns the value of the ObservedEx_WavelengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetObservedEx_WavelengthUnit¶

function hasObservedEx_WavelengthUnit¶

public boolean hasObservedEx_WavelengthUnit()

Checks whether the optional ObservedEx_WavelengthUnit attribute is present.

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

No description available in the XSD standard.

function setPercentageNominalPowerSettings¶

public void setPercentageNominalPowerSettings(
    float value,
    boolean validate
)

Sets the value of the PercentageNominalPowerSettings attribute.

Parameters:

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

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

function setPercentageNominalPowerSettings¶

public void setPercentageNominalPowerSettings(
    float value
)

Sets the value of the PercentageNominalPowerSettings attribute.

Parameters:

value The value to set

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

function getPercentageNominalPowerSettings¶

public float getPercentageNominalPowerSettings()

Returns the value of the PercentageNominalPowerSettings attribute.

Return: The value of the attribute

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

function resetPercentageNominalPowerSettings¶

public void 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.

function hasPercentageNominalPowerSettings¶

public boolean hasPercentageNominalPowerSettings()

Checks whether the PercentageNominalPowerSettings attribute is present.

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

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

function setObservedIlluminationPowerAtBackOfObjective¶

public void setObservedIlluminationPowerAtBackOfObjective(
    float value,
    boolean validate
)

Sets the value of the ObservedIlluminationPowerAtBackOfObjective attribute.

Parameters:

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

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.

function setObservedIlluminationPowerAtBackOfObjective¶

public void setObservedIlluminationPowerAtBackOfObjective(
    float value
)

Sets the value of the ObservedIlluminationPowerAtBackOfObjective attribute.

Parameters:

value The value to set

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.

function getObservedIlluminationPowerAtBackOfObjective¶

public float getObservedIlluminationPowerAtBackOfObjective()

Returns the value of the ObservedIlluminationPowerAtBackOfObjective attribute.

Return: The value of the 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.

function resetObservedIlluminationPowerAtBackOfObjective¶

public void 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.

function hasObservedIlluminationPowerAtBackOfObjective¶

public boolean hasObservedIlluminationPowerAtBackOfObjective()

Checks whether the ObservedIlluminationPowerAtBackOfObjective attribute is present.

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

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.

function setObservedIlluminationPowerAtBackObjectiveUnit¶

public void setObservedIlluminationPowerAtBackObjectiveUnit(
    UnitsPower_Type value,
    boolean validate
)

Sets the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setObservedIlluminationPowerAtBackObjectiveUnit¶

public void setObservedIlluminationPowerAtBackObjectiveUnit(
    UnitsPower_Type value
)

Sets the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getObservedIlluminationPowerAtBackObjectiveUnit¶

public UnitsPower_Type getObservedIlluminationPowerAtBackObjectiveUnit()

Returns the value of the ObservedIlluminationPowerAtBackObjectiveUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetObservedIlluminationPowerAtBackObjectiveUnit¶

function hasObservedIlluminationPowerAtBackObjectiveUnit¶

public boolean hasObservedIlluminationPowerAtBackObjectiveUnit()

Checks whether the optional ObservedIlluminationPowerAtBackObjectiveUnit attribute is present.

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

No description available in the XSD standard.

function setObseredIlluminationPowerAtSample¶

public void setObseredIlluminationPowerAtSample(
    float value,
    boolean validate
)

Sets the value of the ObseredIlluminationPowerAtSample attribute.

Parameters:

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

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.

function setObseredIlluminationPowerAtSample¶

public void setObseredIlluminationPowerAtSample(
    float value
)

Sets the value of the ObseredIlluminationPowerAtSample attribute.

Parameters:

value The value to set

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.

function getObseredIlluminationPowerAtSample¶

public float getObseredIlluminationPowerAtSample()

Returns the value of the ObseredIlluminationPowerAtSample attribute.

Return: The value of the 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.

function resetObseredIlluminationPowerAtSample¶

public void 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.

function hasObseredIlluminationPowerAtSample¶

public boolean hasObseredIlluminationPowerAtSample()

Checks whether the ObseredIlluminationPowerAtSample attribute is present.

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

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.

function setObseredIlluminationPowerAtSampleUnit¶

public void setObseredIlluminationPowerAtSampleUnit(
    UnitsPower_Type value,
    boolean validate
)

Sets the value of the ObseredIlluminationPowerAtSampleUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setObseredIlluminationPowerAtSampleUnit¶

public void setObseredIlluminationPowerAtSampleUnit(
    UnitsPower_Type value
)

Sets the value of the ObseredIlluminationPowerAtSampleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getObseredIlluminationPowerAtSampleUnit¶

public UnitsPower_Type getObseredIlluminationPowerAtSampleUnit()

Returns the value of the ObseredIlluminationPowerAtSampleUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetObseredIlluminationPowerAtSampleUnit¶

function hasObseredIlluminationPowerAtSampleUnit¶

public boolean hasObseredIlluminationPowerAtSampleUnit()

Checks whether the optional ObseredIlluminationPowerAtSampleUnit attribute is present.

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

No description available in the XSD standard.

function setShortTermIlluminationStability¶

public void setShortTermIlluminationStability(
    float value,
    boolean validate
)

Sets the value of the ShortTermIlluminationStability attribute.

Parameters:

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

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Short Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every second for a time interval of 5 min of continuous illumination.

function setShortTermIlluminationStability¶

public void setShortTermIlluminationStability(
    float value
)

Sets the value of the ShortTermIlluminationStability attribute.

Parameters:

value The value to set

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Short Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every second for a time interval of 5 min of continuous illumination.

function getShortTermIlluminationStability¶

public float getShortTermIlluminationStability()

Returns the value of the ShortTermIlluminationStability attribute.

Return: The value of the 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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Short Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every second for a time interval of 5 min of continuous illumination.

function resetShortTermIlluminationStability¶

public void 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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Short Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every second for a time interval of 5 min of continuous illumination.

function hasShortTermIlluminationStability¶

public boolean hasShortTermIlluminationStability()

Checks whether the ShortTermIlluminationStability attribute is present.

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

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Short Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every second for a time interval of 5 min of continuous illumination.

function setLongTermIlluminationStability¶

public void setLongTermIlluminationStability(
    float value,
    boolean validate
)

Sets the value of the LongTermIlluminationStability attribute.

Parameters:

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

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Long Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every 30 s for one second for a time interval of 120 min of continuous illumination.

function setLongTermIlluminationStability¶

public void setLongTermIlluminationStability(
    float value
)

Sets the value of the LongTermIlluminationStability attribute.

Parameters:

value The value to set

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Long Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every 30 s for one second for a time interval of 120 min of continuous illumination.

function getLongTermIlluminationStability¶

public float getLongTermIlluminationStability()

Returns the value of the LongTermIlluminationStability attribute.

Return: The value of the 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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Long Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every 30 s for one second for a time interval of 120 min of continuous illumination.

function resetLongTermIlluminationStability¶

public void 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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Long Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every 30 s for one second for a time interval of 120 min of continuous illumination.

function hasLongTermIlluminationStability¶

public boolean hasLongTermIlluminationStability()

Checks whether the LongTermIlluminationStability attribute is present.

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

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 [%] = 100x {1-[(Pmax-Pmin)/Pmax+Pmin]}, where Pmax is the maximum laser power recorded during the time interval; and Pmin is the minimum laser power recorded during the time interval. This field records the Long Term Illumination Stability recorded during this Calibration Procedure by measuring Illumination Power every 30 s for one second for a time interval of 120 min of continuous illumination.

function setIlluminationLinearity¶

public void setIlluminationLinearity(
    float value,
    boolean validate
)

Sets the value of the IlluminationLinearity attribute.

Parameters:

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

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.

function setIlluminationLinearity¶

public void setIlluminationLinearity(
    float value
)

Sets the value of the IlluminationLinearity attribute.

Parameters:

value The value to set

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.

function getIlluminationLinearity¶

public float getIlluminationLinearity()

Returns the value of the IlluminationLinearity attribute.

Return: The value of the 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.

function resetIlluminationLinearity¶

public void 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.

function hasIlluminationLinearity¶

public boolean hasIlluminationLinearity()

Checks whether the IlluminationLinearity attribute is present.

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

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.

function setObservedIrradianceAtSample¶

public void setObservedIrradianceAtSample(
    float value,
    boolean validate
)

Sets the value of the ObservedIrradianceAtSample attribute.

Parameters:

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

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

function setObservedIrradianceAtSample¶

public void setObservedIrradianceAtSample(
    float value
)

Sets the value of the ObservedIrradianceAtSample attribute.

Parameters:

value The value to set

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

function getObservedIrradianceAtSample¶

public float getObservedIrradianceAtSample()

Returns the value of the ObservedIrradianceAtSample attribute.

Return: The value of the attribute

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

function resetObservedIrradianceAtSample¶

public void 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).

function hasObservedIrradianceAtSample¶

public boolean hasObservedIrradianceAtSample()

Checks whether the ObservedIrradianceAtSample attribute is present.

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

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

function setObservedIrradianceAtSampleUnit¶

public void setObservedIrradianceAtSampleUnit(
    UnitsIrradiance_Type value,
    boolean validate
)

Sets the value of the ObservedIrradianceAtSampleUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setObservedIrradianceAtSampleUnit¶

public void setObservedIrradianceAtSampleUnit(
    UnitsIrradiance_Type value
)

Sets the value of the ObservedIrradianceAtSampleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getObservedIrradianceAtSampleUnit¶

public UnitsIrradiance_Type getObservedIrradianceAtSampleUnit()

Returns the value of the ObservedIrradianceAtSampleUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetObservedIrradianceAtSampleUnit¶

function hasObservedIrradianceAtSampleUnit¶

public boolean hasObservedIrradianceAtSampleUnit()

Checks whether the optional ObservedIrradianceAtSampleUnit attribute is present.

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

No description available in the XSD standard.

function setObservedIrradianceVariance¶

public void setObservedIrradianceVariance(
    float value,
    boolean validate
)

Sets the value of the ObservedIrradianceVariance attribute.

Parameters:

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

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

function setObservedIrradianceVariance¶

public void setObservedIrradianceVariance(
    float value
)

Sets the value of the ObservedIrradianceVariance attribute.

Parameters:

value The value to set

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

function getObservedIrradianceVariance¶

public float getObservedIrradianceVariance()

Returns the value of the ObservedIrradianceVariance attribute.

Return: The value of the attribute

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

function resetObservedIrradianceVariance¶

public void 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).

function hasObservedIrradianceVariance¶

public boolean hasObservedIrradianceVariance()

Checks whether the ObservedIrradianceVariance attribute is present.

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

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

function __internal_create¶

function fromBase¶

public static ExcitationCalibration fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a ExcitationCalibration.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.IntensityCalibration_Type.fromBase