TIRFHardwareModule¶

Bases: ManufacturerSpec_Type

Represents the XML element TIRFHardwareModule.

Total Internal Reflection Fluorescence (TIRF) microscopy is a modality in which fluorescence is excited in a thin layer by an evanescent wave produced by total internal reflection. This element describes a Hardware Module that is used to achieve TIRF microscopy.

`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
`TIRFHardwareModule`	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.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
`value`	`LSID_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.

A Unique Identifier for this component.

Returns:

Type	Description
`LSID_Type`	The value of the attribute

`resetID()` ¶

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

`hasID()` ¶

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

`setMethod(value, validate=True)` ¶

Sets the value of the Method attribute.

This field captures the approach used by this TIRF Hardware Module to produce TIRF illumination. In Objective-based TIRF, the excitation lightpath and the emission channel share the same optics, which provides high signals but might result in high background. In Prism-based TIRF excitation light enters the dovetail prism, reflects at the glass/water interface and escapes through the opposite facet without interferring with the emission channel . In Lightguide-based TIRF, excitation light enters the lightguide, reflects multiple times from its top and bottom surfaces to generate wide-area evanescent waves and escapes from the opposite side of the lightguide without interferring with the emission channel.

Parameters:

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

`getMethod()` ¶

Returns the value of the Method attribute.

This field captures the approach used by this TIRF Hardware Module to produce TIRF illumination. In Objective-based TIRF, the excitation lightpath and the emission channel share the same optics, which provides high signals but might result in high background. In Prism-based TIRF excitation light enters the dovetail prism, reflects at the glass/water interface and escapes through the opposite facet without interferring with the emission channel . In Lightguide-based TIRF, excitation light enters the lightguide, reflects multiple times from its top and bottom surfaces to generate wide-area evanescent waves and escapes from the opposite side of the lightguide without interferring with the emission channel.

Returns:

Type	Description
`TIRFMethod_Type`	The value of the attribute

`resetMethod()` ¶

Resets the Method attribute to an unset state.

This field captures the approach used by this TIRF Hardware Module to produce TIRF illumination. In Objective-based TIRF, the excitation lightpath and the emission channel share the same optics, which provides high signals but might result in high background. In Prism-based TIRF excitation light enters the dovetail prism, reflects at the glass/water interface and escapes through the opposite facet without interferring with the emission channel . In Lightguide-based TIRF, excitation light enters the lightguide, reflects multiple times from its top and bottom surfaces to generate wide-area evanescent waves and escapes from the opposite side of the lightguide without interferring with the emission channel.

`hasMethod()` ¶

Checks whether the optional Method attribute is present.

This field captures the approach used by this TIRF Hardware Module to produce TIRF illumination. In Objective-based TIRF, the excitation lightpath and the emission channel share the same optics, which provides high signals but might result in high background. In Prism-based TIRF excitation light enters the dovetail prism, reflects at the glass/water interface and escapes through the opposite facet without interferring with the emission channel . In Lightguide-based TIRF, excitation light enters the lightguide, reflects multiple times from its top and bottom surfaces to generate wide-area evanescent waves and escapes from the opposite side of the lightguide without interferring with the emission channel.

Returns:

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

`setRIng(value, validate=True)` ¶

Sets the value of the RIng attribute.

This field captures whether this TIRF Hardware Module employs Ring (also known as spinning-spot) TIRF (True) or Spot TIRF (False).

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`

`getRIng()` ¶

Returns the value of the RIng attribute.

This field captures whether this TIRF Hardware Module employs Ring (also known as spinning-spot) TIRF (True) or Spot TIRF (False).

Returns:

Type	Description
`boolean`	The value of the attribute

`resetRIng()` ¶

Resets the RIng attribute to an unset state.

This field captures whether this TIRF Hardware Module employs Ring (also known as spinning-spot) TIRF (True) or Spot TIRF (False).

`hasRIng()` ¶

Checks whether the RIng attribute is present.

This field captures whether this TIRF Hardware Module employs Ring (also known as spinning-spot) TIRF (True) or Spot TIRF (False).

Returns:

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

`setMotorized(value, validate=True)` ¶

Sets the value of the Motorized attribute.

This field captures whether this TIRF Hardware Module employs a Motorized device to set the TIRF Angle (True) or not (False).

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`

`getMotorized()` ¶

Returns the value of the Motorized attribute.

This field captures whether this TIRF Hardware Module employs a Motorized device to set the TIRF Angle (True) or not (False).

Returns:

Type	Description
`boolean`	The value of the attribute

`resetMotorized()` ¶

Resets the Motorized attribute to an unset state.

This field captures whether this TIRF Hardware Module employs a Motorized device to set the TIRF Angle (True) or not (False).

`hasMotorized()` ¶

Checks whether the Motorized attribute is present.

This field captures whether this TIRF Hardware Module employs a Motorized device to set the TIRF Angle (True) or not (False).

Returns:

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