LightSourceSettings
Bases: Settings_Type
Represents the XML element LightSourceSettings.
This element holds the Setting applied to a Light Source used in the Light Path during the acquisition of this Channel as well as a reference to the LightSource (the ID attribute) in question.
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
|
LightSourceID_Type
|
The value to set |
required |
getID()
Returns the value of the ID attribute.
A Unique Identifier for this component.
Returns:
| Type | Description |
|---|---|
LightSourceID_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 |
setIlluminationPowerSettings(value)
Sets the value of the IlluminationPowerSettings attribute.
This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getIlluminationPowerSettings()
Returns the value of the IlluminationPowerSettings attribute.
This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setlluminationPowerSettingsUnit(value)
Sets the value of the lluminationPowerSettingsUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsPower_Type
|
The value to set |
required |
getlluminationPowerSettingsUnit()
Returns the value of the lluminationPowerSettingsUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsPower_Type
|
The value of the attribute |
resetlluminationPowerSettingsUnit()
Resets the lluminationPowerSettingsUnit attribute to an unset state.
No description available in the XSD standard.
haslluminationPowerSettingsUnit()
Checks whether the optional lluminationPowerSettingsUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAttenuation(value)
Sets the value of the Attenuation attribute.
This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PercentFraction_Type
|
The value to set |
required |
getAttenuation()
Returns the value of the Attenuation attribute.
This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.
Returns:
| Type | Description |
|---|---|
PercentFraction_Type
|
The value of the attribute |
resetAttenuation()
Resets the Attenuation attribute to an unset state.
This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.
hasAttenuation()
Checks whether the optional Attenuation attribute is present.
This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAttenuationMethod(value)
Sets the value of the AttenuationMethod attribute.
This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getAttenuationMethod()
Returns the value of the AttenuationMethod attribute.
This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetAttenuationMethod()
Resets the AttenuationMethod attribute to an unset state.
This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.
hasAttenuationMethod()
Checks whether the optional AttenuationMethod attribute is present.
This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setUsedAcoustoOpticalDevice(value)
Sets the value of the UsedAcoustoOpticalDevice attribute.
In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
boolean
|
The value to set |
required |
getUsedAcoustoOpticalDevice()
Returns the value of the UsedAcoustoOpticalDevice attribute.
In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetUsedAcoustoOpticalDevice()
Resets the UsedAcoustoOpticalDevice attribute to an unset state.
In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.
hasUsedAcoustoOpticalDevice()
Checks whether the optional UsedAcoustoOpticalDevice attribute is present.
In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |