ShutterSettings

Bases: Settings_Type

Represents the XML element ShutterSettings.

This element holds the Setting applied to a Shutter used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Shutter in question.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
ShutterSettings	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value, validate=True)

Sets the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Parameters:

Name	Type	Description	Default
value	OpticalApertureID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
OpticalApertureID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

hasID()

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setOpenDuringZMovement(value, validate=True)

Sets the value of the OpenDuringZMovement attribute.

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getOpenDuringZMovement()

Returns the value of the OpenDuringZMovement attribute.

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

Returns:

Type	Description
boolean	The value of the attribute

resetOpenDuringZMovement()

Resets the OpenDuringZMovement attribute to an unset state.

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

hasOpenDuringZMovement()

Checks whether the OpenDuringZMovement attribute is present.

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setApertureDiameter(value, validate=True)

Sets the value of the ApertureDiameter attribute.

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getApertureDiameter()

Returns the value of the ApertureDiameter attribute.

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

Returns:

Type	Description
float	The value of the attribute

resetApertureDiameter()

Resets the ApertureDiameter attribute to an unset state.

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

hasApertureDiameter()

Checks whether the ApertureDiameter attribute is present.

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setApertureDiameterUnit(value, validate=True)

Sets the value of the ApertureDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getApertureDiameterUnit()

Returns the value of the ApertureDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetApertureDiameterUnit()

Resets the ApertureDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasApertureDiameterUnit()

Checks whether the optional ApertureDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setMode(value, validate=True)

Sets the value of the Mode attribute.

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft 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	ShutterMode_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getMode()

Returns the value of the Mode attribute.

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft 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
ShutterMode_Type	The value of the attribute

resetMode()

Resets the Mode attribute to an unset state.

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft 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).

hasMode()

Checks whether the optional Mode attribute is present.

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft 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 optional attribute has been set, false otherwise