MechanicalCalibration

Bases: NBOBaseClass

Represents the XML element MechanicalCalibration.

This describes the procedures that were used for mechanical calibration and the resulting calibration results.

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
MechanicalCalibration	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

setID(value, validate=True)

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
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

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

setDate(value, validate=True)

Sets the value of the Date attribute.

Ths field records the Date in which this Calibration procedure was performed.

Parameters:

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

getDate()

Returns the value of the Date attribute.

Ths field records the Date in which this Calibration procedure was performed.

Returns:

Type	Description
string	The value of the attribute

resetDate()

Resets the Date attribute to an unset state.

Ths field records the Date in which this Calibration procedure was performed.

hasDate()

Checks whether the Date attribute is present.

Ths field records the Date in which this Calibration procedure was performed.

Returns:

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

getDateAllowedValues() staticmethod

Returns the allowed values for this attribut.

Ths field records the Date in which this Calibration procedure was performed.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setMeasuredXReproducibility(value, validate=True)

Sets the value of the MeasuredXReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as X Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

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

getMeasuredXReproducibility()

Returns the value of the MeasuredXReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as X Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXReproducibility()

Resets the MeasuredXReproducibility attribute to an unset state.

This field captures the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as X Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

hasMeasuredXReproducibility()

Checks whether the MeasuredXReproducibility attribute is present.

This field captures the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as X Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

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

setMeasuredXReproducibilityUnit(value, validate=True)

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

getMeasuredXReproducibilityUnit()

Returns the value of the MeasuredXReproducibilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredXReproducibilityUnit()

Resets the MeasuredXReproducibilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredXReproducibilityUnit()

Checks whether the optional MeasuredXReproducibilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredYReproducibility(value, validate=True)

Sets the value of the MeasuredYReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Y Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

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

getMeasuredYReproducibility()

Returns the value of the MeasuredYReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Y Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYReproducibility()

Resets the MeasuredYReproducibility attribute to an unset state.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Y Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

hasMeasuredYReproducibility()

Checks whether the MeasuredYReproducibility attribute is present.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Y Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

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

setMeasuredYReproducibilityUnit(value, validate=True)

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

getMeasuredYReproducibilityUnit()

Returns the value of the MeasuredYReproducibilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredYReproducibilityUnit()

Resets the MeasuredYReproducibilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredYReproducibilityUnit()

Checks whether the optional MeasuredYReproducibilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredFocalReproducibility(value, validate=True)

Sets the value of the MeasuredFocalReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Focal Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

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

getMeasuredFocalReproducibility()

Returns the value of the MeasuredFocalReproducibility attribute.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Focal Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalReproducibility()

Resets the MeasuredFocalReproducibility attribute to an unset state.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Focal Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

hasMeasuredFocalReproducibility()

Checks whether the MeasuredFocalReproducibility attribute is present.

This field captures the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure. This metric is generally referred to as Reproducibility and it might also be referred to as Focal Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

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

setMeasuredFocalReproducibilityUnit(value, validate=True)

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

getMeasuredFocalReproducibilityUnit()

Returns the value of the MeasuredFocalReproducibilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredFocalReproducibilityUnit()

Resets the MeasuredFocalReproducibilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredFocalReproducibilityUnit()

Checks whether the optional MeasuredFocalReproducibilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredXRepeatability(value, validate=True)

Sets the value of the MeasuredXRepeatability attribute.

This field captures the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

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

getMeasuredXRepeatability()

Returns the value of the MeasuredXRepeatability attribute.

This field captures the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXRepeatability()

Resets the MeasuredXRepeatability attribute to an unset state.

This field captures the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

hasMeasuredXRepeatability()

Checks whether the MeasuredXRepeatability attribute is present.

This field captures the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

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

setMeasuredXRepeatabilityUnit(value, validate=True)

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

getMeasuredXRepeatabilityUnit()

Returns the value of the MeasuredXRepeatabilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredXRepeatabilityUnit()

Resets the MeasuredXRepeatabilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredXRepeatabilityUnit()

Checks whether the optional MeasuredXRepeatabilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredYRepeatability(value, validate=True)

Sets the value of the MeasuredYRepeatability attribute.

This field captures the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

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

getMeasuredYRepeatability()

Returns the value of the MeasuredYRepeatability attribute.

This field captures the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYRepeatability()

Resets the MeasuredYRepeatability attribute to an unset state.

This field captures the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

hasMeasuredYRepeatability()

Checks whether the MeasuredYRepeatability attribute is present.

This field captures the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

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

setMeasuredYRepeatabilityUnit(value, validate=True)

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

getMeasuredYRepeatabilityUnit()

Returns the value of the MeasuredYRepeatabilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredYRepeatabilityUnit()

Resets the MeasuredYRepeatabilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredYRepeatabilityUnit()

Checks whether the optional MeasuredYRepeatabilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredFocalRepeatability(value, validate=True)

Sets the value of the MeasuredFocalRepeatability attribute.

This field captures the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

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

getMeasuredFocalRepeatability()

Returns the value of the MeasuredFocalRepeatability attribute.

This field captures the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalRepeatability()

Resets the MeasuredFocalRepeatability attribute to an unset state.

This field captures the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

hasMeasuredFocalRepeatability()

Checks whether the MeasuredFocalRepeatability attribute is present.

This field captures the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position during Image Acquisition and as measured by this Mechanical Calibration Procedure. This metric is important for example for Tiling.

Returns:

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

setMeasuredFocalRepeatabilityUnit(value, validate=True)

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

getMeasuredFocalRepeatabilityUnit()

Returns the value of the MeasuredFocalRepeatabilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMeasuredFocalRepeatabilityUnit()

Resets the MeasuredFocalRepeatabilityUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredFocalRepeatabilityUnit()

Checks whether the optional MeasuredFocalRepeatabilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredXSettlingTime(value, validate=True)

Sets the value of the MeasuredXSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredXSettlingTime()

Returns the value of the MeasuredXSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXSettlingTime()

Resets the MeasuredXSettlingTime attribute to an unset state.

This field captures the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredXSettlingTime()

Checks whether the MeasuredXSettlingTime attribute is present.

This field captures the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredXSettlingTimeUnit(value, validate=True)

Sets the value of the MeasuredXSettlingTimeUnit attribute.

No description available in the XSD standard.

Parameters:

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

getMeasuredXSettlingTimeUnit()

Returns the value of the MeasuredXSettlingTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetMeasuredXSettlingTimeUnit()

Resets the MeasuredXSettlingTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredXSettlingTimeUnit()

Checks whether the optional MeasuredXSettlingTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredYSettlingTime(value, validate=True)

Sets the value of the MeasuredYSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredYSettlingTime()

Returns the value of the MeasuredYSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYSettlingTime()

Resets the MeasuredYSettlingTime attribute to an unset state.

This field captures the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredYSettlingTime()

Checks whether the MeasuredYSettlingTime attribute is present.

This field captures the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredYSettlingTimeUnit(value, validate=True)

Sets the value of the MeasuredYSettlingTimeUnit attribute.

No description available in the XSD standard.

Parameters:

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

getMeasuredYSettlingTimeUnit()

Returns the value of the MeasuredYSettlingTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetMeasuredYSettlingTimeUnit()

Resets the MeasuredYSettlingTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredYSettlingTimeUnit()

Checks whether the optional MeasuredYSettlingTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredFocalSettlingTime(value, validate=True)

Sets the value of the MeasuredFocalSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredFocalSettlingTime()

Returns the value of the MeasuredFocalSettlingTime attribute.

This field captures the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalSettlingTime()

Resets the MeasuredFocalSettlingTime attribute to an unset state.

This field captures the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredFocalSettlingTime()

Checks whether the MeasuredFocalSettlingTime attribute is present.

This field captures the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredFocalSettlingTimeUnit(value, validate=True)

Sets the value of the MeasuredFocalSettlingTimeUnit attribute.

No description available in the XSD standard.

Parameters:

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

getMeasuredFocalSettlingTimeUnit()

Returns the value of the MeasuredFocalSettlingTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetMeasuredFocalSettlingTimeUnit()

Resets the MeasuredFocalSettlingTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasMeasuredFocalSettlingTimeUnit()

Checks whether the optional MeasuredFocalSettlingTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMeasuredXReproducibility_SD(value, validate=True)

Sets the value of the MeasuredXReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical 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

getMeasuredXReproducibility_SD()

Returns the value of the MeasuredXReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXReproducibility_SD()

Resets the MeasuredXReproducibility_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

hasMeasuredXReproducibility_SD()

Checks whether the MeasuredXReproducibility_SD attribute is present.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given X-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

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

setMeasuredYReproducibility_SD(value, validate=True)

Sets the value of the MeasuredYReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical 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

getMeasuredYReproducibility_SD()

Returns the value of the MeasuredYReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYReproducibility_SD()

Resets the MeasuredYReproducibility_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

hasMeasuredYReproducibility_SD()

Checks whether the MeasuredYReproducibility_SD attribute is present.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Y-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

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

setMeasuredFocalReproducibility_SD(value, validate=True)

Sets the value of the MeasuredFocalReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical 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

getMeasuredFocalReproducibility_SD()

Returns the value of the MeasuredFocalReproducibility_SD attribute.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalReproducibility_SD()

Resets the MeasuredFocalReproducibility_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

hasMeasuredFocalReproducibility_SD()

Checks whether the MeasuredFocalReproducibility_SD attribute is present.

This field captures the Standard Deviation associated with the observed Precision with which this Instrument is capable of maintaining a given Z-axis position over time during Image Acquisition and as measured by this Mechanical Calibration procedure.

Returns:

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

setMeasuredXRepeatability_SD(value, validate=True)

Sets the value of the MeasuredXRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical 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

getMeasuredXRepeatability_SD()

Returns the value of the MeasuredXRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXRepeatability_SD()

Resets the MeasuredXRepeatability_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredXRepeatability_SD()

Checks whether the MeasuredXRepeatability_SD attribute is present.

This field captures the Standard Deviation associated with the observed X-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredYRepeatability_SD(value, validate=True)

Sets the value of the MeasuredYRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical 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

getMeasuredYRepeatability_SD()

Returns the value of the MeasuredYRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYRepeatability_SD()

Resets the MeasuredYRepeatability_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredYRepeatability_SD()

Checks whether the MeasuredYRepeatability_SD attribute is present.

This field captures the Standard Deviation associated with the observed Y-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredFocalRepeatability_SD(value, validate=True)

Sets the value of the MeasuredFocalRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical 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

getMeasuredFocalRepeatability_SD()

Returns the value of the MeasuredFocalRepeatability_SD attribute.

This field captures the Standard Deviation associated with the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalRepeatability_SD()

Resets the MeasuredFocalRepeatability_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredFocalRepeatability_SD()

Checks whether the MeasuredFocalRepeatability_SD attribute is present.

This field captures the Standard Deviation associated with the observed Z-axis Accuracy with which this Instrument is capable of returning to a previously visited position (useful for tiling) during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredXSettlingTime_SD(value, validate=True)

Sets the value of the MeasuredXSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredXSettlingTime_SD()

Returns the value of the MeasuredXSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredXSettlingTime_SD()

Resets the MeasuredXSettlingTime_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredXSettlingTime_SD()

Checks whether the MeasuredXSettlingTime_SD attribute is present.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target X-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredYSettlingTime_SD(value, validate=True)

Sets the value of the MeasuredYSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredYSettlingTime_SD()

Returns the value of the MeasuredYSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredYSettlingTime_SD()

Resets the MeasuredYSettlingTime_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredYSettlingTime_SD()

Checks whether the MeasuredYSettlingTime_SD attribute is present.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Y-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setMeasuredFocalSettlingTime_SD(value, validate=True)

Sets the value of the MeasuredFocalSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical 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

getMeasuredFocalSettlingTime_SD()

Returns the value of the MeasuredFocalSettlingTime_SD attribute.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeasuredFocalSettlingTime_SD()

Resets the MeasuredFocalSettlingTime_SD attribute to an unset state.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

hasMeasuredFocalSettlingTime_SD()

Checks whether the MeasuredFocalSettlingTime_SD attribute is present.

This field captures the Standard Deviation associated with the observed Time it takes for this Instrument to stabilize at the target Z-axis position during Image Acquisition and as measured by this Mechanical Calibration Procedure.

Returns:

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

setSamplePositioningRef(value, validate=True)

Sets the value of the SamplePositioningRef element.

This empty element refers to the Sample Positioning device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Parameters:

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

getSamplePositioningRef()

Returns the value of the SamplePositioningRef element.

This empty element refers to the Sample Positioning device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Returns:

Type	Description
SamplePositioningRef	The value of the element

resetSamplePositioningRef()

Resets the SamplePositioningRef element to an unset state.

This empty element refers to the Sample Positioning device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

hasSamplePositioningRef()

Checks whether the optional SamplePositioningRef element is present.

This empty element refers to the Sample Positioning device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Returns:

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

setFocusStabilizationDeviceRef(value, validate=True)

Sets the value of the FocusStabilizationDeviceRef element.

This empty element refers to the optional Focus Stabilization Device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Parameters:

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

getFocusStabilizationDeviceRef()

Returns the value of the FocusStabilizationDeviceRef element.

This empty element refers to the optional Focus Stabilization Device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Returns:

Type	Description
FocusStabilizationDeviceRef	The value of the element

resetFocusStabilizationDeviceRef()

Resets the FocusStabilizationDeviceRef element to an unset state.

This empty element refers to the optional Focus Stabilization Device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

hasFocusStabilizationDeviceRef()

Checks whether the optional FocusStabilizationDeviceRef element is present.

This empty element refers to the optional Focus Stabilization Device that was used for the Acquisition of the experimental Image this Mechanical Calibration procedure refers to.

Returns:

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

setAnnotationRef(value, validate=True)

Sets the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Parameters:

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

getAnnotationRef()

Returns the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Returns:

Type	Description
MechanicalCalibration_InlineAnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

This is a simple multi-line comment or annotation describing this component.

Returns:

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