com.inscoper.nbo.PhaseRing

Represents the XML element PhaseRing. More...

Inherits from com.inscoper.nbo.OpticalAperture_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	PhaseRing()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setPhaseNumber(PhaseRingNumber_Type value, boolean validate) Sets the value of the PhaseNumber attribute.
void	setPhaseNumber(PhaseRingNumber_Type value) Sets the value of the PhaseNumber attribute.
PhaseRingNumber_Type	getPhaseNumber() Returns the value of the PhaseNumber attribute.
void	resetPhaseNumber() Resets the PhaseNumber attribute to an unset state.
boolean	hasPhaseNumber() Checks whether the optional PhaseNumber attribute is present.
void	setCenterStopDiameter(float value, boolean validate) Sets the value of the CenterStopDiameter attribute.
void	setCenterStopDiameter(float value) Sets the value of the CenterStopDiameter attribute.
float	getCenterStopDiameter() Returns the value of the CenterStopDiameter attribute.
void	resetCenterStopDiameter() Resets the CenterStopDiameter attribute to an unset state.
boolean	hasCenterStopDiameter() Checks whether the CenterStopDiameter attribute is present.
void	setCenterStopDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the CenterStopDiameterUnit attribute.
void	setCenterStopDiameterUnit(UnitsLength_Type value) Sets the value of the CenterStopDiameterUnit attribute.
UnitsLength_Type	getCenterStopDiameterUnit() Returns the value of the CenterStopDiameterUnit attribute.
void	resetCenterStopDiameterUnit() Resets the CenterStopDiameterUnit attribute to an unset state.
boolean	hasCenterStopDiameterUnit() Checks whether the optional CenterStopDiameterUnit attribute is present.
void	setSlitWidth(PositiveFloat_Type value, boolean validate) Sets the value of the SlitWidth attribute.
void	setSlitWidth(PositiveFloat_Type value) Sets the value of the SlitWidth attribute.
PositiveFloat_Type	getSlitWidth() Returns the value of the SlitWidth attribute.
void	resetSlitWidth() Resets the SlitWidth attribute to an unset state.
boolean	hasSlitWidth() Checks whether the optional SlitWidth attribute is present.
void	setSlitWidthUnit(UnitsLength_Type value, boolean validate) Sets the value of the SlitWidthUnit attribute.
void	setSlitWidthUnit(UnitsLength_Type value) Sets the value of the SlitWidthUnit attribute.
UnitsLength_Type	getSlitWidthUnit() Returns the value of the SlitWidthUnit attribute.
void	resetSlitWidthUnit() Resets the SlitWidthUnit attribute to an unset state.
boolean	hasSlitWidthUnit() Checks whether the optional SlitWidthUnit attribute is present.
PhaseRing	__internal_create(long cPtr, boolean own)
PhaseRing	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions

	Name
	PhaseRing(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(PhaseRing obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type()
void	setID(LensID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setOpticsHolderPosition(String value, boolean validate) Sets the value of the OpticsHolderPosition attribute.
void	setOpticsHolderPosition(String value) Sets the value of the OpticsHolderPosition attribute.
String	getOpticsHolderPosition() Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
boolean	hasOpticsHolderPosition() Checks whether the OpticsHolderPosition attribute is present.
void	setOuterDiameter(float value, boolean validate) Sets the value of the OuterDiameter attribute.
void	setOuterDiameter(float value) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
boolean	hasOuterDiameter() Checks whether the OuterDiameter attribute is present.
void	setOuterDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the OuterDiameterUnit attribute.
void	setOuterDiameterUnit(UnitsLength_Type value) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_Type	getOuterDiameterUnit() Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
boolean	hasOuterDiameterUnit() Checks whether the optional OuterDiameterUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
StringSet	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.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 delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.delete

function PhaseRing

public PhaseRing()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonFile

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonString

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlFile

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlString

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlFile

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlFile

function toXmlString

public String toXmlString(
    boolean validate
)

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

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlString

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlString

function setPhaseNumber

public void setPhaseNumber(
    PhaseRingNumber_Type value,
    boolean validate
)

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 setPhaseNumber

public void setPhaseNumber(
    PhaseRingNumber_Type value
)

Sets the value of the PhaseNumber attribute.

Parameters:

• value The value to set

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

public PhaseRingNumber_Type getPhaseNumber()

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

public 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

public boolean hasPhaseNumber()

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

public void setCenterStopDiameter(
    float value,
    boolean validate
)

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 setCenterStopDiameter

public void setCenterStopDiameter(
    float value
)

Sets the value of the CenterStopDiameter attribute.

Parameters:

• value The value to set

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

function getCenterStopDiameter

public float getCenterStopDiameter()

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

public void resetCenterStopDiameter()

Resets the CenterStopDiameter attribute to an unset state.

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

function hasCenterStopDiameter

public boolean hasCenterStopDiameter()

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

public void setCenterStopDiameterUnit(
    UnitsLength_Type value,
    boolean validate
)

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 setCenterStopDiameterUnit

public void setCenterStopDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the CenterStopDiameterUnit attribute.

Parameters:

• value The value to set

No description available in the XSD standard.

function getCenterStopDiameterUnit

public UnitsLength_Type getCenterStopDiameterUnit()

Returns the value of the CenterStopDiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetCenterStopDiameterUnit

public void resetCenterStopDiameterUnit()

Resets the CenterStopDiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasCenterStopDiameterUnit

public boolean hasCenterStopDiameterUnit()

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

public void setSlitWidth(
    PositiveFloat_Type value,
    boolean validate
)

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 setSlitWidth

public void setSlitWidth(
    PositiveFloat_Type value
)

Sets the value of the SlitWidth attribute.

Parameters:

• value The value to set

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

function getSlitWidth

public PositiveFloat_Type getSlitWidth()

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

public void resetSlitWidth()

Resets the SlitWidth attribute to an unset state.

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

function hasSlitWidth

public boolean hasSlitWidth()

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

public void setSlitWidthUnit(
    UnitsLength_Type value,
    boolean validate
)

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 setSlitWidthUnit

public void setSlitWidthUnit(
    UnitsLength_Type value
)

Sets the value of the SlitWidthUnit attribute.

Parameters:

• value The value to set

No description available in the XSD standard.

function getSlitWidthUnit

public UnitsLength_Type getSlitWidthUnit()

Returns the value of the SlitWidthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetSlitWidthUnit

public void resetSlitWidthUnit()

Resets the SlitWidthUnit attribute to an unset state.

No description available in the XSD standard.

function hasSlitWidthUnit

public boolean hasSlitWidthUnit()

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 __internal_create

public static PhaseRing __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.__internal_create

function fromBase

public static PhaseRing fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

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

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromBase

Protected Functions Documentation

function PhaseRing

protected PhaseRing(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.finalize

function getCPtr

protected static long getCPtr(
    PhaseRing obj
)

---

Updated on 2026-06-22 at 17:06:31 +0200