Inscoper::NBO::MechanicalCalibration¶

Represents the XML element MechanicalCalibration. More...

#include <MechanicalCalibration.h>

Inherits from NBOBaseClass

Public Classes¶

	Name
class	InlineAnnotationRef Represents the XML element AnnotationRef.

Public Types¶

	Name
typedef std::shared_ptr< InlineAnnotationRef >	InlineAnnotationRefPtr

Public Functions¶

	Name
	MechanicalCalibration()
	~MechanicalCalibration()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setDate(const std::string & value, bool validate =true) Sets the value of the Date attribute.
std::string	getDate() const Returns the value of the Date attribute.
void	resetDate() Resets the Date attribute to an unset state.
bool	hasDate() const Checks whether the Date attribute is present.
void	setMeasuredXReproducibility(const float & value, bool validate =true) Sets the value of the MeasuredXReproducibility attribute.
float	getMeasuredXReproducibility() const Returns the value of the MeasuredXReproducibility attribute.
void	resetMeasuredXReproducibility() Resets the MeasuredXReproducibility attribute to an unset state.
bool	hasMeasuredXReproducibility() const Checks whether the MeasuredXReproducibility attribute is present.
void	setMeasuredXReproducibilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredXReproducibilityUnit attribute.
UnitsLength_TypePtr	getMeasuredXReproducibilityUnit() const Returns the value of the MeasuredXReproducibilityUnit attribute.
void	resetMeasuredXReproducibilityUnit() Resets the MeasuredXReproducibilityUnit attribute to an unset state.
bool	hasMeasuredXReproducibilityUnit() const Checks whether the optional MeasuredXReproducibilityUnit attribute is present.
void	setMeasuredYReproducibility(const float & value, bool validate =true) Sets the value of the MeasuredYReproducibility attribute.
float	getMeasuredYReproducibility() const Returns the value of the MeasuredYReproducibility attribute.
void	resetMeasuredYReproducibility() Resets the MeasuredYReproducibility attribute to an unset state.
bool	hasMeasuredYReproducibility() const Checks whether the MeasuredYReproducibility attribute is present.
void	setMeasuredYReproducibilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredYReproducibilityUnit attribute.
UnitsLength_TypePtr	getMeasuredYReproducibilityUnit() const Returns the value of the MeasuredYReproducibilityUnit attribute.
void	resetMeasuredYReproducibilityUnit() Resets the MeasuredYReproducibilityUnit attribute to an unset state.
bool	hasMeasuredYReproducibilityUnit() const Checks whether the optional MeasuredYReproducibilityUnit attribute is present.
void	setMeasuredFocalReproducibility(const float & value, bool validate =true) Sets the value of the MeasuredFocalReproducibility attribute.
float	getMeasuredFocalReproducibility() const Returns the value of the MeasuredFocalReproducibility attribute.
void	resetMeasuredFocalReproducibility() Resets the MeasuredFocalReproducibility attribute to an unset state.
bool	hasMeasuredFocalReproducibility() const Checks whether the MeasuredFocalReproducibility attribute is present.
void	setMeasuredFocalReproducibilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredFocalReproducibilityUnit attribute.
UnitsLength_TypePtr	getMeasuredFocalReproducibilityUnit() const Returns the value of the MeasuredFocalReproducibilityUnit attribute.
void	resetMeasuredFocalReproducibilityUnit() Resets the MeasuredFocalReproducibilityUnit attribute to an unset state.
bool	hasMeasuredFocalReproducibilityUnit() const Checks whether the optional MeasuredFocalReproducibilityUnit attribute is present.
void	setMeasuredXRepeatability(const float & value, bool validate =true) Sets the value of the MeasuredXRepeatability attribute.
float	getMeasuredXRepeatability() const Returns the value of the MeasuredXRepeatability attribute.
void	resetMeasuredXRepeatability() Resets the MeasuredXRepeatability attribute to an unset state.
bool	hasMeasuredXRepeatability() const Checks whether the MeasuredXRepeatability attribute is present.
void	setMeasuredXRepeatabilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredXRepeatabilityUnit attribute.
UnitsLength_TypePtr	getMeasuredXRepeatabilityUnit() const Returns the value of the MeasuredXRepeatabilityUnit attribute.
void	resetMeasuredXRepeatabilityUnit() Resets the MeasuredXRepeatabilityUnit attribute to an unset state.
bool	hasMeasuredXRepeatabilityUnit() const Checks whether the optional MeasuredXRepeatabilityUnit attribute is present.
void	setMeasuredYRepeatability(const float & value, bool validate =true) Sets the value of the MeasuredYRepeatability attribute.
float	getMeasuredYRepeatability() const Returns the value of the MeasuredYRepeatability attribute.
void	resetMeasuredYRepeatability() Resets the MeasuredYRepeatability attribute to an unset state.
bool	hasMeasuredYRepeatability() const Checks whether the MeasuredYRepeatability attribute is present.
void	setMeasuredYRepeatabilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredYRepeatabilityUnit attribute.
UnitsLength_TypePtr	getMeasuredYRepeatabilityUnit() const Returns the value of the MeasuredYRepeatabilityUnit attribute.
void	resetMeasuredYRepeatabilityUnit() Resets the MeasuredYRepeatabilityUnit attribute to an unset state.
bool	hasMeasuredYRepeatabilityUnit() const Checks whether the optional MeasuredYRepeatabilityUnit attribute is present.
void	setMeasuredFocalRepeatability(const float & value, bool validate =true) Sets the value of the MeasuredFocalRepeatability attribute.
float	getMeasuredFocalRepeatability() const Returns the value of the MeasuredFocalRepeatability attribute.
void	resetMeasuredFocalRepeatability() Resets the MeasuredFocalRepeatability attribute to an unset state.
bool	hasMeasuredFocalRepeatability() const Checks whether the MeasuredFocalRepeatability attribute is present.
void	setMeasuredFocalRepeatabilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the MeasuredFocalRepeatabilityUnit attribute.
UnitsLength_TypePtr	getMeasuredFocalRepeatabilityUnit() const Returns the value of the MeasuredFocalRepeatabilityUnit attribute.
void	resetMeasuredFocalRepeatabilityUnit() Resets the MeasuredFocalRepeatabilityUnit attribute to an unset state.
bool	hasMeasuredFocalRepeatabilityUnit() const Checks whether the optional MeasuredFocalRepeatabilityUnit attribute is present.
void	setMeasuredXSettlingTime(const float & value, bool validate =true) Sets the value of the MeasuredXSettlingTime attribute.
float	getMeasuredXSettlingTime() const Returns the value of the MeasuredXSettlingTime attribute.
void	resetMeasuredXSettlingTime() Resets the MeasuredXSettlingTime attribute to an unset state.
bool	hasMeasuredXSettlingTime() const Checks whether the MeasuredXSettlingTime attribute is present.
void	setMeasuredXSettlingTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the MeasuredXSettlingTimeUnit attribute.
UnitsTime_TypePtr	getMeasuredXSettlingTimeUnit() const Returns the value of the MeasuredXSettlingTimeUnit attribute.
void	resetMeasuredXSettlingTimeUnit() Resets the MeasuredXSettlingTimeUnit attribute to an unset state.
bool	hasMeasuredXSettlingTimeUnit() const Checks whether the optional MeasuredXSettlingTimeUnit attribute is present.
void	setMeasuredYSettlingTime(const float & value, bool validate =true) Sets the value of the MeasuredYSettlingTime attribute.
float	getMeasuredYSettlingTime() const Returns the value of the MeasuredYSettlingTime attribute.
void	resetMeasuredYSettlingTime() Resets the MeasuredYSettlingTime attribute to an unset state.
bool	hasMeasuredYSettlingTime() const Checks whether the MeasuredYSettlingTime attribute is present.
void	setMeasuredYSettlingTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the MeasuredYSettlingTimeUnit attribute.
UnitsTime_TypePtr	getMeasuredYSettlingTimeUnit() const Returns the value of the MeasuredYSettlingTimeUnit attribute.
void	resetMeasuredYSettlingTimeUnit() Resets the MeasuredYSettlingTimeUnit attribute to an unset state.
bool	hasMeasuredYSettlingTimeUnit() const Checks whether the optional MeasuredYSettlingTimeUnit attribute is present.
void	setMeasuredFocalSettlingTime(const float & value, bool validate =true) Sets the value of the MeasuredFocalSettlingTime attribute.
float	getMeasuredFocalSettlingTime() const Returns the value of the MeasuredFocalSettlingTime attribute.
void	resetMeasuredFocalSettlingTime() Resets the MeasuredFocalSettlingTime attribute to an unset state.
bool	hasMeasuredFocalSettlingTime() const Checks whether the MeasuredFocalSettlingTime attribute is present.
void	setMeasuredFocalSettlingTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the MeasuredFocalSettlingTimeUnit attribute.
UnitsTime_TypePtr	getMeasuredFocalSettlingTimeUnit() const Returns the value of the MeasuredFocalSettlingTimeUnit attribute.
void	resetMeasuredFocalSettlingTimeUnit() Resets the MeasuredFocalSettlingTimeUnit attribute to an unset state.
bool	hasMeasuredFocalSettlingTimeUnit() const Checks whether the optional MeasuredFocalSettlingTimeUnit attribute is present.
void	setMeasuredXReproducibility_SD(const float & value, bool validate =true) Sets the value of the MeasuredXReproducibility_SD attribute.
float	getMeasuredXReproducibility_SD() const Returns the value of the MeasuredXReproducibility_SD attribute.
void	resetMeasuredXReproducibility_SD() Resets the MeasuredXReproducibility_SD attribute to an unset state.
bool	hasMeasuredXReproducibility_SD() const Checks whether the MeasuredXReproducibility_SD attribute is present.
void	setMeasuredYReproducibility_SD(const float & value, bool validate =true) Sets the value of the MeasuredYReproducibility_SD attribute.
float	getMeasuredYReproducibility_SD() const Returns the value of the MeasuredYReproducibility_SD attribute.
void	resetMeasuredYReproducibility_SD() Resets the MeasuredYReproducibility_SD attribute to an unset state.
bool	hasMeasuredYReproducibility_SD() const Checks whether the MeasuredYReproducibility_SD attribute is present.
void	setMeasuredFocalReproducibility_SD(const float & value, bool validate =true) Sets the value of the MeasuredFocalReproducibility_SD attribute.
float	getMeasuredFocalReproducibility_SD() const Returns the value of the MeasuredFocalReproducibility_SD attribute.
void	resetMeasuredFocalReproducibility_SD() Resets the MeasuredFocalReproducibility_SD attribute to an unset state.
bool	hasMeasuredFocalReproducibility_SD() const Checks whether the MeasuredFocalReproducibility_SD attribute is present.
void	setMeasuredXRepeatability_SD(const float & value, bool validate =true) Sets the value of the MeasuredXRepeatability_SD attribute.
float	getMeasuredXRepeatability_SD() const Returns the value of the MeasuredXRepeatability_SD attribute.
void	resetMeasuredXRepeatability_SD() Resets the MeasuredXRepeatability_SD attribute to an unset state.
bool	hasMeasuredXRepeatability_SD() const Checks whether the MeasuredXRepeatability_SD attribute is present.
void	setMeasuredYRepeatability_SD(const float & value, bool validate =true) Sets the value of the MeasuredYRepeatability_SD attribute.
float	getMeasuredYRepeatability_SD() const Returns the value of the MeasuredYRepeatability_SD attribute.
void	resetMeasuredYRepeatability_SD() Resets the MeasuredYRepeatability_SD attribute to an unset state.
bool	hasMeasuredYRepeatability_SD() const Checks whether the MeasuredYRepeatability_SD attribute is present.
void	setMeasuredFocalRepeatability_SD(const float & value, bool validate =true) Sets the value of the MeasuredFocalRepeatability_SD attribute.
float	getMeasuredFocalRepeatability_SD() const Returns the value of the MeasuredFocalRepeatability_SD attribute.
void	resetMeasuredFocalRepeatability_SD() Resets the MeasuredFocalRepeatability_SD attribute to an unset state.
bool	hasMeasuredFocalRepeatability_SD() const Checks whether the MeasuredFocalRepeatability_SD attribute is present.
void	setMeasuredXSettlingTime_SD(const float & value, bool validate =true) Sets the value of the MeasuredXSettlingTime_SD attribute.
float	getMeasuredXSettlingTime_SD() const Returns the value of the MeasuredXSettlingTime_SD attribute.
void	resetMeasuredXSettlingTime_SD() Resets the MeasuredXSettlingTime_SD attribute to an unset state.
bool	hasMeasuredXSettlingTime_SD() const Checks whether the MeasuredXSettlingTime_SD attribute is present.
void	setMeasuredYSettlingTime_SD(const float & value, bool validate =true) Sets the value of the MeasuredYSettlingTime_SD attribute.
float	getMeasuredYSettlingTime_SD() const Returns the value of the MeasuredYSettlingTime_SD attribute.
void	resetMeasuredYSettlingTime_SD() Resets the MeasuredYSettlingTime_SD attribute to an unset state.
bool	hasMeasuredYSettlingTime_SD() const Checks whether the MeasuredYSettlingTime_SD attribute is present.
void	setMeasuredFocalSettlingTime_SD(const float & value, bool validate =true) Sets the value of the MeasuredFocalSettlingTime_SD attribute.
float	getMeasuredFocalSettlingTime_SD() const Returns the value of the MeasuredFocalSettlingTime_SD attribute.
void	resetMeasuredFocalSettlingTime_SD() Resets the MeasuredFocalSettlingTime_SD attribute to an unset state.
bool	hasMeasuredFocalSettlingTime_SD() const Checks whether the MeasuredFocalSettlingTime_SD attribute is present.
void	setSamplePositioningRef(const Inscoper::NBO::SamplePositioningRefPtr & value, bool validate =true) Sets the value of the SamplePositioningRef element.
Inscoper::NBO::SamplePositioningRefPtr	getSamplePositioningRef() const Returns the value of the SamplePositioningRef element.
void	resetSamplePositioningRef() Resets the SamplePositioningRef element to an unset state.
bool	hasSamplePositioningRef() const Checks whether the optional SamplePositioningRef element is present.
void	setFocusStabilizationDeviceRef(const Inscoper::NBO::FocusStabilizationDeviceRefPtr & value, bool validate =true) Sets the value of the FocusStabilizationDeviceRef element.
Inscoper::NBO::FocusStabilizationDeviceRefPtr	getFocusStabilizationDeviceRef() const Returns the value of the FocusStabilizationDeviceRef element.
void	resetFocusStabilizationDeviceRef() Resets the FocusStabilizationDeviceRef element to an unset state.
bool	hasFocusStabilizationDeviceRef() const Checks whether the optional FocusStabilizationDeviceRef element is present.
void	setAnnotationRef(const Inscoper::NBO::MechanicalCalibration::InlineAnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::MechanicalCalibration::InlineAnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< MechanicalCalibration >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a MechanicalCalibration.
const std::set< std::string > &	getDateAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::MechanicalCalibration;

Represents the XML element MechanicalCalibration.

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

Public Types Documentation¶

typedef InlineAnnotationRefPtr¶

Public Functions Documentation¶

function MechanicalCalibration¶

function ~MechanicalCalibration¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

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.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

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.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

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.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

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.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

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.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

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

function setID¶

void setID(
    const Inscoper::NBO::LSID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

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

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setDate¶

void setDate(
    const std::string & value,
    bool validate =true
)

Sets the value of the Date attribute.

Parameters:

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

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

function getDate¶

function resetDate¶

function hasDate¶

bool hasDate() const

Checks whether the Date attribute is present.

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

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

function setMeasuredXReproducibility¶

void setMeasuredXReproducibility(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXReproducibility attribute.

Parameters:

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

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.

function getMeasuredXReproducibility¶

float getMeasuredXReproducibility() const

Returns the value of the MeasuredXReproducibility attribute.

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

function resetMeasuredXReproducibility¶

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

function hasMeasuredXReproducibility¶

bool hasMeasuredXReproducibility() const

Checks whether the MeasuredXReproducibility attribute is present.

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

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.

function setMeasuredXReproducibilityUnit¶

void setMeasuredXReproducibilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredXReproducibilityUnit() const

Returns the value of the MeasuredXReproducibilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredXReproducibilityUnit¶

function hasMeasuredXReproducibilityUnit¶

bool hasMeasuredXReproducibilityUnit() const

Checks whether the optional MeasuredXReproducibilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredYReproducibility¶

void setMeasuredYReproducibility(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYReproducibility attribute.

Parameters:

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

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.

function getMeasuredYReproducibility¶

float getMeasuredYReproducibility() const

Returns the value of the MeasuredYReproducibility attribute.

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

function resetMeasuredYReproducibility¶

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

function hasMeasuredYReproducibility¶

bool hasMeasuredYReproducibility() const

Checks whether the MeasuredYReproducibility attribute is present.

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

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.

function setMeasuredYReproducibilityUnit¶

void setMeasuredYReproducibilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredYReproducibilityUnit() const

Returns the value of the MeasuredYReproducibilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredYReproducibilityUnit¶

function hasMeasuredYReproducibilityUnit¶

bool hasMeasuredYReproducibilityUnit() const

Checks whether the optional MeasuredYReproducibilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredFocalReproducibility¶

void setMeasuredFocalReproducibility(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalReproducibility attribute.

Parameters:

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

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.

function getMeasuredFocalReproducibility¶

float getMeasuredFocalReproducibility() const

Returns the value of the MeasuredFocalReproducibility attribute.

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

function resetMeasuredFocalReproducibility¶

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

function hasMeasuredFocalReproducibility¶

bool hasMeasuredFocalReproducibility() const

Checks whether the MeasuredFocalReproducibility attribute is present.

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

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.

function setMeasuredFocalReproducibilityUnit¶

void setMeasuredFocalReproducibilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredFocalReproducibilityUnit() const

Returns the value of the MeasuredFocalReproducibilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredFocalReproducibilityUnit¶

function hasMeasuredFocalReproducibilityUnit¶

bool hasMeasuredFocalReproducibilityUnit() const

Checks whether the optional MeasuredFocalReproducibilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredXRepeatability¶

void setMeasuredXRepeatability(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXRepeatability attribute.

Parameters:

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

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.

function getMeasuredXRepeatability¶

float getMeasuredXRepeatability() const

Returns the value of the MeasuredXRepeatability attribute.

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

function resetMeasuredXRepeatability¶

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

function hasMeasuredXRepeatability¶

bool hasMeasuredXRepeatability() const

Checks whether the MeasuredXRepeatability attribute is present.

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

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.

function setMeasuredXRepeatabilityUnit¶

void setMeasuredXRepeatabilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredXRepeatabilityUnit() const

Returns the value of the MeasuredXRepeatabilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredXRepeatabilityUnit¶

function hasMeasuredXRepeatabilityUnit¶

bool hasMeasuredXRepeatabilityUnit() const

Checks whether the optional MeasuredXRepeatabilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredYRepeatability¶

void setMeasuredYRepeatability(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYRepeatability attribute.

Parameters:

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

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.

function getMeasuredYRepeatability¶

float getMeasuredYRepeatability() const

Returns the value of the MeasuredYRepeatability attribute.

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

function resetMeasuredYRepeatability¶

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

function hasMeasuredYRepeatability¶

bool hasMeasuredYRepeatability() const

Checks whether the MeasuredYRepeatability attribute is present.

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

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.

function setMeasuredYRepeatabilityUnit¶

void setMeasuredYRepeatabilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredYRepeatabilityUnit() const

Returns the value of the MeasuredYRepeatabilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredYRepeatabilityUnit¶

function hasMeasuredYRepeatabilityUnit¶

bool hasMeasuredYRepeatabilityUnit() const

Checks whether the optional MeasuredYRepeatabilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredFocalRepeatability¶

void setMeasuredFocalRepeatability(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalRepeatability attribute.

Parameters:

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

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.

function getMeasuredFocalRepeatability¶

float getMeasuredFocalRepeatability() const

Returns the value of the MeasuredFocalRepeatability attribute.

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

function resetMeasuredFocalRepeatability¶

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

function hasMeasuredFocalRepeatability¶

bool hasMeasuredFocalRepeatability() const

Checks whether the MeasuredFocalRepeatability attribute is present.

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

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.

function setMeasuredFocalRepeatabilityUnit¶

void setMeasuredFocalRepeatabilityUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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

UnitsLength_TypePtr getMeasuredFocalRepeatabilityUnit() const

Returns the value of the MeasuredFocalRepeatabilityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredFocalRepeatabilityUnit¶

function hasMeasuredFocalRepeatabilityUnit¶

bool hasMeasuredFocalRepeatabilityUnit() const

Checks whether the optional MeasuredFocalRepeatabilityUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredXSettlingTime¶

void setMeasuredXSettlingTime(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXSettlingTime attribute.

Parameters:

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

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.

function getMeasuredXSettlingTime¶

float getMeasuredXSettlingTime() const

Returns the value of the MeasuredXSettlingTime attribute.

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

function resetMeasuredXSettlingTime¶

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

function hasMeasuredXSettlingTime¶

bool hasMeasuredXSettlingTime() const

Checks whether the MeasuredXSettlingTime attribute is present.

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

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.

function setMeasuredXSettlingTimeUnit¶

void setMeasuredXSettlingTimeUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

Sets the value of the MeasuredXSettlingTimeUnit 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 getMeasuredXSettlingTimeUnit¶

UnitsTime_TypePtr getMeasuredXSettlingTimeUnit() const

Returns the value of the MeasuredXSettlingTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredXSettlingTimeUnit¶

function hasMeasuredXSettlingTimeUnit¶

bool hasMeasuredXSettlingTimeUnit() const

Checks whether the optional MeasuredXSettlingTimeUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredYSettlingTime¶

void setMeasuredYSettlingTime(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYSettlingTime attribute.

Parameters:

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

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.

function getMeasuredYSettlingTime¶

float getMeasuredYSettlingTime() const

Returns the value of the MeasuredYSettlingTime attribute.

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

function resetMeasuredYSettlingTime¶

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

function hasMeasuredYSettlingTime¶

bool hasMeasuredYSettlingTime() const

Checks whether the MeasuredYSettlingTime attribute is present.

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

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.

function setMeasuredYSettlingTimeUnit¶

void setMeasuredYSettlingTimeUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

Sets the value of the MeasuredYSettlingTimeUnit 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 getMeasuredYSettlingTimeUnit¶

UnitsTime_TypePtr getMeasuredYSettlingTimeUnit() const

Returns the value of the MeasuredYSettlingTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredYSettlingTimeUnit¶

function hasMeasuredYSettlingTimeUnit¶

bool hasMeasuredYSettlingTimeUnit() const

Checks whether the optional MeasuredYSettlingTimeUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredFocalSettlingTime¶

void setMeasuredFocalSettlingTime(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalSettlingTime attribute.

Parameters:

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

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.

function getMeasuredFocalSettlingTime¶

float getMeasuredFocalSettlingTime() const

Returns the value of the MeasuredFocalSettlingTime attribute.

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

function resetMeasuredFocalSettlingTime¶

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

function hasMeasuredFocalSettlingTime¶

bool hasMeasuredFocalSettlingTime() const

Checks whether the MeasuredFocalSettlingTime attribute is present.

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

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.

function setMeasuredFocalSettlingTimeUnit¶

void setMeasuredFocalSettlingTimeUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

Sets the value of the MeasuredFocalSettlingTimeUnit 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 getMeasuredFocalSettlingTimeUnit¶

UnitsTime_TypePtr getMeasuredFocalSettlingTimeUnit() const

Returns the value of the MeasuredFocalSettlingTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMeasuredFocalSettlingTimeUnit¶

function hasMeasuredFocalSettlingTimeUnit¶

bool hasMeasuredFocalSettlingTimeUnit() const

Checks whether the optional MeasuredFocalSettlingTimeUnit attribute is present.

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

No description available in the XSD standard.

function setMeasuredXReproducibility_SD¶

void setMeasuredXReproducibility_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXReproducibility_SD attribute.

Parameters:

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

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.

function getMeasuredXReproducibility_SD¶

float getMeasuredXReproducibility_SD() const

Returns the value of the MeasuredXReproducibility_SD attribute.

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

function resetMeasuredXReproducibility_SD¶

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

function hasMeasuredXReproducibility_SD¶

bool hasMeasuredXReproducibility_SD() const

Checks whether the MeasuredXReproducibility_SD attribute is present.

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

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.

function setMeasuredYReproducibility_SD¶

void setMeasuredYReproducibility_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYReproducibility_SD attribute.

Parameters:

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

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.

function getMeasuredYReproducibility_SD¶

float getMeasuredYReproducibility_SD() const

Returns the value of the MeasuredYReproducibility_SD attribute.

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

function resetMeasuredYReproducibility_SD¶

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

function hasMeasuredYReproducibility_SD¶

bool hasMeasuredYReproducibility_SD() const

Checks whether the MeasuredYReproducibility_SD attribute is present.

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

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.

function setMeasuredFocalReproducibility_SD¶

void setMeasuredFocalReproducibility_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalReproducibility_SD attribute.

Parameters:

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

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.

function getMeasuredFocalReproducibility_SD¶

float getMeasuredFocalReproducibility_SD() const

Returns the value of the MeasuredFocalReproducibility_SD attribute.

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

function resetMeasuredFocalReproducibility_SD¶

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

function hasMeasuredFocalReproducibility_SD¶

bool hasMeasuredFocalReproducibility_SD() const

Checks whether the MeasuredFocalReproducibility_SD attribute is present.

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

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.

function setMeasuredXRepeatability_SD¶

void setMeasuredXRepeatability_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXRepeatability_SD attribute.

Parameters:

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

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.

function getMeasuredXRepeatability_SD¶

float getMeasuredXRepeatability_SD() const

Returns the value of the MeasuredXRepeatability_SD attribute.

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

function resetMeasuredXRepeatability_SD¶

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

function hasMeasuredXRepeatability_SD¶

bool hasMeasuredXRepeatability_SD() const

Checks whether the MeasuredXRepeatability_SD attribute is present.

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

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.

function setMeasuredYRepeatability_SD¶

void setMeasuredYRepeatability_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYRepeatability_SD attribute.

Parameters:

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

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.

function getMeasuredYRepeatability_SD¶

float getMeasuredYRepeatability_SD() const

Returns the value of the MeasuredYRepeatability_SD attribute.

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

function resetMeasuredYRepeatability_SD¶

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

function hasMeasuredYRepeatability_SD¶

bool hasMeasuredYRepeatability_SD() const

Checks whether the MeasuredYRepeatability_SD attribute is present.

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

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.

function setMeasuredFocalRepeatability_SD¶

void setMeasuredFocalRepeatability_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalRepeatability_SD attribute.

Parameters:

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

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.

function getMeasuredFocalRepeatability_SD¶

float getMeasuredFocalRepeatability_SD() const

Returns the value of the MeasuredFocalRepeatability_SD attribute.

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

function resetMeasuredFocalRepeatability_SD¶

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

function hasMeasuredFocalRepeatability_SD¶

bool hasMeasuredFocalRepeatability_SD() const

Checks whether the MeasuredFocalRepeatability_SD attribute is present.

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

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.

function setMeasuredXSettlingTime_SD¶

void setMeasuredXSettlingTime_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredXSettlingTime_SD attribute.

Parameters:

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

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.

function getMeasuredXSettlingTime_SD¶

float getMeasuredXSettlingTime_SD() const

Returns the value of the MeasuredXSettlingTime_SD attribute.

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

function resetMeasuredXSettlingTime_SD¶

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

function hasMeasuredXSettlingTime_SD¶

bool hasMeasuredXSettlingTime_SD() const

Checks whether the MeasuredXSettlingTime_SD attribute is present.

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

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.

function setMeasuredYSettlingTime_SD¶

void setMeasuredYSettlingTime_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredYSettlingTime_SD attribute.

Parameters:

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

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.

function getMeasuredYSettlingTime_SD¶

float getMeasuredYSettlingTime_SD() const

Returns the value of the MeasuredYSettlingTime_SD attribute.

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

function resetMeasuredYSettlingTime_SD¶

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

function hasMeasuredYSettlingTime_SD¶

bool hasMeasuredYSettlingTime_SD() const

Checks whether the MeasuredYSettlingTime_SD attribute is present.

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

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.

function setMeasuredFocalSettlingTime_SD¶

void setMeasuredFocalSettlingTime_SD(
    const float & value,
    bool validate =true
)

Sets the value of the MeasuredFocalSettlingTime_SD attribute.

Parameters:

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

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.

function getMeasuredFocalSettlingTime_SD¶

float getMeasuredFocalSettlingTime_SD() const

Returns the value of the MeasuredFocalSettlingTime_SD attribute.

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

function resetMeasuredFocalSettlingTime_SD¶

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

function hasMeasuredFocalSettlingTime_SD¶

bool hasMeasuredFocalSettlingTime_SD() const

Checks whether the MeasuredFocalSettlingTime_SD attribute is present.

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

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.

function setSamplePositioningRef¶

void setSamplePositioningRef(
    const Inscoper::NBO::SamplePositioningRefPtr & value,
    bool validate =true
)

Sets the value of the SamplePositioningRef element.

Parameters:

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

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.

function getSamplePositioningRef¶

Inscoper::NBO::SamplePositioningRefPtr getSamplePositioningRef() const

Returns the value of the SamplePositioningRef element.

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

function resetSamplePositioningRef¶

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

function hasSamplePositioningRef¶

bool hasSamplePositioningRef() const

Checks whether the optional SamplePositioningRef element is present.

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

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.

function setFocusStabilizationDeviceRef¶

void setFocusStabilizationDeviceRef(
    const Inscoper::NBO::FocusStabilizationDeviceRefPtr & value,
    bool validate =true
)

Sets the value of the FocusStabilizationDeviceRef element.

Parameters:

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

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.

function getFocusStabilizationDeviceRef¶

Inscoper::NBO::FocusStabilizationDeviceRefPtr getFocusStabilizationDeviceRef() const

Returns the value of the FocusStabilizationDeviceRef element.

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

function resetFocusStabilizationDeviceRef¶

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

function hasFocusStabilizationDeviceRef¶

bool hasFocusStabilizationDeviceRef() const

Checks whether the optional FocusStabilizationDeviceRef element is present.

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

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.

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::MechanicalCalibration::InlineAnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

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

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

function getAnnotationRef¶

Inscoper::NBO::MechanicalCalibration::InlineAnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

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

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

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

function fromBase¶

static std::shared_ptr< MechanicalCalibration > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a MechanicalCalibration.

Parameters:

base The base class to cast

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

function getDateAllowedValues¶

static const std::set< std::string > & getDateAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

Updated on 2026-09-23 at 16:50:38 +0200