Bases: ManufacturerSpec_Type
Represents the XML complex type SamplePositioning.
This element describes a Sample-Optics Positioning device available for this Instrument. An Instrument may have more than one of these devices of different types. For example, a typical setup might include a Mechanical Stage, a Stage Insert, a Turret Objective Focusing, and a Piezoelectric Objective Focusing device.
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
setID ( value , validate = True )
setName ( value , validate = True )
setEncoded ( value , validate = True )
Sets the value of the Encoded attribute.
This field describes whether this Sample Positioning Device is equipped with a system (i.e., encoder) to monitor movement and provide automatic positional feedback for high-precision operations, and it specifies the type of encoders it has.
Parameters:
Name
Type
Description
Default
value
Encoded_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getEncoded ()
Returns the value of the Encoded attribute.
This field describes whether this Sample Positioning Device is equipped with a system (i.e., encoder) to monitor movement and provide automatic positional feedback for high-precision operations, and it specifies the type of encoders it has.
Returns:
Type
Description
Encoded_Type
The value of the attribute
resetEncoded ()
Resets the Encoded attribute to an unset state.
This field describes whether this Sample Positioning Device is equipped with a system (i.e., encoder) to monitor movement and provide automatic positional feedback for high-precision operations, and it specifies the type of encoders it has.
hasEncoded ()
Checks whether the optional Encoded attribute is present.
This field describes whether this Sample Positioning Device is equipped with a system (i.e., encoder) to monitor movement and provide automatic positional feedback for high-precision operations, and it specifies the type of encoders it has.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setMotorized ( value , validate = True )
Sets the value of the Motorized attribute.
This field describes whether (True) or not (False) this Sample Positioning Device is fitted with a Motorized component (i.e., ball-screw drives or rack mechanisms, sometimes equipped with precision calibration) to primarily assist in the translational movement of the sample in the X and Y or Z directions. A Motorized Stage is also often referred to as a Scanning Stage.
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getMotorized ()
Returns the value of the Motorized attribute.
This field describes whether (True) or not (False) this Sample Positioning Device is fitted with a Motorized component (i.e., ball-screw drives or rack mechanisms, sometimes equipped with precision calibration) to primarily assist in the translational movement of the sample in the X and Y or Z directions. A Motorized Stage is also often referred to as a Scanning Stage.
Returns:
Type
Description
boolean
The value of the attribute
resetMotorized ()
Resets the Motorized attribute to an unset state.
This field describes whether (True) or not (False) this Sample Positioning Device is fitted with a Motorized component (i.e., ball-screw drives or rack mechanisms, sometimes equipped with precision calibration) to primarily assist in the translational movement of the sample in the X and Y or Z directions. A Motorized Stage is also often referred to as a Scanning Stage.
hasMotorized ()
Checks whether the Motorized attribute is present.
This field describes whether (True) or not (False) this Sample Positioning Device is fitted with a Motorized component (i.e., ball-screw drives or rack mechanisms, sometimes equipped with precision calibration) to primarily assist in the translational movement of the sample in the X and Y or Z directions. A Motorized Stage is also often referred to as a Scanning Stage.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setZMaxVelocity ( value , validate = True )
setZMaxVelocityUnit ( value , validate = True )
setZRepeatability ( value , validate = True )
Sets the value of the ZRepeatability attribute.
This field captures the expected Accuracy with which this Sample Positioning Device is capable of returning to a previously visited Z-axis Position, as specified by the Manufacturer. This metric is important for example for Tiling.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getZRepeatability ()
Returns the value of the ZRepeatability attribute.
This field captures the expected Accuracy with which this Sample Positioning Device is capable of returning to a previously visited Z-axis Position, as specified by the Manufacturer. This metric is important for example for Tiling.
Returns:
Type
Description
float
The value of the attribute
resetZRepeatability ()
Resets the ZRepeatability attribute to an unset state.
This field captures the expected Accuracy with which this Sample Positioning Device is capable of returning to a previously visited Z-axis Position, as specified by the Manufacturer. This metric is important for example for Tiling.
hasZRepeatability ()
Checks whether the ZRepeatability attribute is present.
This field captures the expected Accuracy with which this Sample Positioning Device is capable of returning to a previously visited Z-axis Position, as specified by the Manufacturer. This metric is important for example for Tiling.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setZRepeatabilityUnit ( value , validate = True )
resetZRepeatabilityUnit ()
setZTravelRange ( value , validate = True )
setZTravelRangeUnit ( value , validate = True )
setMovementAxes ( value , validate = True )
setBuiltIn ( value , validate = True )
setZReproducibility ( value , validate = True )
Sets the value of the ZReproducibility attribute.
This field captures the expected Precision with which this this Sample Positioning Device is capable of maintaining a given Z-axis Position over time during as specified by the Manufacturer. 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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getZReproducibility ()
Returns the value of the ZReproducibility attribute.
This field captures the expected Precision with which this this Sample Positioning Device is capable of maintaining a given Z-axis Position over time during as specified by the Manufacturer. 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
resetZReproducibility ()
Resets the ZReproducibility attribute to an unset state.
This field captures the expected Precision with which this this Sample Positioning Device is capable of maintaining a given Z-axis Position over time during as specified by the Manufacturer. 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.
hasZReproducibility ()
Checks whether the ZReproducibility attribute is present.
This field captures the expected Precision with which this this Sample Positioning Device is capable of maintaining a given Z-axis Position over time during as specified by the Manufacturer. 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
setZReproducibilityUnit ( value , validate = True )
getZReproducibilityUnit ()
resetZReproducibilityUnit ()
hasZReproducibilityUnit ()
setZSettlingTime ( value , validate = True )
Sets the value of the ZSettlingTime attribute.
This field describes the expected time it takes for this Sample Positioning Device to stabilize at the target Z-axis position, as specified by the Manufacturer.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getZSettlingTime ()
Returns the value of the ZSettlingTime attribute.
This field describes the expected time it takes for this Sample Positioning Device to stabilize at the target Z-axis position, as specified by the Manufacturer.
Returns:
Type
Description
float
The value of the attribute
resetZSettlingTime ()
Resets the ZSettlingTime attribute to an unset state.
This field describes the expected time it takes for this Sample Positioning Device to stabilize at the target Z-axis position, as specified by the Manufacturer.
hasZSettlingTime ()
Checks whether the ZSettlingTime attribute is present.
This field describes the expected time it takes for this Sample Positioning Device to stabilize at the target Z-axis position, as specified by the Manufacturer.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setZSettlingTimeUnit ( value , validate = True )
setZResolution ( value , validate = True )
setZResolutionUnit ( value , validate = True )
setZPositionLinearityError ( value , validate = True )
Sets the value of the ZPositionLinearityError attribute.
This field describes the Z-axis positioning error (typically expressed in % error) associated with this Sample Positioning Device as specified by the Manufacturer.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getZPositionLinearityError ()
Returns the value of the ZPositionLinearityError attribute.
This field describes the Z-axis positioning error (typically expressed in % error) associated with this Sample Positioning Device as specified by the Manufacturer.
Returns:
Type
Description
float
The value of the attribute
resetZPositionLinearityError ()
Resets the ZPositionLinearityError attribute to an unset state.
This field describes the Z-axis positioning error (typically expressed in % error) associated with this Sample Positioning Device as specified by the Manufacturer.
hasZPositionLinearityError ()
Checks whether the ZPositionLinearityError attribute is present.
This field describes the Z-axis positioning error (typically expressed in % error) associated with this Sample Positioning Device as specified by the Manufacturer.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setType ( value , validate = True )
setRotationAngle ( value , validate = True )
setRotationAngleUnit ( value , validate = True )
setAnnotationRef ( value , validate = True )