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.
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 Objective used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ObjectiveID_Type
|
The value to set |
required |
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()
Resets the ID attribute to an unset state.
This is the Unique Identifier of the Objective used in this case.
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)
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 |
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()
Resets the CorrectionCollarPosition attribute to an unset state.
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).
hasCorrectionCollarPosition()
Checks whether the optional 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 optional attribute has been set, false otherwise |
setNumericalApertureSetting(value)
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 |
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()
Resets the NumericalApertureSetting attribute to an unset state.
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.
hasNumericalApertureSetting()
Checks whether the optional 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 optional attribute has been set, false otherwise |
setMeasuredRefractiveIndex(value)
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 |
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()
Resets the MeasuredRefractiveIndex attribute to an unset state.
The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.
hasMeasuredRefractiveIndex()
Checks whether the optional 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 optional attribute has been set, false otherwise |
setTemperature(value)
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 |
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()
Resets the Temperature attribute to an unset state.
This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.
hasTemperature()
Checks whether the optional 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 optional attribute has been set, false otherwise |
setTemperatureUnit(value)
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 |
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()
Resets the TemperatureUnit attribute to an unset state.
No description available in the XSD standard.
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)
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 |
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()
Resets the IrisAperture attribute to an unset state.
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.
hasIrisAperture()
Checks whether the optional 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 optional attribute has been set, false otherwise |
setImmersionLiquid(value)
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 |
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()
Resets the ImmersionLiquid element to an unset state.
No description available in the XSD standard.
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 |