FocusStabilizationDevice¶

Bases: ManufacturerSpec_Type

Represents the XML element FocusStabilizationDevice.

This element describes an optional focus stabilization device (also known as, Auto Focus) that may be used for bringing an object automatically into focus for this instrument. Such devices can be controlled either via an imaging software and/or by a hardware device that detects and adjusts the objective or sample positions.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a FocusStabilizationDevice.

Parameters:

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

Returns:

Type	Description
`FocusStabilizationDevice`	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.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
`value`	`FocusStabilizationID_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.

A Unique Identifier for this component.

Returns:

Type	Description
`FocusStabilizationID_Type`	The value of the attribute

`resetID()` ¶

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

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

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

`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

`setMechanism(value, validate=True)` ¶

Sets the value of the Mechanism attribute.

This field refers to the mechanism employed by this Focus Stabilization Device. Software (also referred to as Image) based methods rely on the acquisition of a Z-series of images followed by image analysis to determine the best focal position based primarily on contrast comparisons. Hardware based methods rely on an external light beam (typically infrared) that is reflected off the coverslip and whose reflection is measured to determine and correct the focal offset of the sample.

Parameters:

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

`getMechanism()` ¶

Returns the value of the Mechanism attribute.

This field refers to the mechanism employed by this Focus Stabilization Device. Software (also referred to as Image) based methods rely on the acquisition of a Z-series of images followed by image analysis to determine the best focal position based primarily on contrast comparisons. Hardware based methods rely on an external light beam (typically infrared) that is reflected off the coverslip and whose reflection is measured to determine and correct the focal offset of the sample.

Returns:

Type	Description
`FocusStabilizationMechanism_Type`	The value of the attribute

`resetMechanism()` ¶

`hasMechanism()` ¶

Checks whether the optional Mechanism attribute is present.

This field refers to the mechanism employed by this Focus Stabilization Device. Software (also referred to as Image) based methods rely on the acquisition of a Z-series of images followed by image analysis to determine the best focal position based primarily on contrast comparisons. Hardware based methods rely on an external light beam (typically infrared) that is reflected off the coverslip and whose reflection is measured to determine and correct the focal offset of the sample.

Returns:

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

`setAlgorithm(value, validate=True)` ¶

Sets the value of the Algorithm attribute.

In case this Focus Stabilization Device is Software Based, this field refers to the name of the Algorithm used to maintain Focus.

Parameters:

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

`getAlgorithm()` ¶

Returns the value of the Algorithm attribute.

In case this Focus Stabilization Device is Software Based, this field refers to the name of the Algorithm used to maintain Focus.

Returns:

Type	Description
`string`	The value of the attribute

`resetAlgorithm()` ¶

`hasAlgorithm()` ¶

Checks whether the Algorithm attribute is present.

In case this Focus Stabilization Device is Software Based, this field refers to the name of the Algorithm used to maintain Focus.

Returns:

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

`getAlgorithmAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

In case this Focus Stabilization Device is Software Based, this field refers to the name of the Algorithm used to maintain Focus.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setTwoStep(value, validate=True)` ¶

Sets the value of the TwoStep attribute.

This field records whether this Focus Stabilization Device utilizes a 2-step progressive procedure (True) or not (False).

Parameters:

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

`getTwoStep()` ¶

Returns the value of the TwoStep attribute.

This field records whether this Focus Stabilization Device utilizes a 2-step progressive procedure (True) or not (False).

Returns:

Type	Description
`boolean`	The value of the attribute

`resetTwoStep()` ¶

`hasTwoStep()` ¶

Checks whether the TwoStep attribute is present.

This field records whether this Focus Stabilization Device utilizes a 2-step progressive procedure (True) or not (False).

Returns:

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

`setWavelength(value, validate=True)` ¶

Sets the value of the Wavelength attribute.

This field refers to the Wavelength of the beam that is relevant for this Focus Stabilization Device. For example this might represent the Wavelength of the beam that is reflected against the Coverglass to obtain a measurement of the focal offset of the sample at a given time during Acquisition.

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`

`getWavelength()` ¶

Returns the value of the Wavelength attribute.

This field refers to the Wavelength of the beam that is relevant for this Focus Stabilization Device. For example this might represent the Wavelength of the beam that is reflected against the Coverglass to obtain a measurement of the focal offset of the sample at a given time during Acquisition.

Returns:

Type	Description
`float`	The value of the attribute

`resetWavelength()` ¶

`hasWavelength()` ¶

Checks whether the Wavelength attribute is present.

This field refers to the Wavelength of the beam that is relevant for this Focus Stabilization Device. For example this might represent the Wavelength of the beam that is reflected against the Coverglass to obtain a measurement of the focal offset of the sample at a given time during Acquisition.

Returns:

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

`setAnnotationRef(value, validate=True)` ¶

Sets the value of the AnnotationRef element.

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

Parameters:

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

`getAnnotationRef()` ¶

Returns the value of the AnnotationRef element.

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

Returns:

Type	Description
`AnnotationRef`	The value of the element

`resetAnnotationRef()` ¶

`hasAnnotationRef()` ¶

Checks whether the optional AnnotationRef element is present.

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

Returns:

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

FocusStabilizationDevice¶

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

setName(value, validate=True) ¶

getName() ¶

resetName() ¶

hasName() ¶

setMechanism(value, validate=True) ¶

getMechanism() ¶

resetMechanism() ¶

hasMechanism() ¶

setAlgorithm(value, validate=True) ¶

getAlgorithm() ¶

resetAlgorithm() ¶

hasAlgorithm() ¶

getAlgorithmAllowedValues() staticmethod ¶

setTwoStep(value, validate=True) ¶

getTwoStep() ¶

resetTwoStep() ¶

hasTwoStep() ¶

setWavelength(value, validate=True) ¶

getWavelength() ¶

resetWavelength() ¶

hasWavelength() ¶

setAnnotationRef(value, validate=True) ¶

getAnnotationRef() ¶

resetAnnotationRef() ¶

hasAnnotationRef() ¶

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

`setName(value, validate=True)` ¶

`getName()` ¶

`resetName()` ¶

`hasName()` ¶

`setMechanism(value, validate=True)` ¶

`getMechanism()` ¶

`resetMechanism()` ¶

`hasMechanism()` ¶

`setAlgorithm(value, validate=True)` ¶

`getAlgorithm()` ¶

`resetAlgorithm()` ¶

`hasAlgorithm()` ¶

`getAlgorithmAllowedValues()` `staticmethod` ¶

`setTwoStep(value, validate=True)` ¶

`getTwoStep()` ¶

`resetTwoStep()` ¶

`hasTwoStep()` ¶

`setWavelength(value, validate=True)` ¶

`getWavelength()` ¶

`resetWavelength()` ¶

`hasWavelength()` ¶

`setAnnotationRef(value, validate=True)` ¶

`getAnnotationRef()` ¶

`resetAnnotationRef()` ¶

`hasAnnotationRef()` ¶