Inscoper::NBO::Lens_Type¶

Represents the XML complex type Lens. More...

#include <Lens_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::BeamCollimatorLens, Inscoper::NBO::BeamExpanderLens, Inscoper::NBO::CondenserLens, Inscoper::NBO::CouplingLens, Inscoper::NBO::GenericLens, Inscoper::NBO::MagnificationChanger, Inscoper::NBO::RelayLens, Inscoper::NBO::TubeLens

Public Functions¶

	Name
	Lens_Type()
	~Lens_Type()
virtual std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::LensID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LensID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setMagnification(const float & value, bool validate =true) Sets the value of the Magnification attribute.
float	getMagnification() const Returns the value of the Magnification attribute.
void	resetMagnification() Resets the Magnification attribute to an unset state.
bool	hasMagnification() const Checks whether the Magnification attribute is present.
void	setLensNA(const float & value, bool validate =true) Sets the value of the LensNA attribute.
float	getLensNA() const Returns the value of the LensNA attribute.
void	resetLensNA() Resets the LensNA attribute to an unset state.
bool	hasLensNA() const Checks whether the LensNA attribute is present.
void	setInfinity(const bool & value, bool validate =true) Sets the value of the Infinity attribute.
bool	getInfinity() const Returns the value of the Infinity attribute.
void	resetInfinity() Resets the Infinity attribute to an unset state.
bool	hasInfinity() const Checks whether the Infinity attribute is present.
void	setComposite(const bool & value, bool validate =true) Sets the value of the Composite attribute.
bool	getComposite() const Returns the value of the Composite attribute.
void	resetComposite() Resets the Composite attribute to an unset state.
bool	hasComposite() const Checks whether the Composite attribute is present.
void	setShape(const Inscoper::NBO::LensShapeType_TypePtr & value, bool validate =true) Sets the value of the Shape attribute.
LensShapeType_TypePtr	getShape() const Returns the value of the Shape attribute.
void	resetShape() Resets the Shape attribute to an unset state.
bool	hasShape() const Checks whether the optional Shape attribute is present.
void	setGeometry(const Inscoper::NBO::LensGeometry_TypePtr & value, bool validate =true) Sets the value of the Geometry attribute.
LensGeometry_TypePtr	getGeometry() const Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
bool	hasGeometry() const Checks whether the optional Geometry attribute is present.
void	setDiameter(const float & value, bool validate =true) Sets the value of the Diameter attribute.
float	getDiameter() const Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
bool	hasDiameter() const Checks whether the Diameter attribute is present.
void	setDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the DiameterUnit attribute.
UnitsLength_TypePtr	getDiameterUnit() const Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
bool	hasDiameterUnit() const Checks whether the optional DiameterUnit attribute is present.
void	setCoating(const std::string & value, bool validate =true) Sets the value of the Coating attribute.
std::string	getCoating() const Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
bool	hasCoating() const Checks whether the Coating attribute is present.
void	setAttenuationCoefficient(const float & value, bool validate =true) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() const Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
bool	hasAttenuationCoefficient() const Checks whether the AttenuationCoefficient attribute is present.
void	setWorkingDistance(const float & value, bool validate =true) Sets the value of the WorkingDistance attribute.
float	getWorkingDistance() const Returns the value of the WorkingDistance attribute.
void	resetWorkingDistance() Resets the WorkingDistance attribute to an unset state.
bool	hasWorkingDistance() const Checks whether the WorkingDistance attribute is present.
void	setWorkingDistanceUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the WorkingDistanceUnit attribute.
UnitsLength_TypePtr	getWorkingDistanceUnit() const Returns the value of the WorkingDistanceUnit attribute.
void	resetWorkingDistanceUnit() Resets the WorkingDistanceUnit attribute to an unset state.
bool	hasWorkingDistanceUnit() const Checks whether the optional WorkingDistanceUnit attribute is present.
void	setImageDistance(const float & value, bool validate =true) Sets the value of the ImageDistance attribute.
float	getImageDistance() const Returns the value of the ImageDistance attribute.
void	resetImageDistance() Resets the ImageDistance attribute to an unset state.
bool	hasImageDistance() const Checks whether the ImageDistance attribute is present.
void	setImageDistanceUnits(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ImageDistanceUnits attribute.
UnitsLength_TypePtr	getImageDistanceUnits() const Returns the value of the ImageDistanceUnits attribute.
void	resetImageDistanceUnits() Resets the ImageDistanceUnits attribute to an unset state.
bool	hasImageDistanceUnits() const Checks whether the optional ImageDistanceUnits attribute is present.
void	setFrontFocalLength(const float & value, bool validate =true) Sets the value of the FrontFocalLength attribute.
float	getFrontFocalLength() const Returns the value of the FrontFocalLength attribute.
void	resetFrontFocalLength() Resets the FrontFocalLength attribute to an unset state.
bool	hasFrontFocalLength() const Checks whether the FrontFocalLength attribute is present.
void	setFrontFocalLengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the FrontFocalLengthUnit attribute.
UnitsLength_TypePtr	getFrontFocalLengthUnit() const Returns the value of the FrontFocalLengthUnit attribute.
void	resetFrontFocalLengthUnit() Resets the FrontFocalLengthUnit attribute to an unset state.
bool	hasFrontFocalLengthUnit() const Checks whether the optional FrontFocalLengthUnit attribute is present.
void	setBackFocalLength(const float & value, bool validate =true) Sets the value of the BackFocalLength attribute.
float	getBackFocalLength() const Returns the value of the BackFocalLength attribute.
void	resetBackFocalLength() Resets the BackFocalLength attribute to an unset state.
bool	hasBackFocalLength() const Checks whether the BackFocalLength attribute is present.
void	setBackFocalLengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the BackFocalLengthUnit attribute.
UnitsLength_TypePtr	getBackFocalLengthUnit() const Returns the value of the BackFocalLengthUnit attribute.
void	resetBackFocalLengthUnit() Resets the BackFocalLengthUnit attribute to an unset state.
bool	hasBackFocalLengthUnit() const Checks whether the optional BackFocalLengthUnit attribute is present.
void	setRadiusOfCurvature(const float & value, bool validate =true) Sets the value of the RadiusOfCurvature attribute.
float	getRadiusOfCurvature() const Returns the value of the RadiusOfCurvature attribute.
void	resetRadiusOfCurvature() Resets the RadiusOfCurvature attribute to an unset state.
bool	hasRadiusOfCurvature() const Checks whether the RadiusOfCurvature attribute is present.
void	setRadiusOfCurvatureUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the RadiusOfCurvatureUnit attribute.
UnitsLength_TypePtr	getRadiusOfCurvatureUnit() const Returns the value of the RadiusOfCurvatureUnit attribute.
void	resetRadiusOfCurvatureUnit() Resets the RadiusOfCurvatureUnit attribute to an unset state.
bool	hasRadiusOfCurvatureUnit() const Checks whether the optional RadiusOfCurvatureUnit attribute is present.
void	setMaterialName(const Inscoper::NBO::OpticalMaterialName_TypePtr & value, bool validate =true) Sets the value of the MaterialName attribute.
OpticalMaterialName_TypePtr	getMaterialName() const Returns the value of the MaterialName attribute.
void	resetMaterialName() Resets the MaterialName attribute to an unset state.
bool	hasMaterialName() const Checks whether the optional MaterialName attribute is present.
void	setGlassCode(const std::string & value, bool validate =true) Sets the value of the GlassCode attribute.
std::string	getGlassCode() const Returns the value of the GlassCode attribute.
void	resetGlassCode() Resets the GlassCode attribute to an unset state.
bool	hasGlassCode() const Checks whether the GlassCode attribute is present.
void	setRefractiveIndex(const float & value, bool validate =true) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() const Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
bool	hasRefractiveIndex() const Checks whether the RefractiveIndex attribute is present.
void	setAbbeNumber(const float & value, bool validate =true) Sets the value of the AbbeNumber attribute.
float	getAbbeNumber() const Returns the value of the AbbeNumber attribute.
void	resetAbbeNumber() Resets the AbbeNumber attribute to an unset state.
bool	hasAbbeNumber() const Checks whether the AbbeNumber attribute is present.
void	setDensity(const float & value, bool validate =true) Sets the value of the Density attribute.
float	getDensity() const Returns the value of the Density attribute.
void	resetDensity() Resets the Density attribute to an unset state.
bool	hasDensity() const Checks whether the Density attribute is present.
void	setDensityUnit(const Inscoper::NBO::UnitsDensity_TypePtr & value, bool validate =true) Sets the value of the DensityUnit attribute.
UnitsDensity_TypePtr	getDensityUnit() const Returns the value of the DensityUnit attribute.
void	resetDensityUnit() Resets the DensityUnit attribute to an unset state.
bool	hasDensityUnit() const Checks whether the optional DensityUnit attribute is present.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< Lens_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Lens_Type.
const std::set< std::string > &	getCoatingAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Lens_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.

Public Functions Documentation¶

function Lens_Type¶

function ~Lens_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::BeamCollimatorLens::getTypeName, Inscoper::NBO::BeamExpanderLens::getTypeName, Inscoper::NBO::CondenserLens::getTypeName, Inscoper::NBO::CouplingLens::getTypeName, Inscoper::NBO::GenericLens::getTypeName, Inscoper::NBO::MagnificationChanger::getTypeName, Inscoper::NBO::RelayLens::getTypeName, Inscoper::NBO::TubeLens::getTypeName

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setID¶

void setID(
    const Inscoper::NBO::LensID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A User-defined Name for this component.

function getName¶

function resetName¶

function hasName¶

function setMagnification¶

void setMagnification(
    const float & value,
    bool validate =true
)

Sets the value of the Magnification attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the nominal Magnification provided by this Lens as specified by the Manufacturer.

function getMagnification¶

float getMagnification() const

Returns the value of the Magnification attribute.

Return: The value of the attribute

This field records the nominal Magnification provided by this Lens as specified by the Manufacturer.

function resetMagnification¶

function hasMagnification¶

bool hasMagnification() const

Checks whether the Magnification attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the nominal Magnification provided by this Lens as specified by the Manufacturer.

function setLensNA¶

void setLensNA(
    const float & value,
    bool validate =true
)

Sets the value of the LensNA attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getLensNA¶

float getLensNA() const

Returns the value of the LensNA attribute.

Return: The value of the 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.

function resetLensNA¶

void 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.

function hasLensNA¶

bool hasLensNA() const

Checks whether the LensNA attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setInfinity¶

void setInfinity(
    const bool & value,
    bool validate =true
)

Sets the value of the Infinity attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getInfinity¶

bool getInfinity() const

Returns the value of the Infinity attribute.

Return: The value of the 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.

function resetInfinity¶

void 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.

function hasInfinity¶

bool hasInfinity() const

Checks whether the Infinity attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setComposite¶

void setComposite(
    const bool & value,
    bool validate =true
)

Sets the value of the Composite attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).

function getComposite¶

bool getComposite() const

Returns the value of the Composite attribute.

Return: The value of the attribute

This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).

function resetComposite¶

function hasComposite¶

bool hasComposite() const

Checks whether the Composite attribute is present.

Return: true if the attribute has been set, false otherwise

This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).

function setShape¶

void setShape(
    const Inscoper::NBO::LensShapeType_TypePtr & value,
    bool validate =true
)

Sets the value of the Shape attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getShape¶

LensShapeType_TypePtr getShape() const

Returns the value of the Shape attribute.

Return: The value of the 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.

function resetShape¶

void 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.

function hasShape¶

bool hasShape() const

Checks whether the optional Shape attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setGeometry¶

void setGeometry(
    const Inscoper::NBO::LensGeometry_TypePtr & value,
    bool validate =true
)

Sets the value of the Geometry attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The geometrical shape of this lens' surface(s).

function getGeometry¶

function resetGeometry¶

function hasGeometry¶

bool hasGeometry() const

Checks whether the optional Geometry attribute is present.

Return: true if the optional attribute has been set, false otherwise

The geometrical shape of this lens' surface(s).

function setDiameter¶

void setDiameter(
    const float & value,
    bool validate =true
)

Sets the value of the Diameter attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the physical diameter of this Lens.

function getDiameter¶

function resetDiameter¶

function hasDiameter¶

function setDiameterUnit¶

void setDiameterUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the DiameterUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getDiameterUnit¶

function resetDiameterUnit¶

function hasDiameterUnit¶

bool hasDiameterUnit() const

Checks whether the optional DiameterUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setCoating¶

void setCoating(
    const std::string & value,
    bool validate =true
)

Sets the value of the Coating attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getCoating¶

std::string getCoating() const

Returns the value of the Coating attribute.

Return: The value of the 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.

function resetCoating¶

void 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.

function hasCoating¶

bool hasCoating() const

Checks whether the Coating attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setAttenuationCoefficient¶

void setAttenuationCoefficient(
    const float & value,
    bool validate =true
)

Sets the value of the AttenuationCoefficient attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function getAttenuationCoefficient¶

float getAttenuationCoefficient() const

Returns the value of the AttenuationCoefficient attribute.

Return: The value of the 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).

function resetAttenuationCoefficient¶

void 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).

function hasAttenuationCoefficient¶

bool hasAttenuationCoefficient() const

Checks whether the AttenuationCoefficient attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setWorkingDistance¶

void setWorkingDistance(
    const float & value,
    bool validate =true
)

Sets the value of the WorkingDistance attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getWorkingDistance¶

float getWorkingDistance() const

Returns the value of the WorkingDistance attribute.

Return: The value of the 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.

function resetWorkingDistance¶

void 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.

function hasWorkingDistance¶

bool hasWorkingDistance() const

Checks whether the WorkingDistance attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setWorkingDistanceUnit¶

void setWorkingDistanceUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the WorkingDistanceUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getWorkingDistanceUnit¶

UnitsLength_TypePtr getWorkingDistanceUnit() const

Returns the value of the WorkingDistanceUnit attribute.

Return: The value of the 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.

function resetWorkingDistanceUnit¶

void 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.

function hasWorkingDistanceUnit¶

bool hasWorkingDistanceUnit() const

Checks whether the optional WorkingDistanceUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setImageDistance¶

void setImageDistance(
    const float & value,
    bool validate =true
)

Sets the value of the ImageDistance attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function getImageDistance¶

float getImageDistance() const

Returns the value of the ImageDistance attribute.

Return: The value of the attribute

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

function resetImageDistance¶

function hasImageDistance¶

bool hasImageDistance() const

Checks whether the ImageDistance attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setImageDistanceUnits¶

void setImageDistanceUnits(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the ImageDistanceUnits attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getImageDistanceUnits¶

function resetImageDistanceUnits¶

function hasImageDistanceUnits¶

bool hasImageDistanceUnits() const

Checks whether the optional ImageDistanceUnits attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFrontFocalLength¶

void setFrontFocalLength(
    const float & value,
    bool validate =true
)

Sets the value of the FrontFocalLength attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function getFrontFocalLength¶

float getFrontFocalLength() const

Returns the value of the FrontFocalLength attribute.

Return: The value of the 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).

function resetFrontFocalLength¶

void 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).

function hasFrontFocalLength¶

bool hasFrontFocalLength() const

Checks whether the FrontFocalLength attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setFrontFocalLengthUnit¶

void setFrontFocalLengthUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the FrontFocalLengthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getFrontFocalLengthUnit¶

function resetFrontFocalLengthUnit¶

function hasFrontFocalLengthUnit¶

bool hasFrontFocalLengthUnit() const

Checks whether the optional FrontFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setBackFocalLength¶

void setBackFocalLength(
    const float & value,
    bool validate =true
)

Sets the value of the BackFocalLength attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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').

function getBackFocalLength¶

float getBackFocalLength() const

Returns the value of the BackFocalLength attribute.

Return: The value of the 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').

function resetBackFocalLength¶

void 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').

function hasBackFocalLength¶

bool hasBackFocalLength() const

Checks whether the BackFocalLength attribute is present.

Return: true if the attribute has been set, false otherwise

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').

function setBackFocalLengthUnit¶

void setBackFocalLengthUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the BackFocalLengthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getBackFocalLengthUnit¶

function resetBackFocalLengthUnit¶

function hasBackFocalLengthUnit¶

bool hasBackFocalLengthUnit() const

Checks whether the optional BackFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setRadiusOfCurvature¶

void setRadiusOfCurvature(
    const float & value,
    bool validate =true
)

Sets the value of the RadiusOfCurvature attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getRadiusOfCurvature¶

float getRadiusOfCurvature() const

Returns the value of the RadiusOfCurvature attribute.

Return: The value of the 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.

function resetRadiusOfCurvature¶

void 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.

function hasRadiusOfCurvature¶

bool hasRadiusOfCurvature() const

Checks whether the RadiusOfCurvature attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setRadiusOfCurvatureUnit¶

void setRadiusOfCurvatureUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the RadiusOfCurvatureUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getRadiusOfCurvatureUnit¶

function resetRadiusOfCurvatureUnit¶

function hasRadiusOfCurvatureUnit¶

bool hasRadiusOfCurvatureUnit() const

Checks whether the optional RadiusOfCurvatureUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMaterialName¶

void setMaterialName(
    const Inscoper::NBO::OpticalMaterialName_TypePtr & value,
    bool validate =true
)

Sets the value of the MaterialName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the chemical composition or designation of the Material this Lens is made of.

function getMaterialName¶

OpticalMaterialName_TypePtr getMaterialName() const

Returns the value of the MaterialName attribute.

Return: The value of the attribute

This field records the chemical composition or designation of the Material this Lens is made of.

function resetMaterialName¶

function hasMaterialName¶

bool hasMaterialName() const

Checks whether the optional MaterialName attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the chemical composition or designation of the Material this Lens is made of.

function setGlassCode¶

void setGlassCode(
    const std::string & value,
    bool validate =true
)

Sets the value of the GlassCode attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getGlassCode¶

std::string getGlassCode() const

Returns the value of the GlassCode attribute.

Return: The value of the 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.

function resetGlassCode¶

void 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.

function hasGlassCode¶

bool hasGlassCode() const

Checks whether the GlassCode attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setRefractiveIndex¶

void setRefractiveIndex(
    const float & value,
    bool validate =true
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getRefractiveIndex¶

float getRefractiveIndex() const

Returns the value of the RefractiveIndex attribute.

Return: The value of the 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.

function resetRefractiveIndex¶

void 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.

function hasRefractiveIndex¶

bool hasRefractiveIndex() const

Checks whether the RefractiveIndex attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setAbbeNumber¶

void setAbbeNumber(
    const float & value,
    bool validate =true
)

Sets the value of the AbbeNumber attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getAbbeNumber¶

float getAbbeNumber() const

Returns the value of the AbbeNumber attribute.

Return: The value of the 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.

function resetAbbeNumber¶

void 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.

function hasAbbeNumber¶

bool hasAbbeNumber() const

Checks whether the AbbeNumber attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setDensity¶

void setDensity(
    const float & value,
    bool validate =true
)

Sets the value of the Density attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Density of the material this Lens is made of.

function getDensity¶

function resetDensity¶

function hasDensity¶

bool hasDensity() const

Checks whether the Density attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the Density of the material this Lens is made of.

function setDensityUnit¶

void setDensityUnit(
    const Inscoper::NBO::UnitsDensity_TypePtr & value,
    bool validate =true
)

Sets the value of the DensityUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getDensityUnit¶

function resetDensityUnit¶

function hasDensityUnit¶

bool hasDensityUnit() const

Checks whether the optional DensityUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function fromBase¶

static std::shared_ptr< Lens_Type > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Lens_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getCoatingAllowedValues¶

static const std::set< std::string > & getCoatingAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

function getGlassCodeAllowedValues¶

static const std::set< std::string > & getGlassCodeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

Updated on 2026-09-23 at 16:50:38 +0200