Skip to content

OpticalAperture_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type OpticalAperture.

This element represents any mechanical, non optical device that is placed in the Light Path and spatially modifies the light beam. Examples include, Pin Holes, Phase Rings, Dark Field Stops, Hoffman Modulators, Diffraction Gratings etc. This element can be associated with an optional Optics Turret.

fromBase(base) staticmethod

getTypeName()

getXMLName()

getNBOType()

getChildren()

getSubElements()

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)

setID(value, validate=True)

getID()

resetID()

hasID()

setName(value, validate=True)

getName()

resetName()

hasName()

setOpticsHolderPosition(value, validate=True)

getOpticsHolderPosition()

resetOpticsHolderPosition()

hasOpticsHolderPosition()

getOpticsHolderPositionAllowedValues() staticmethod

setOuterDiameter(value, validate=True)

getOuterDiameter()

resetOuterDiameter()

hasOuterDiameter()

setOuterDiameterUnit(value, validate=True)

getOuterDiameterUnit()

resetOuterDiameterUnit()

hasOuterDiameterUnit()

setAnnotationRef(value, validate=True)

getAnnotationRef()

resetAnnotationRef()

hasAnnotationRef()