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).
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
setPhaseNumber ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 , validate = True )
resetCenterStopDiameter ()
setCenterStopDiameterUnit ( value , validate = True )
getCenterStopDiameterUnit ()
resetCenterStopDiameterUnit ()
hasCenterStopDiameterUnit ()
setSlitWidth ( value , validate = True )
setSlitWidthUnit ( value , validate = True )