SamplePositioning_Type

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.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	SamplePositioningID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
SamplePositioningID_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

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setEncoded(value)

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	The value to set	required

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)

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	The value to set	required

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

setZMaxVelocity(value)

Sets the value of the ZMaxVelocity attribute.

This field describes the maximum Z-axis Velocity at which this Sample Positioning Device is capable of moving.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getZMaxVelocity()

Returns the value of the ZMaxVelocity attribute.

This field describes the maximum Z-axis Velocity at which this Sample Positioning Device is capable of moving.

Returns:

Type	Description
float	The value of the attribute

resetZMaxVelocity()

Resets the ZMaxVelocity attribute to an unset state.

This field describes the maximum Z-axis Velocity at which this Sample Positioning Device is capable of moving.

hasZMaxVelocity()

Checks whether the optional ZMaxVelocity attribute is present.

This field describes the maximum Z-axis Velocity at which this Sample Positioning Device is capable of moving.

Returns:

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

setZMaxVelocityUnit(value)

Sets the value of the ZMaxVelocityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsVelocity_Type	The value to set	required

getZMaxVelocityUnit()

Returns the value of the ZMaxVelocityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsVelocity_Type	The value of the attribute

resetZMaxVelocityUnit()

Resets the ZMaxVelocityUnit attribute to an unset state.

No description available in the XSD standard.

hasZMaxVelocityUnit()

Checks whether the optional ZMaxVelocityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZRepeatability(value)

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	The value to set	required

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

setZRepeatabilityUnit(value)

Sets the value of the ZRepeatabilityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getZRepeatabilityUnit()

Returns the value of the ZRepeatabilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZRepeatabilityUnit()

Resets the ZRepeatabilityUnit attribute to an unset state.

No description available in the XSD standard.

hasZRepeatabilityUnit()

Checks whether the optional ZRepeatabilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZTravelRange(value)

Sets the value of the ZTravelRange attribute.

This field describes the total range in the Z-axis that this Sample Positioning Device can travel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getZTravelRange()

Returns the value of the ZTravelRange attribute.

This field describes the total range in the Z-axis that this Sample Positioning Device can travel.

Returns:

Type	Description
float	The value of the attribute

resetZTravelRange()

Resets the ZTravelRange attribute to an unset state.

This field describes the total range in the Z-axis that this Sample Positioning Device can travel.

hasZTravelRange()

Checks whether the optional ZTravelRange attribute is present.

This field describes the total range in the Z-axis that this Sample Positioning Device can travel.

Returns:

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

setZTravelRangeUnit(value)

Sets the value of the ZTravelRangeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getZTravelRangeUnit()

Returns the value of the ZTravelRangeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZTravelRangeUnit()

Resets the ZTravelRangeUnit attribute to an unset state.

No description available in the XSD standard.

hasZTravelRangeUnit()

Checks whether the optional ZTravelRangeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMovementAxes(value)

Sets the value of the MovementAxes attribute.

This field describes the axes or combination of axes along which this Sample Positioning Device is capable of moving.

Parameters:

Name	Type	Description	Default
value	StageMovementAxes_Type	The value to set	required

getMovementAxes()

Returns the value of the MovementAxes attribute.

This field describes the axes or combination of axes along which this Sample Positioning Device is capable of moving.

Returns:

Type	Description
StageMovementAxes_Type	The value of the attribute

resetMovementAxes()

Resets the MovementAxes attribute to an unset state.

This field describes the axes or combination of axes along which this Sample Positioning Device is capable of moving.

hasMovementAxes()

Checks whether the optional MovementAxes attribute is present.

This field describes the axes or combination of axes along which this Sample Positioning Device is capable of moving.

Returns:

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

setBuiltIn(value)

Sets the value of the BuiltIn attribute.

This field indicates whether this Sample Positioning Device is built into the Microscope Stand (True) or it is removable and interchangeable (False).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getBuiltIn()

Returns the value of the BuiltIn attribute.

This field indicates whether this Sample Positioning Device is built into the Microscope Stand (True) or it is removable and interchangeable (False).

Returns:

Type	Description
boolean	The value of the attribute

setZReproducibility(value)

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	The value to set	required

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 optional 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 optional attribute has been set, false otherwise

setZReproducibilityUnit(value)

Sets the value of the ZReproducibilityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getZReproducibilityUnit()

Returns the value of the ZReproducibilityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZReproducibilityUnit()

Resets the ZReproducibilityUnit attribute to an unset state.

No description available in the XSD standard.

hasZReproducibilityUnit()

Checks whether the optional ZReproducibilityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZSettlingTime(value)

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	The value to set	required

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 optional 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 optional attribute has been set, false otherwise

setZSettlingTimeUnit(value)

Sets the value of the ZSettlingTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getZSettlingTimeUnit()

Returns the value of the ZSettlingTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetZSettlingTimeUnit()

Resets the ZSettlingTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasZSettlingTimeUnit()

Checks whether the optional ZSettlingTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZResolution(value)

Sets the value of the ZResolution attribute.

This field describes the Z-axis motion Resolution of this Sample Positioning Device as specified by the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getZResolution()

Returns the value of the ZResolution attribute.

This field describes the Z-axis motion Resolution of this Sample Positioning Device as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetZResolution()

Resets the ZResolution attribute to an unset state.

This field describes the Z-axis motion Resolution of this Sample Positioning Device as specified by the Manufacturer.

hasZResolution()

Checks whether the optional ZResolution attribute is present.

This field describes the Z-axis motion Resolution of this Sample Positioning Device as specified by the Manufacturer.

Returns:

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

setZResolutionUnit(value)

Sets the value of the ZResolutionUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getZResolutionUnit()

Returns the value of the ZResolutionUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZResolutionUnit()

Resets the ZResolutionUnit attribute to an unset state.

No description available in the XSD standard.

hasZResolutionUnit()

Checks whether the optional ZResolutionUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZPositionLinearityError(value)

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	The value to set	required

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 optional 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 optional attribute has been set, false otherwise

setType(value)

Sets the value of the Type attribute.

This field describes the general category of this Sample Positioning Device.

Parameters:

Name	Type	Description	Default
value	PositioningType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

This field describes the general category of this Sample Positioning Device.

Returns:

Type	Description
PositioningType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field describes the general category of this Sample Positioning Device.

hasType()

Checks whether the optional Type attribute is present.

This field describes the general category of this Sample Positioning Device.

Returns:

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

setRotationAngle(value)

Sets the value of the RotationAngle attribute.

The angle by which this Sample Positioning Device is capable of rotating.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRotationAngle()

Returns the value of the RotationAngle attribute.

The angle by which this Sample Positioning Device is capable of rotating.

Returns:

Type	Description
float	The value of the attribute

resetRotationAngle()

Resets the RotationAngle attribute to an unset state.

The angle by which this Sample Positioning Device is capable of rotating.

hasRotationAngle()

Checks whether the optional RotationAngle attribute is present.

The angle by which this Sample Positioning Device is capable of rotating.

Returns:

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

setRotationAngleUnit(value)

Sets the value of the RotationAngleUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getRotationAngleUnit()

Returns the value of the RotationAngleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetRotationAngleUnit()

Resets the RotationAngleUnit attribute to an unset state.

No description available in the XSD standard.

hasRotationAngleUnit()

Checks whether the optional RotationAngleUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

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