Inscoper::NBO::PhaseRing¶

Represents the XML element PhaseRing. More...

#include <PhaseRing.h>

Inherits from Inscoper::NBO::OpticalAperture_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	PhaseRing()
	~PhaseRing()
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	setPhaseNumber(const Inscoper::NBO::PhaseRingNumber_TypePtr & value, bool validate =true) Sets the value of the PhaseNumber attribute.
PhaseRingNumber_TypePtr	getPhaseNumber() const Returns the value of the PhaseNumber attribute.
void	resetPhaseNumber() Resets the PhaseNumber attribute to an unset state.
bool	hasPhaseNumber() const Checks whether the optional PhaseNumber attribute is present.
void	setCenterStopDiameter(const float & value, bool validate =true) Sets the value of the CenterStopDiameter attribute.
float	getCenterStopDiameter() const Returns the value of the CenterStopDiameter attribute.
void	resetCenterStopDiameter() Resets the CenterStopDiameter attribute to an unset state.
bool	hasCenterStopDiameter() const Checks whether the CenterStopDiameter attribute is present.
void	setCenterStopDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the CenterStopDiameterUnit attribute.
UnitsLength_TypePtr	getCenterStopDiameterUnit() const Returns the value of the CenterStopDiameterUnit attribute.
void	resetCenterStopDiameterUnit() Resets the CenterStopDiameterUnit attribute to an unset state.
bool	hasCenterStopDiameterUnit() const Checks whether the optional CenterStopDiameterUnit attribute is present.
void	setSlitWidth(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the SlitWidth attribute.
PositiveFloat_TypePtr	getSlitWidth() const Returns the value of the SlitWidth attribute.
void	resetSlitWidth() Resets the SlitWidth attribute to an unset state.
bool	hasSlitWidth() const Checks whether the optional SlitWidth attribute is present.
void	setSlitWidthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the SlitWidthUnit attribute.
UnitsLength_TypePtr	getSlitWidthUnit() const Returns the value of the SlitWidthUnit attribute.
void	resetSlitWidthUnit() Resets the SlitWidthUnit attribute to an unset state.
bool	hasSlitWidthUnit() const Checks whether the optional SlitWidthUnit attribute is present.
std::shared_ptr< PhaseRing >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a PhaseRing.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::OpticalAperture_Type

	Name
	OpticalAperture_Type()
	~OpticalAperture_Type()
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	setOpticsHolderPosition(const std::string & value, bool validate =true) Sets the value of the OpticsHolderPosition attribute.
std::string	getOpticsHolderPosition() const Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
bool	hasOpticsHolderPosition() const Checks whether the OpticsHolderPosition attribute is present.
void	setOuterDiameter(const float & value, bool validate =true) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() const Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
bool	hasOuterDiameter() const Checks whether the OuterDiameter attribute is present.
void	setOuterDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_TypePtr	getOuterDiameterUnit() const Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
bool	hasOuterDiameterUnit() const Checks whether the optional OuterDiameterUnit 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.
const std::set< std::string > &	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.

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

Represents the XML element PhaseRing.

This element (also called Phase Annulus) refers to an annular (ring-like) slit used to produce contrast modulation following Zernike, in which the Image contrast of a phase object is enhanced by altering the phase and amplitude of the direct light with respect to those of the diffracted light. This illuminating aperture Diaphragm is placed in the front focal Plane of the Condenser and acts in conjunction with an appropriate phase plate, usually in the form of an annulus, placed in the back focal Plane of the objective (or in a succeeding Plane conjugate with this).

Public Functions Documentation¶

function PhaseRing¶

function ~PhaseRing¶

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 setPhaseNumber¶

void setPhaseNumber(
    const Inscoper::NBO::PhaseRingNumber_TypePtr & value,
    bool validate =true
)

Sets the value of the PhaseNumber attribute.

Parameters:

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

This field captures the Phase Number used to identify the size of the annular slit of this Phase Ring. The Phase Number must match the Phase Plate found within a Phase-contrast capable Objective lens.

function getPhaseNumber¶

PhaseRingNumber_TypePtr getPhaseNumber() const

Returns the value of the PhaseNumber attribute.

Return: The value of the attribute

This field captures the Phase Number used to identify the size of the annular slit of this Phase Ring. The Phase Number must match the Phase Plate found within a Phase-contrast capable Objective lens.

function resetPhaseNumber¶

void resetPhaseNumber()

Resets the PhaseNumber attribute to an unset state.

This field captures the Phase Number used to identify the size of the annular slit of this Phase Ring. The Phase Number must match the Phase Plate found within a Phase-contrast capable Objective lens.

function hasPhaseNumber¶

bool hasPhaseNumber() const

Checks whether the optional PhaseNumber attribute is present.

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

This field captures the Phase Number used to identify the size of the annular slit of this Phase Ring. The Phase Number must match the Phase Plate found within a Phase-contrast capable Objective lens.

function setCenterStopDiameter¶

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

Sets the value of the CenterStopDiameter attribute.

Parameters:

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

This filed records the physical diameter of the center-stop (i.e. opaque disk) of this Phase Ring.

function getCenterStopDiameter¶

float getCenterStopDiameter() const

Returns the value of the CenterStopDiameter attribute.

Return: The value of the attribute

This filed records the physical diameter of the center-stop (i.e. opaque disk) of this Phase Ring.

function resetCenterStopDiameter¶

function hasCenterStopDiameter¶

bool hasCenterStopDiameter() const

Checks whether the CenterStopDiameter attribute is present.

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

This filed records the physical diameter of the center-stop (i.e. opaque disk) of this Phase Ring.

function setCenterStopDiameterUnit¶

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

Sets the value of the CenterStopDiameterUnit 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 getCenterStopDiameterUnit¶

function resetCenterStopDiameterUnit¶

function hasCenterStopDiameterUnit¶

bool hasCenterStopDiameterUnit() const

Checks whether the optional CenterStopDiameterUnit attribute is present.

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

No description available in the XSD standard.

function setSlitWidth¶

void setSlitWidth(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the SlitWidth attribute.

Parameters:

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

This field records the physical width of the annular slit of this Phase Ring.

function getSlitWidth¶

PositiveFloat_TypePtr getSlitWidth() const

Returns the value of the SlitWidth attribute.

Return: The value of the attribute

This field records the physical width of the annular slit of this Phase Ring.

function resetSlitWidth¶

function hasSlitWidth¶

bool hasSlitWidth() const

Checks whether the optional SlitWidth attribute is present.

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

This field records the physical width of the annular slit of this Phase Ring.

function setSlitWidthUnit¶

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

Sets the value of the SlitWidthUnit 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 getSlitWidthUnit¶

function resetSlitWidthUnit¶

function hasSlitWidthUnit¶

bool hasSlitWidthUnit() const

Checks whether the optional SlitWidthUnit attribute 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< PhaseRing > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a PhaseRing.

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