PhaseRing

Bases: OpticalAperture_Type

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

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

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

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

Type	Description
string	A string containing the XML representation of this object

setPhaseNumber(value)

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

Parameters:

Name	Type	Description	Default
value	PhaseRingNumber_Type	The value to set	required

getPhaseNumber()

Returns the value of the PhaseNumber 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.

Returns:

Type	Description
PhaseRingNumber_Type	The value of the attribute

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.

hasPhaseNumber()

Checks whether the optional PhaseNumber attribute is present.

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.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setCenterStopDiameter(value)

Sets the value of the CenterStopDiameter attribute.

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

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getCenterStopDiameter()

Returns the value of the CenterStopDiameter attribute.

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

Returns:

Type	Description
float	The value of the attribute

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.

hasCenterStopDiameter()

Checks whether the optional CenterStopDiameter attribute is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setCenterStopDiameterUnit(value)

Sets the value of the CenterStopDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getCenterStopDiameterUnit()

Returns the value of the CenterStopDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetCenterStopDiameterUnit()

Resets the CenterStopDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasCenterStopDiameterUnit()

Checks whether the optional CenterStopDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setSlitWidth(value)

Sets the value of the SlitWidth attribute.

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

Parameters:

Name	Type	Description	Default
value	PositiveFloat_Type	The value to set	required

getSlitWidth()

Returns the value of the SlitWidth attribute.

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

Returns:

Type	Description
PositiveFloat_Type	The value of the attribute

resetSlitWidth()

Resets the SlitWidth attribute to an unset state.

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

hasSlitWidth()

Checks whether the optional SlitWidth attribute is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setSlitWidthUnit(value)

Sets the value of the SlitWidthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getSlitWidthUnit()

Returns the value of the SlitWidthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetSlitWidthUnit()

Resets the SlitWidthUnit attribute to an unset state.

No description available in the XSD standard.

hasSlitWidthUnit()

Checks whether the optional SlitWidthUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise