Pinhole

Bases: OpticalAperture_Type

Represents the XML element Pinhole.

A pin-like aperture positioned axially to the Light Path, which can act as a spatial filter for a beam of light to clean up the output of lasers and / or to suppress out-of-focus light in a confocal Microscope. Specifically, in Confocal Microscopy, such Pinholes are diaphragm typically situated in a plane conjugate with the object, and they restrict the area in the object plane that is illuminated and/or from which light is collected.

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)

setMaxDiameter(value, validate=True)

getMaxDiameter()

resetMaxDiameter()

hasMaxDiameter()

setMaxDiameterUnit(value, validate=True)

getMaxDiameterUnit()

resetMaxDiameterUnit()

hasMaxDiameterUnit()

setShape(value, validate=True)

getShape()

resetShape()

hasShape()