Objective

Bases: ManufacturerSpec_Type

Represents the XML element Objective.

The Microscope's Objective lens consists of a lens, its mount, and any associated parts. It is the part of the imaging system, which forms a primary image of the object, either alone or in conjunction with a tube lens. The Objective typically consists of a compound lens consisting of along a common axis.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

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

Returns:

Type	Description
Objective	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	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.

A Unique Identifier for this component.

Returns:

Type	Description
ObjectiveID_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, 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()

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

setMagnification(value, validate=True)

Sets the value of the Magnification attribute.

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

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

getMagnification()

Returns the value of the Magnification attribute.

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

Returns:

Type	Description
float	The value of the attribute

resetMagnification()

Resets the Magnification attribute to an unset state.

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

hasMagnification()

Checks whether the Magnification attribute is present.

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

Returns:

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

setLensNA(value, validate=True)

Sets the value of the LensNA attribute.

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

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

getLensNA()

Returns the value of the LensNA attribute.

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

Returns:

Type	Description
float	The value of the attribute

resetLensNA()

Resets the LensNA attribute to an unset state.

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

hasLensNA()

Checks whether the LensNA attribute is present.

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

Returns:

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

setCorrection(value, validate=True)

Sets the value of the Correction attribute.

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

Parameters:

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

getCorrection()

Returns the value of the Correction attribute.

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

Returns:

Type	Description
ObjectiveCorrection_Type	The value of the attribute

resetCorrection()

Resets the Correction attribute to an unset state.

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

hasCorrection()

Checks whether the optional Correction attribute is present.

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

Returns:

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

setImmersionType(value, validate=True)

Sets the value of the ImmersionType attribute.

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

Parameters:

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

getImmersionType()

Returns the value of the ImmersionType attribute.

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

Returns:

Type	Description
ImmersionTypeList_Type	The value of the attribute

resetImmersionType()

Resets the ImmersionType attribute to an unset state.

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

hasImmersionType()

Checks whether the optional ImmersionType attribute is present.

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

Returns:

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

setInfinityCorrected(value, validate=True)

Sets the value of the InfinityCorrected attribute.

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

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

getInfinityCorrected()

Returns the value of the InfinityCorrected attribute.

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

Returns:

Type	Description
boolean	The value of the attribute

resetInfinityCorrected()

Resets the InfinityCorrected attribute to an unset state.

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

hasInfinityCorrected()

Checks whether the InfinityCorrected attribute is present.

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

Returns:

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

setContrastModulation(value, validate=True)

Sets the value of the ContrastModulation attribute.

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

Parameters:

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

getContrastModulation()

Returns the value of the ContrastModulation attribute.

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

Returns:

Type	Description
ContrastModulationPlate_Type	The value of the attribute

resetContrastModulation()

Resets the ContrastModulation attribute to an unset state.

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

hasContrastModulation()

Checks whether the optional ContrastModulation attribute is present.

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

Returns:

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

setDIC(value, validate=True)

Sets the value of the DIC attribute.

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

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

getDIC()

Returns the value of the DIC attribute.

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

Returns:

Type	Description
boolean	The value of the attribute

resetDIC()

Resets the DIC attribute to an unset state.

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

hasDIC()

Checks whether the DIC attribute is present.

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

Returns:

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

setLightType(value, validate=True)

Sets the value of the LightType attribute.

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

Parameters:

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

getLightType()

Returns the value of the LightType attribute.

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

Returns:

Type	Description
ObjectiveLightType_Type	The value of the attribute

resetLightType()

Resets the LightType attribute to an unset state.

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

hasLightType()

Checks whether the optional LightType attribute is present.

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

Returns:

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

setDippingMedium(value, validate=True)

Sets the value of the DippingMedium attribute.

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

Parameters:

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

getDippingMedium()

Returns the value of the DippingMedium attribute.

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

Returns:

Type	Description
DippingType_Type	The value of the attribute

resetDippingMedium()

Resets the DippingMedium attribute to an unset state.

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

hasDippingMedium()

Checks whether the optional DippingMedium attribute is present.

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

Returns:

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

setWorkingDistance(value, validate=True)

Sets the value of the WorkingDistance attribute.

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

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

getWorkingDistance()

Returns the value of the WorkingDistance attribute.

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

Type	Description
float	The value of the attribute

resetWorkingDistance()

Resets the WorkingDistance attribute to an unset state.

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

hasWorkingDistance()

Checks whether the WorkingDistance attribute is present.

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

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

setWorkingDistanceUnit(value, validate=True)

Sets the value of the WorkingDistanceUnit 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

getWorkingDistanceUnit()

Returns the value of the WorkingDistanceUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetWorkingDistanceUnit()

Resets the WorkingDistanceUnit attribute to an unset state.

No description available in the XSD standard.

hasWorkingDistanceUnit()

Checks whether the optional WorkingDistanceUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setCorrectionCollar(value, validate=True)

Sets the value of the CorrectionCollar attribute.

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

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

getCorrectionCollar()

Returns the value of the CorrectionCollar attribute.

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

Returns:

Type	Description
boolean	The value of the attribute

resetCorrectionCollar()

Resets the CorrectionCollar attribute to an unset state.

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

hasCorrectionCollar()

Checks whether the CorrectionCollar attribute is present.

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

Returns:

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

setCorrectionCollarType(value, validate=True)

Sets the value of the CorrectionCollarType attribute.

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

Parameters:

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

getCorrectionCollarType()

Returns the value of the CorrectionCollarType attribute.

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

Returns:

Type	Description
CorrectionCollarTypeList_Type	The value of the attribute

resetCorrectionCollarType()

Resets the CorrectionCollarType attribute to an unset state.

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

hasCorrectionCollarType()

Checks whether the optional CorrectionCollarType attribute is present.

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

Returns:

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

setPhaseContrastDesignation(value, validate=True)

Sets the value of the PhaseContrastDesignation attribute.

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

Parameters:

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

getPhaseContrastDesignation()

Returns the value of the PhaseContrastDesignation attribute.

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

Returns:

Type	Description
PhaseContrastDesignationType_Type	The value of the attribute

resetPhaseContrastDesignation()

Resets the PhaseContrastDesignation attribute to an unset state.

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

hasPhaseContrastDesignation()

Checks whether the optional PhaseContrastDesignation attribute is present.

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

Returns:

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

setCalibratedMagnification(value, validate=True)

Sets the value of the CalibratedMagnification attribute.

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

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

getCalibratedMagnification()

Returns the value of the CalibratedMagnification attribute.

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

Returns:

Type	Description
float	The value of the attribute

resetCalibratedMagnification()

Resets the CalibratedMagnification attribute to an unset state.

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

hasCalibratedMagnification()

Checks whether the CalibratedMagnification attribute is present.

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

Returns:

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

setIris(value, validate=True)

Sets the value of the Iris attribute.

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

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

getIris()

Returns the value of the Iris attribute.

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

Returns:

Type	Description
boolean	The value of the attribute

resetIris()

Resets the Iris attribute to an unset state.

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

hasIris()

Checks whether the Iris attribute is present.

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

Returns:

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

setObjectiveViewField(value, validate=True)

Sets the value of the ObjectiveViewField attribute.

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

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

getObjectiveViewField()

Returns the value of the ObjectiveViewField attribute.

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

Returns:

Type	Description
float	The value of the attribute

resetObjectiveViewField()

Resets the ObjectiveViewField attribute to an unset state.

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

hasObjectiveViewField()

Checks whether the ObjectiveViewField attribute is present.

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

Returns:

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

setImageDistance(value, validate=True)

Sets the value of the ImageDistance attribute.

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

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

getImageDistance()

Returns the value of the ImageDistance attribute.

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

Returns:

Type	Description
float	The value of the attribute

resetImageDistance()

Resets the ImageDistance attribute to an unset state.

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

hasImageDistance()

Checks whether the ImageDistance attribute is present.

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

Returns:

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

setImageDistanceUnit(value, validate=True)

Sets the value of the ImageDistanceUnit 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

getImageDistanceUnit()

Returns the value of the ImageDistanceUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetImageDistanceUnit()

Resets the ImageDistanceUnit attribute to an unset state.

No description available in the XSD standard.

hasImageDistanceUnit()

Checks whether the optional ImageDistanceUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setFrontFocalLength(value, validate=True)

Sets the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

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

getFrontFocalLength()

Returns the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

Returns:

Type	Description
float	The value of the attribute

resetFrontFocalLength()

Resets the FrontFocalLength attribute to an unset state.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

hasFrontFocalLength()

Checks whether the FrontFocalLength attribute is present.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

Returns:

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

setFrontFocalLengthUnit(value, validate=True)

Sets the value of the FrontFocalLengthUnit 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

getFrontFocalLengthUnit()

Returns the value of the FrontFocalLengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetFrontFocalLengthUnit()

Resets the FrontFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

hasFrontFocalLengthUnit()

Checks whether the optional FrontFocalLengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setBackFocalLength(value, validate=True)

Sets the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

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

getBackFocalLength()

Returns the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

Returns:

Type	Description
float	The value of the attribute

resetBackFocalLength()

Resets the BackFocalLength attribute to an unset state.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

hasBackFocalLength()

Checks whether the BackFocalLength attribute is present.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

Returns:

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

setBackFocalLengthUnit(value, validate=True)

Sets the value of the BackFocalLengthUnit 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

getBackFocalLengthUnit()

Returns the value of the BackFocalLengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetBackFocalLengthUnit()

Resets the BackFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

hasBackFocalLengthUnit()

Checks whether the optional BackFocalLengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setParfocalizingDistance(value, validate=True)

Sets the value of the ParfocalizingDistance attribute.

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

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

getParfocalizingDistance()

Returns the value of the ParfocalizingDistance attribute.

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

Returns:

Type	Description
float	The value of the attribute

resetParfocalizingDistance()

Resets the ParfocalizingDistance attribute to an unset state.

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

hasParfocalizingDistance()

Checks whether the ParfocalizingDistance attribute is present.

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

Returns:

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

setParfocalizingDistanceUnit(value, validate=True)

Sets the value of the ParfocalizingDistanceUnit 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

getParfocalizingDistanceUnit()

Returns the value of the ParfocalizingDistanceUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetParfocalizingDistanceUnit()

Resets the ParfocalizingDistanceUnit attribute to an unset state.

No description available in the XSD standard.

hasParfocalizingDistanceUnit()

Checks whether the optional ParfocalizingDistanceUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional 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()

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