Bases: OpticalApertureSettings_Type
Represents the XML element PinholeSettings.
This element holds the Setting applied to a Pinhole used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Pinhole in question.
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 )
setAperture ( value , validate = True )
Sets the value of the Aperture attribute.
This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getAperture ()
Returns the value of the Aperture attribute.
This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.
Returns:
Type
Description
float
The value of the attribute
resetAperture ()
Resets the Aperture attribute to an unset state.
This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.
hasAperture ()
Checks whether the Aperture attribute is present.
This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise