SamplePositioningSettings

Bases: Settings_Type

Represents the XML element SamplePositioningSettings.

This element holds the Setting applied to a Sample Positioning Device used  during the Acquisiton of this experimental Image as well as a reference (the ID attribute) to the Sample Positioning Device in question.

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.

This is the Unique Identifier of the Sample Positioning Device used in this case.

Parameters:

Name	Type	Description	Default
value	SamplePositioningID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

This is the Unique Identifier of the Sample Positioning Device used in this case.

Returns:

Type	Description
SamplePositioningID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the Sample Positioning Device used in this case.

hasID()

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the Sample Positioning Device used in this case.

Returns:

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

setXYVelocitySetting(value)

Sets the value of the XYVelocitySetting attribute.

This field describes the XY Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getXYVelocitySetting()

Returns the value of the XYVelocitySetting attribute.

This field describes the XY Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Returns:

Type	Description
float	The value of the attribute

resetXYVelocitySetting()

Resets the XYVelocitySetting attribute to an unset state.

This field describes the XY Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

hasXYVelocitySetting()

Checks whether the optional XYVelocitySetting attribute is present.

This field describes the XY Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Returns:

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

setXYVelocitySettingUnit(value)

Sets the value of the XYVelocitySettingUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsVelocity_Type	The value to set	required

getXYVelocitySettingUnit()

Returns the value of the XYVelocitySettingUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsVelocity_Type	The value of the attribute

resetXYVelocitySettingUnit()

Resets the XYVelocitySettingUnit attribute to an unset state.

No description available in the XSD standard.

hasXYVelocitySettingUnit()

Checks whether the optional XYVelocitySettingUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZVelocitySetting(value)

Sets the value of the ZVelocitySetting attribute.

This field describes the Z-axis Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getZVelocitySetting()

Returns the value of the ZVelocitySetting attribute.

This field describes the Z-axis Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Returns:

Type	Description
float	The value of the attribute

resetZVelocitySetting()

Resets the ZVelocitySetting attribute to an unset state.

This field describes the Z-axis Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

hasZVelocitySetting()

Checks whether the optional ZVelocitySetting attribute is present.

This field describes the Z-axis Velocity that was set for this Sample Positioning Device during the Acquisition of this experimental Image.

Returns:

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

setZVelocitySettingUnit(value)

Sets the value of the ZVelocitySettingUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsVelocity_Type	The value to set	required

getZVelocitySettingUnit()

Returns the value of the ZVelocitySettingUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsVelocity_Type	The value of the attribute

resetZVelocitySettingUnit()

Resets the ZVelocitySettingUnit attribute to an unset state.

No description available in the XSD standard.

hasZVelocitySettingUnit()

Checks whether the optional ZVelocitySettingUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setXYReproducibilitySettings(value)

Sets the value of the XYReproducibilitySettings attribute.

This field describes the XY Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given XY Position over time as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getXYReproducibilitySettings()

Returns the value of the XYReproducibilitySettings attribute.

This field describes the XY Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given XY Position over time as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

Type	Description
float	The value of the attribute

resetXYReproducibilitySettings()

Resets the XYReproducibilitySettings attribute to an unset state.

This field describes the XY Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given XY Position over time as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

hasXYReproducibilitySettings()

Checks whether the optional XYReproducibilitySettings attribute is present.

This field describes the XY Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given XY Position over time as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

Returns:

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

setXYReproducibilitySettingsUnit(value)

Sets the value of the XYReproducibilitySettingsUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getXYReproducibilitySettingsUnit()

Returns the value of the XYReproducibilitySettingsUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetXYReproducibilitySettingsUnit()

Resets the XYReproducibilitySettingsUnit attribute to an unset state.

No description available in the XSD standard.

hasXYReproducibilitySettingsUnit()

Checks whether the optional XYReproducibilitySettingsUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setZReproducibilitySettings(value)

Sets the value of the ZReproducibilitySettings attribute.

This field describes the Z-Axis Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given Z-axis Position over time 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

getZReproducibilitySettings()

Returns the value of the ZReproducibilitySettings attribute.

This field describes the Z-Axis Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given Z-axis Position over time 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

resetZReproducibilitySettings()

Resets the ZReproducibilitySettings attribute to an unset state.

This field describes the Z-Axis Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given Z-axis Position over time 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.

hasZReproducibilitySettings()

Checks whether the optional ZReproducibilitySettings attribute is present.

This field describes the Z-Axis Precision that was set for this Sample Positioning Device during the Acquisition of this experimental Image. This metric refers to the capacity this Device of maintaining a given Z-axis Position over time 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

setZReproducibilitySettingsUnit(value)

Sets the value of the ZReproducibilitySettingsUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getZReproducibilitySettingsUnit()

Returns the value of the ZReproducibilitySettingsUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZReproducibilitySettingsUnit()

Resets the ZReproducibilitySettingsUnit attribute to an unset state.

No description available in the XSD standard.

hasZReproducibilitySettingsUnit()

Checks whether the optional ZReproducibilitySettingsUnit attribute is present.

No description available in the XSD standard.

Returns:

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