ObjectiveSettings¶

Bases: Settings_Type

Represents the XML element ObjectiveSettings.

This element holds the Setting applied to the Objective used during the Acquisition of this Image as well as a reference (the ID attribute) to the Objective in question.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a ObjectiveSettings.

Parameters:

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

Returns:

Type	Description
`ObjectiveSettings`	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 Objective used in this case.

Parameters:

Name	Type	Description	Default
`value`	`ObjectiveID_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 Objective used in this case.

Returns:

Type	Description
`ObjectiveID_Type`	The value of the attribute

`resetID()` ¶

`hasID()` ¶

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the Objective used in this case.

Returns:

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

`setCorrectionCollarPosition(value, validate=True)` ¶

Sets the value of the CorrectionCollarPosition attribute.

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

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`

`getCorrectionCollarPosition()` ¶

Returns the value of the CorrectionCollarPosition attribute.

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

Returns:

Type	Description
`string`	The value of the attribute

`resetCorrectionCollarPosition()` ¶

`hasCorrectionCollarPosition()` ¶

Checks whether the CorrectionCollarPosition attribute is present.

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

Returns:

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

`getCorrectionCollarPositionAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

Returns:

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

`setNumericalApertureSetting(value, validate=True)` ¶

Sets the value of the NumericalApertureSetting attribute.

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

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`

`getNumericalApertureSetting()` ¶

Returns the value of the NumericalApertureSetting attribute.

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

Returns:

Type	Description
`string`	The value of the attribute

`resetNumericalApertureSetting()` ¶

`hasNumericalApertureSetting()` ¶

Checks whether the NumericalApertureSetting attribute is present.

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

Returns:

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

`getNumericalApertureSettingAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

Returns:

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

`setMeasuredRefractiveIndex(value, validate=True)` ¶

Sets the value of the MeasuredRefractiveIndex attribute.

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

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`

`getMeasuredRefractiveIndex()` ¶

Returns the value of the MeasuredRefractiveIndex attribute.

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

Returns:

Type	Description
`float`	The value of the attribute

`resetMeasuredRefractiveIndex()` ¶

`hasMeasuredRefractiveIndex()` ¶

Checks whether the MeasuredRefractiveIndex attribute is present.

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

Returns:

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

`setTemperature(value, validate=True)` ¶

Sets the value of the Temperature attribute.

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

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`

`getTemperature()` ¶

Returns the value of the Temperature attribute.

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

Returns:

Type	Description
`float`	The value of the attribute

`resetTemperature()` ¶

`hasTemperature()` ¶

Checks whether the Temperature attribute is present.

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

Returns:

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

`setTemperatureUnit(value, validate=True)` ¶

Sets the value of the TemperatureUnit attribute.

No description available in the XSD standard.

Parameters:

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

`getTemperatureUnit()` ¶

Returns the value of the TemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsTemperature_Type`	The value of the attribute

`resetTemperatureUnit()` ¶

`hasTemperatureUnit()` ¶

Checks whether the optional TemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

`setIrisAperture(value, validate=True)` ¶

Sets the value of the IrisAperture attribute.

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

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`

`getIrisAperture()` ¶

Returns the value of the IrisAperture attribute.

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

Returns:

Type	Description
`float`	The value of the attribute

`resetIrisAperture()` ¶

`hasIrisAperture()` ¶

Checks whether the IrisAperture attribute is present.

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

Returns:

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

`setImmersionLiquid(value, validate=True)` ¶

Sets the value of the ImmersionLiquid element.

No description available in the XSD standard.

Parameters:

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

`getImmersionLiquid()` ¶

Returns the value of the ImmersionLiquid element.

No description available in the XSD standard.

Returns:

Type	Description
`ImmersionLiquid`	The value of the element

`resetImmersionLiquid()` ¶

`hasImmersionLiquid()` ¶

Checks whether the optional ImmersionLiquid element is present.

No description available in the XSD standard.

Returns:

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

ObjectiveSettings¶

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

setCorrectionCollarPosition(value, validate=True) ¶

getCorrectionCollarPosition() ¶

resetCorrectionCollarPosition() ¶

hasCorrectionCollarPosition() ¶

getCorrectionCollarPositionAllowedValues() staticmethod ¶

setNumericalApertureSetting(value, validate=True) ¶

getNumericalApertureSetting() ¶

resetNumericalApertureSetting() ¶

hasNumericalApertureSetting() ¶

getNumericalApertureSettingAllowedValues() staticmethod ¶

setMeasuredRefractiveIndex(value, validate=True) ¶

getMeasuredRefractiveIndex() ¶

resetMeasuredRefractiveIndex() ¶

hasMeasuredRefractiveIndex() ¶

setTemperature(value, validate=True) ¶

getTemperature() ¶

resetTemperature() ¶

hasTemperature() ¶

setTemperatureUnit(value, validate=True) ¶

getTemperatureUnit() ¶

resetTemperatureUnit() ¶

hasTemperatureUnit() ¶

setIrisAperture(value, validate=True) ¶

getIrisAperture() ¶

resetIrisAperture() ¶

hasIrisAperture() ¶

setImmersionLiquid(value, validate=True) ¶

getImmersionLiquid() ¶

resetImmersionLiquid() ¶

hasImmersionLiquid() ¶

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

`setCorrectionCollarPosition(value, validate=True)` ¶

`getCorrectionCollarPosition()` ¶

`resetCorrectionCollarPosition()` ¶

`hasCorrectionCollarPosition()` ¶

`getCorrectionCollarPositionAllowedValues()` `staticmethod` ¶

`setNumericalApertureSetting(value, validate=True)` ¶

`getNumericalApertureSetting()` ¶

`resetNumericalApertureSetting()` ¶

`hasNumericalApertureSetting()` ¶

`getNumericalApertureSettingAllowedValues()` `staticmethod` ¶

`setMeasuredRefractiveIndex(value, validate=True)` ¶

`getMeasuredRefractiveIndex()` ¶

`resetMeasuredRefractiveIndex()` ¶

`hasMeasuredRefractiveIndex()` ¶

`setTemperature(value, validate=True)` ¶

`getTemperature()` ¶

`resetTemperature()` ¶

`hasTemperature()` ¶

`setTemperatureUnit(value, validate=True)` ¶

`getTemperatureUnit()` ¶

`resetTemperatureUnit()` ¶

`hasTemperatureUnit()` ¶

`setIrisAperture(value, validate=True)` ¶

`getIrisAperture()` ¶

`resetIrisAperture()` ¶

`hasIrisAperture()` ¶

`setImmersionLiquid(value, validate=True)` ¶

`getImmersionLiquid()` ¶

`resetImmersionLiquid()` ¶

`hasImmersionLiquid()` ¶