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.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a SamplePositioningSettings.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`SamplePositioningSettings`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

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

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

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

`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()` ¶

`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, validate=True)` ¶

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

`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()` ¶

`hasXYVelocitySetting()` ¶

Checks whether the 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 attribute has been set, false otherwise

`setXYVelocitySettingUnit(value, validate=True)` ¶

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

`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()` ¶

`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, validate=True)` ¶

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

`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()` ¶

`hasZVelocitySetting()` ¶

Checks whether the 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 attribute has been set, false otherwise

`setZVelocitySettingUnit(value, validate=True)` ¶

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

`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()` ¶

`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, validate=True)` ¶

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

`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()` ¶

`hasXYReproducibilitySettings()` ¶

Checks whether the 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 attribute has been set, false otherwise

`setXYReproducibilitySettingsUnit(value, validate=True)` ¶

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

`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()` ¶

`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, validate=True)` ¶

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

`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()` ¶

`hasZReproducibilitySettings()` ¶

Checks whether the 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 attribute has been set, false otherwise

`setZReproducibilitySettingsUnit(value, validate=True)` ¶

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

`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()` ¶

`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

SamplePositioningSettings¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

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) ¶

getID() ¶

resetID() ¶

hasID() ¶

setXYVelocitySetting(value, validate=True) ¶

getXYVelocitySetting() ¶

resetXYVelocitySetting() ¶

hasXYVelocitySetting() ¶

setXYVelocitySettingUnit(value, validate=True) ¶

getXYVelocitySettingUnit() ¶

resetXYVelocitySettingUnit() ¶

hasXYVelocitySettingUnit() ¶

setZVelocitySetting(value, validate=True) ¶

getZVelocitySetting() ¶

resetZVelocitySetting() ¶

hasZVelocitySetting() ¶

setZVelocitySettingUnit(value, validate=True) ¶

getZVelocitySettingUnit() ¶

resetZVelocitySettingUnit() ¶

hasZVelocitySettingUnit() ¶

setXYReproducibilitySettings(value, validate=True) ¶

getXYReproducibilitySettings() ¶

resetXYReproducibilitySettings() ¶

hasXYReproducibilitySettings() ¶

setXYReproducibilitySettingsUnit(value, validate=True) ¶

getXYReproducibilitySettingsUnit() ¶

resetXYReproducibilitySettingsUnit() ¶

hasXYReproducibilitySettingsUnit() ¶

setZReproducibilitySettings(value, validate=True) ¶

getZReproducibilitySettings() ¶

resetZReproducibilitySettings() ¶

hasZReproducibilitySettings() ¶

setZReproducibilitySettingsUnit(value, validate=True) ¶

getZReproducibilitySettingsUnit() ¶

resetZReproducibilitySettingsUnit() ¶

hasZReproducibilitySettingsUnit() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`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)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setXYVelocitySetting(value, validate=True)` ¶

`getXYVelocitySetting()` ¶

`resetXYVelocitySetting()` ¶

`hasXYVelocitySetting()` ¶

`setXYVelocitySettingUnit(value, validate=True)` ¶

`getXYVelocitySettingUnit()` ¶

`resetXYVelocitySettingUnit()` ¶

`hasXYVelocitySettingUnit()` ¶

`setZVelocitySetting(value, validate=True)` ¶

`getZVelocitySetting()` ¶

`resetZVelocitySetting()` ¶

`hasZVelocitySetting()` ¶

`setZVelocitySettingUnit(value, validate=True)` ¶

`getZVelocitySettingUnit()` ¶

`resetZVelocitySettingUnit()` ¶

`hasZVelocitySettingUnit()` ¶

`setXYReproducibilitySettings(value, validate=True)` ¶

`getXYReproducibilitySettings()` ¶

`resetXYReproducibilitySettings()` ¶

`hasXYReproducibilitySettings()` ¶

`setXYReproducibilitySettingsUnit(value, validate=True)` ¶

`getXYReproducibilitySettingsUnit()` ¶

`resetXYReproducibilitySettingsUnit()` ¶

`hasXYReproducibilitySettingsUnit()` ¶

`setZReproducibilitySettings(value, validate=True)` ¶

`getZReproducibilitySettings()` ¶

`resetZReproducibilitySettings()` ¶

`hasZReproducibilitySettings()` ¶

`setZReproducibilitySettingsUnit(value, validate=True)` ¶

`getZReproducibilitySettingsUnit()` ¶

`resetZReproducibilitySettingsUnit()` ¶

`hasZReproducibilitySettingsUnit()` ¶