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.

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

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

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

setMechanism(value)

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

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

Resets the Mechanism attribute to an unset state.

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.

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)

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

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

Resets the Algorithm attribute to an unset state.

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

hasAlgorithm()

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

setTwoStep(value)

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

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

Resets the TwoStep attribute to an unset state.

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

hasTwoStep()

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

setWavelength(value)

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

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

Resets the Wavelength attribute to an unset state.

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.

hasWavelength()

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

setAnnotationRef(value)

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

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

Resets the AnnotationRef element to an unset state.

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

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