Bases: OpticalAperture_Type
Represents the XML element Shutter.
This element describes a Shutter available for this Instrument. Shutters are devices that open and close, and they may be mechanically or electro-mechanically controlled. Shutters are typically used to control the Light that raches the sample (i.e., to limit phototoxicity and photobleaching especially in case of live specimens), or the Detecrtor at any one time. They can also be used for Excitation or Emission Wavelength selection.
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 )
setResponseTime ( value , validate = True )
Sets the value of the ResponseTime attribute.
This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getResponseTime ()
Returns the value of the ResponseTime attribute.
This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.
Returns:
Type
Description
float
The value of the attribute
resetResponseTime ()
Resets the ResponseTime attribute to an unset state.
This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.
hasResponseTime ()
Checks whether the ResponseTime attribute is present.
This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setResponseTimeUnit ( value , validate = True )
setFunction ( value , validate = True )
Sets the value of the Function attribute.
This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.
Parameters:
Name
Type
Description
Default
value
ShutterFunction_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getFunction ()
Returns the value of the Function attribute.
This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.
Returns:
Type
Description
ShutterFunction_Type
The value of the attribute
resetFunction ()
Resets the Function attribute to an unset state.
This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.
hasFunction ()
Checks whether the optional Function attribute is present.
This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setOperatingFrequency ( value , validate = True )
Sets the value of the OperatingFrequency attribute.
This field records the Frequency of Operation of this Shutter, according to the Manufactuers.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getOperatingFrequency ()
Returns the value of the OperatingFrequency attribute.
This field records the Frequency of Operation of this Shutter, according to the Manufactuers.
Returns:
Type
Description
float
The value of the attribute
resetOperatingFrequency ()
Resets the OperatingFrequency attribute to an unset state.
This field records the Frequency of Operation of this Shutter, according to the Manufactuers.
hasOperatingFrequency ()
Checks whether the OperatingFrequency attribute is present.
This field records the Frequency of Operation of this Shutter, according to the Manufactuers.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setOperatingFrequencyUnit ( value , validate = True )
getOperatingFrequencyUnit ()
resetOperatingFrequencyUnit ()
hasOperatingFrequencyUnit ()
setMotorized ( value , validate = True )
setMaxApertureDiameter ( value , validate = True )
resetMaxApertureDiameter ()
setMaxApertureDiameterUnit ( value , validate = True )
getMaxApertureDiameterUnit ()
resetMaxApertureDiameterUnit ()
hasMaxApertureDiameterUnit ()
setMultimode ( value , validate = True )
Sets the value of the Multimode attribute.
This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getMultimode ()
Returns the value of the Multimode attribute.
This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).
Returns:
Type
Description
boolean
The value of the attribute
resetMultimode ()
Resets the Multimode attribute to an unset state.
This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).
hasMultimode ()
Checks whether the Multimode attribute is present.
This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise