Inscoper::NBO::Objective¶

Represents the XML element Objective. More...

#include <Objective.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	Objective()
	~Objective()
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::ObjectiveID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ObjectiveID_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	setCorrection(const Inscoper::NBO::ObjectiveCorrection_TypePtr & value, bool validate =true) Sets the value of the Correction attribute.
ObjectiveCorrection_TypePtr	getCorrection() const Returns the value of the Correction attribute.
void	resetCorrection() Resets the Correction attribute to an unset state.
bool	hasCorrection() const Checks whether the optional Correction attribute is present.
void	setImmersionType(const Inscoper::NBO::ImmersionTypeList_TypePtr & value, bool validate =true) Sets the value of the ImmersionType attribute.
ImmersionTypeList_TypePtr	getImmersionType() const Returns the value of the ImmersionType attribute.
void	resetImmersionType() Resets the ImmersionType attribute to an unset state.
bool	hasImmersionType() const Checks whether the optional ImmersionType attribute is present.
void	setInfinityCorrected(const bool & value, bool validate =true) Sets the value of the InfinityCorrected attribute.
bool	getInfinityCorrected() const Returns the value of the InfinityCorrected attribute.
void	resetInfinityCorrected() Resets the InfinityCorrected attribute to an unset state.
bool	hasInfinityCorrected() const Checks whether the InfinityCorrected attribute is present.
void	setContrastModulation(const Inscoper::NBO::ContrastModulationPlate_TypePtr & value, bool validate =true) Sets the value of the ContrastModulation attribute.
ContrastModulationPlate_TypePtr	getContrastModulation() const Returns the value of the ContrastModulation attribute.
void	resetContrastModulation() Resets the ContrastModulation attribute to an unset state.
bool	hasContrastModulation() const Checks whether the optional ContrastModulation attribute is present.
void	setDIC(const bool & value, bool validate =true) Sets the value of the DIC attribute.
bool	getDIC() const Returns the value of the DIC attribute.
void	resetDIC() Resets the DIC attribute to an unset state.
bool	hasDIC() const Checks whether the DIC attribute is present.
void	setLightType(const Inscoper::NBO::ObjectiveLightType_TypePtr & value, bool validate =true) Sets the value of the LightType attribute.
ObjectiveLightType_TypePtr	getLightType() const Returns the value of the LightType attribute.
void	resetLightType() Resets the LightType attribute to an unset state.
bool	hasLightType() const Checks whether the optional LightType attribute is present.
void	setDippingMedium(const Inscoper::NBO::DippingType_TypePtr & value, bool validate =true) Sets the value of the DippingMedium attribute.
DippingType_TypePtr	getDippingMedium() const Returns the value of the DippingMedium attribute.
void	resetDippingMedium() Resets the DippingMedium attribute to an unset state.
bool	hasDippingMedium() const Checks whether the optional DippingMedium 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	setCorrectionCollar(const bool & value, bool validate =true) Sets the value of the CorrectionCollar attribute.
bool	getCorrectionCollar() const Returns the value of the CorrectionCollar attribute.
void	resetCorrectionCollar() Resets the CorrectionCollar attribute to an unset state.
bool	hasCorrectionCollar() const Checks whether the CorrectionCollar attribute is present.
void	setCorrectionCollarType(const Inscoper::NBO::CorrectionCollarTypeList_TypePtr & value, bool validate =true) Sets the value of the CorrectionCollarType attribute.
CorrectionCollarTypeList_TypePtr	getCorrectionCollarType() const Returns the value of the CorrectionCollarType attribute.
void	resetCorrectionCollarType() Resets the CorrectionCollarType attribute to an unset state.
bool	hasCorrectionCollarType() const Checks whether the optional CorrectionCollarType attribute is present.
void	setPhaseContrastDesignation(const Inscoper::NBO::PhaseContrastDesignationType_TypePtr & value, bool validate =true) Sets the value of the PhaseContrastDesignation attribute.
PhaseContrastDesignationType_TypePtr	getPhaseContrastDesignation() const Returns the value of the PhaseContrastDesignation attribute.
void	resetPhaseContrastDesignation() Resets the PhaseContrastDesignation attribute to an unset state.
bool	hasPhaseContrastDesignation() const Checks whether the optional PhaseContrastDesignation attribute is present.
void	setCalibratedMagnification(const float & value, bool validate =true) Sets the value of the CalibratedMagnification attribute.
float	getCalibratedMagnification() const Returns the value of the CalibratedMagnification attribute.
void	resetCalibratedMagnification() Resets the CalibratedMagnification attribute to an unset state.
bool	hasCalibratedMagnification() const Checks whether the CalibratedMagnification attribute is present.
void	setIris(const bool & value, bool validate =true) Sets the value of the Iris attribute.
bool	getIris() const Returns the value of the Iris attribute.
void	resetIris() Resets the Iris attribute to an unset state.
bool	hasIris() const Checks whether the Iris attribute is present.
void	setObjectiveViewField(const float & value, bool validate =true) Sets the value of the ObjectiveViewField attribute.
float	getObjectiveViewField() const Returns the value of the ObjectiveViewField attribute.
void	resetObjectiveViewField() Resets the ObjectiveViewField attribute to an unset state.
bool	hasObjectiveViewField() const Checks whether the ObjectiveViewField 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	setImageDistanceUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ImageDistanceUnit attribute.
UnitsLength_TypePtr	getImageDistanceUnit() const Returns the value of the ImageDistanceUnit attribute.
void	resetImageDistanceUnit() Resets the ImageDistanceUnit attribute to an unset state.
bool	hasImageDistanceUnit() const Checks whether the optional ImageDistanceUnit 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	setParfocalizingDistance(const float & value, bool validate =true) Sets the value of the ParfocalizingDistance attribute.
float	getParfocalizingDistance() const Returns the value of the ParfocalizingDistance attribute.
void	resetParfocalizingDistance() Resets the ParfocalizingDistance attribute to an unset state.
bool	hasParfocalizingDistance() const Checks whether the ParfocalizingDistance attribute is present.
void	setParfocalizingDistanceUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ParfocalizingDistanceUnit attribute.
UnitsLength_TypePtr	getParfocalizingDistanceUnit() const Returns the value of the ParfocalizingDistanceUnit attribute.
void	resetParfocalizingDistanceUnit() Resets the ParfocalizingDistanceUnit attribute to an unset state.
bool	hasParfocalizingDistanceUnit() const Checks whether the optional ParfocalizingDistanceUnit 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< Objective >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Objective.

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::Objective;

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.

Public Functions Documentation¶

function Objective¶

function ~Objective¶

function 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::ObjectiveID_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 captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

function getMagnification¶

float getMagnification() const

Returns the value of the Magnification attribute.

Return: The value of the attribute

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

function resetMagnification¶

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

function hasMagnification¶

bool hasMagnification() const

Checks whether the Magnification attribute is present.

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

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

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

function getLensNA¶

float getLensNA() const

Returns the value of the LensNA attribute.

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

function resetLensNA¶

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

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

function setCorrection¶

void setCorrection(
    const Inscoper::NBO::ObjectiveCorrection_TypePtr & value,
    bool validate =true
)

Sets the value of the Correction attribute.

Parameters:

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

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

function getCorrection¶

ObjectiveCorrection_TypePtr getCorrection() const

Returns the value of the Correction attribute.

Return: The value of the attribute

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

function resetCorrection¶

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

function hasCorrection¶

bool hasCorrection() const

Checks whether the optional Correction attribute is present.

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

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

function setImmersionType¶

void setImmersionType(
    const Inscoper::NBO::ImmersionTypeList_TypePtr & value,
    bool validate =true
)

Sets the value of the ImmersionType attribute.

Parameters:

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

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.

function getImmersionType¶

ImmersionTypeList_TypePtr getImmersionType() const

Returns the value of the ImmersionType attribute.

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

function resetImmersionType¶

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

function hasImmersionType¶

bool hasImmersionType() const

Checks whether the optional ImmersionType attribute is present.

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

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.

function setInfinityCorrected¶

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

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

function getInfinityCorrected¶

bool getInfinityCorrected() const

Returns the value of the InfinityCorrected attribute.

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

function resetInfinityCorrected¶

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

function hasInfinityCorrected¶

bool hasInfinityCorrected() const

Checks whether the InfinityCorrected attribute is present.

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

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.

function setContrastModulation¶

void setContrastModulation(
    const Inscoper::NBO::ContrastModulationPlate_TypePtr & value,
    bool validate =true
)

Sets the value of the ContrastModulation attribute.

Parameters:

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

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.

function getContrastModulation¶

ContrastModulationPlate_TypePtr getContrastModulation() const

Returns the value of the ContrastModulation attribute.

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

function resetContrastModulation¶

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

function hasContrastModulation¶

bool hasContrastModulation() const

Checks whether the optional ContrastModulation attribute is present.

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

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.

function setDIC¶

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

Sets the value of the DIC attribute.

Parameters:

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

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.

function getDIC¶

bool getDIC() const

Returns the value of the DIC attribute.

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

function resetDIC¶

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

function hasDIC¶

bool hasDIC() const

Checks whether the DIC attribute is present.

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

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.

function setLightType¶

void setLightType(
    const Inscoper::NBO::ObjectiveLightType_TypePtr & value,
    bool validate =true
)

Sets the value of the LightType attribute.

Parameters:

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

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

function getLightType¶

ObjectiveLightType_TypePtr getLightType() const

Returns the value of the LightType attribute.

Return: The value of the attribute

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

function resetLightType¶

function hasLightType¶

bool hasLightType() const

Checks whether the optional LightType attribute is present.

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

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

function setDippingMedium¶

void setDippingMedium(
    const Inscoper::NBO::DippingType_TypePtr & value,
    bool validate =true
)

Sets the value of the DippingMedium attribute.

Parameters:

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

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

function getDippingMedium¶

DippingType_TypePtr getDippingMedium() const

Returns the value of the DippingMedium attribute.

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

function resetDippingMedium¶

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

function hasDippingMedium¶

bool hasDippingMedium() const

Checks whether the optional DippingMedium attribute is present.

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

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

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

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

function resetWorkingDistance¶

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

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

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.

No description available in the XSD standard.

function getWorkingDistanceUnit¶

function resetWorkingDistanceUnit¶

function hasWorkingDistanceUnit¶

bool hasWorkingDistanceUnit() const

Checks whether the optional WorkingDistanceUnit attribute is present.

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

No description available in the XSD standard.

function setCorrectionCollar¶

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

Sets the value of the CorrectionCollar 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) 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.

function getCorrectionCollar¶

bool getCorrectionCollar() const

Returns the value of the CorrectionCollar attribute.

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

function resetCorrectionCollar¶

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

function hasCorrectionCollar¶

bool hasCorrectionCollar() const

Checks whether the CorrectionCollar attribute is present.

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

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.

function setCorrectionCollarType¶

void setCorrectionCollarType(
    const Inscoper::NBO::CorrectionCollarTypeList_TypePtr & value,
    bool validate =true
)

Sets the value of the CorrectionCollarType attribute.

Parameters:

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

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.

function getCorrectionCollarType¶

CorrectionCollarTypeList_TypePtr getCorrectionCollarType() const

Returns the value of the CorrectionCollarType attribute.

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

function resetCorrectionCollarType¶

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

function hasCorrectionCollarType¶

bool hasCorrectionCollarType() const

Checks whether the optional CorrectionCollarType attribute is present.

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

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.

function setPhaseContrastDesignation¶

void setPhaseContrastDesignation(
    const Inscoper::NBO::PhaseContrastDesignationType_TypePtr & value,
    bool validate =true
)

Sets the value of the PhaseContrastDesignation attribute.

Parameters:

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

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

function getPhaseContrastDesignation¶

PhaseContrastDesignationType_TypePtr getPhaseContrastDesignation() const

Returns the value of the PhaseContrastDesignation attribute.

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

function resetPhaseContrastDesignation¶

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

function hasPhaseContrastDesignation¶

bool hasPhaseContrastDesignation() const

Checks whether the optional PhaseContrastDesignation attribute is present.

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

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

function setCalibratedMagnification¶

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

Sets the value of the CalibratedMagnification attribute.

Parameters:

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

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

function getCalibratedMagnification¶

float getCalibratedMagnification() const

Returns the value of the CalibratedMagnification attribute.

Return: The value of the attribute

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

function resetCalibratedMagnification¶

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

function hasCalibratedMagnification¶

bool hasCalibratedMagnification() const

Checks whether the CalibratedMagnification attribute is present.

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

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

function setIris¶

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

Sets the value of the Iris 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) 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.

function getIris¶

bool getIris() const

Returns the value of the Iris attribute.

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

function resetIris¶

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

function hasIris¶

bool hasIris() const

Checks whether the Iris attribute is present.

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

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.

function setObjectiveViewField¶

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

Sets the value of the ObjectiveViewField attribute.

Parameters:

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

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.

function getObjectiveViewField¶

float getObjectiveViewField() const

Returns the value of the ObjectiveViewField attribute.

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

function resetObjectiveViewField¶

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

function hasObjectiveViewField¶

bool hasObjectiveViewField() const

Checks whether the ObjectiveViewField attribute is present.

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

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.

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 Objective 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 Objective and the primary Image Plane.

function resetImageDistance¶

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

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 Objective and the primary Image Plane.

function setImageDistanceUnit¶

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

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

function resetImageDistanceUnit¶

function hasImageDistanceUnit¶

bool hasImageDistanceUnit() const

Checks whether the optional ImageDistanceUnit 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 setParfocalizingDistance¶

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

Sets the value of the ParfocalizingDistance attribute.

Parameters:

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

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

function getParfocalizingDistance¶

float getParfocalizingDistance() const

Returns the value of the ParfocalizingDistance attribute.

Return: The value of the attribute

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

function resetParfocalizingDistance¶

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

function hasParfocalizingDistance¶

bool hasParfocalizingDistance() const

Checks whether the ParfocalizingDistance attribute is present.

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

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

function setParfocalizingDistanceUnit¶

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

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

UnitsLength_TypePtr getParfocalizingDistanceUnit() const

Returns the value of the ParfocalizingDistanceUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetParfocalizingDistanceUnit¶

function hasParfocalizingDistanceUnit¶

bool hasParfocalizingDistanceUnit() const

Checks whether the optional ParfocalizingDistanceUnit 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.

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

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

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a Objective.

Parameters:

base The base class to cast

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

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