TIRFSettings
Bases: Settings_Type
Represents the XML element TIRFSettings.
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 defines the TIRF conditions that were used for this Experiment.
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)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setID(value)
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 |
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 |
setHILO(value)
Sets the value of the HILO attribute.
This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
boolean
|
The value to set |
required |
getHILO()
Returns the value of the HILO attribute.
This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetHILO()
Resets the HILO attribute to an unset state.
This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).
hasHILO()
Checks whether the optional HILO attribute is present.
This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTIRFAngle(value)
Sets the value of the TIRFAngle attribute.
This field captures the incidence Angle used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getTIRFAngle()
Returns the value of the TIRFAngle attribute.
This field captures the incidence Angle used in this case.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetTIRFAngle()
Resets the TIRFAngle attribute to an unset state.
This field captures the incidence Angle used in this case.
hasTIRFAngle()
Checks whether the optional TIRFAngle attribute is present.
This field captures the incidence Angle used in this case.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTIRFHardwareModuleRef_List(value)
Sets the list of TIRFHardwareModuleRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[TIRFHardwareModuleRef]
|
The new list of TIRFHardwareModuleRef elements |
required |
getTIRFHardwareModuleRef_List()
Returns the list of TIRFHardwareModuleRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[TIRFHardwareModuleRef]
|
The list of TIRFHardwareModuleRef elements |
addToTIRFHardwareModuleRef_List(value)
Adds a new TIRFHardwareModuleRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TIRFHardwareModuleRef
|
The element to add |
required |
clearTIRFHardwareModuleRef_List()
Clear the list of TIRFHardwareModuleRef.
No description available in the XSD standard.
setTIRFLightPath(value)
Sets the value of the TIRFLightPath element.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TIRFLightPath
|
The value to set |
required |
getTIRFLightPath()
Returns the value of the TIRFLightPath element.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
TIRFLightPath
|
The value of the element |
resetTIRFLightPath()
Resets the TIRFLightPath element to an unset state.
No description available in the XSD standard.
hasTIRFLightPath()
Checks whether the optional TIRFLightPath element is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setDescription(value)
Sets the value of the Description element.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Description
|
The value to set |
required |
getDescription()
Returns the value of the Description element.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
Description
|
The value of the element |
resetDescription()
Resets the Description element to an unset state.
No description available in the XSD standard.
hasDescription()
Checks whether the optional Description element is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |