Bases: ManufacturerSpec_Type
Represents the XML complex type Lens.
This element describes additional lenses positioned in the Light Path for one or more Channels available for this Instrument. A Lens is a component of glass or transparent plastic material, usually circular, with two primary surfaces that are ground and polished in a specific manner designed to produce either a convergence or divergence of light passing through the material. An Instrument may have several Lenses with different functions, such as a Magnification Changer (also known as Optovar), a Coupling Lens connecting the Light Source with the Microscope Stand, a Relay Lens positioned at the Detector mount, or additional Lenses placed in the Light Path for various purposes. This element can be associated with an optional Optics Turret.
fromBase ( base )
staticmethod
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 )
setName ( value , validate = True )
setMagnification ( value , validate = True )
setLensNA ( value , validate = True )
Sets the value of the LensNA attribute.
This field captures the Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. 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
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 Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. 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 Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. 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 Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. 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
setInfinity ( value , validate = True )
Sets the value of the Infinity attribute.
This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getInfinity ()
Returns the value of the Infinity attribute.
This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.
Returns:
Type
Description
boolean
The value of the attribute
resetInfinity ()
Resets the Infinity attribute to an unset state.
This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.
hasInfinity ()
Checks whether the Infinity attribute is present.
This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setComposite ( value , validate = True )
Sets the value of the Composite attribute.
This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getComposite ()
Returns the value of the Composite attribute.
This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).
Returns:
Type
Description
boolean
The value of the attribute
resetComposite ()
Resets the Composite attribute to an unset state.
This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).
hasComposite ()
Checks whether the Composite attribute is present.
This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setShape ( value , validate = True )
Sets the value of the Shape attribute.
This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.
Parameters:
Name
Type
Description
Default
value
LensShapeType_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getShape ()
Returns the value of the Shape attribute.
This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.
Returns:
Type
Description
LensShapeType_Type
The value of the attribute
resetShape ()
Resets the Shape attribute to an unset state.
This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.
hasShape ()
Checks whether the optional Shape attribute is present.
This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setGeometry ( value , validate = True )
setDiameter ( value , validate = True )
setDiameterUnit ( value , validate = True )
setCoating ( value , validate = True )
Sets the value of the Coating attribute.
An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getCoating ()
Returns the value of the Coating attribute.
An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.
Returns:
Type
Description
string
The value of the attribute
resetCoating ()
Resets the Coating attribute to an unset state.
An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.
hasCoating ()
Checks whether the Coating attribute is present.
An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getCoatingAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setAttenuationCoefficient ( value , validate = True )
Sets the value of the AttenuationCoefficient attribute.
This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getAttenuationCoefficient ()
Returns the value of the AttenuationCoefficient attribute.
This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).
Returns:
Type
Description
float
The value of the attribute
resetAttenuationCoefficient ()
Resets the AttenuationCoefficient attribute to an unset state.
This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).
hasAttenuationCoefficient ()
Checks whether the AttenuationCoefficient attribute is present.
This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).
Returns:
Type
Description
boolean
true if the 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 Lens 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
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 Lens 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 Lens 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 Lens 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.
This field reports the Working Distance of this Lens 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
UnitsLength_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getWorkingDistanceUnit ()
Returns the value of the WorkingDistanceUnit attribute.
This field reports the Working Distance of this Lens 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
UnitsLength_Type
The value of the attribute
resetWorkingDistanceUnit ()
Resets the WorkingDistanceUnit attribute to an unset state.
This field reports the Working Distance of this Lens 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.
hasWorkingDistanceUnit ()
Checks whether the optional WorkingDistanceUnit attribute is present.
This field reports the Working Distance of this Lens 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 optional attribute has been set, false otherwise
setImageDistance ( value , validate = True )
setImageDistanceUnits ( value , validate = True )
resetImageDistanceUnits ()
setFrontFocalLength ( value , validate = True )
setFrontFocalLengthUnit ( value , validate = True )
getFrontFocalLengthUnit ()
resetFrontFocalLengthUnit ()
hasFrontFocalLengthUnit ()
setBackFocalLength ( value , validate = True )
setBackFocalLengthUnit ( value , validate = True )
resetBackFocalLengthUnit ()
setRadiusOfCurvature ( value , validate = True )
Sets the value of the RadiusOfCurvature attribute.
This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getRadiusOfCurvature ()
Returns the value of the RadiusOfCurvature attribute.
This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.
Returns:
Type
Description
float
The value of the attribute
resetRadiusOfCurvature ()
Resets the RadiusOfCurvature attribute to an unset state.
This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.
hasRadiusOfCurvature ()
Checks whether the RadiusOfCurvature attribute is present.
This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setRadiusOfCurvatureUnit ( value , validate = True )
getRadiusOfCurvatureUnit ()
resetRadiusOfCurvatureUnit ()
hasRadiusOfCurvatureUnit ()
setMaterialName ( value , validate = True )
setGlassCode ( value , validate = True )
Sets the value of the GlassCode attribute.
If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getGlassCode ()
Returns the value of the GlassCode attribute.
If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Returns:
Type
Description
string
The value of the attribute
resetGlassCode ()
Resets the GlassCode attribute to an unset state.
If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
hasGlassCode ()
Checks whether the GlassCode attribute is present.
If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getGlassCodeAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setRefractiveIndex ( value , validate = True )
Sets the value of the RefractiveIndex attribute.
This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getRefractiveIndex ()
Returns the value of the RefractiveIndex attribute.
This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.
Returns:
Type
Description
float
The value of the attribute
resetRefractiveIndex ()
Resets the RefractiveIndex attribute to an unset state.
This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.
hasRefractiveIndex ()
Checks whether the RefractiveIndex attribute is present.
This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setAbbeNumber ( value , validate = True )
Sets the value of the AbbeNumber attribute.
This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getAbbeNumber ()
Returns the value of the AbbeNumber attribute.
This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.
Returns:
Type
Description
float
The value of the attribute
resetAbbeNumber ()
Resets the AbbeNumber attribute to an unset state.
This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.
hasAbbeNumber ()
Checks whether the AbbeNumber attribute is present.
This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setDensity ( value , validate = True )
setDensityUnit ( value , validate = True )
setAnnotationRef ( value , validate = True )