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.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a LightSourceSettings.

Parameters:

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

Returns:

Type	Description
`LightSourceSettings`	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`	`LightSourceID_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
`LightSourceID_Type`	The value of the attribute

`resetID()` ¶

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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

`resetIlluminationPowerSettings()` ¶

`hasIlluminationPowerSettings()` ¶

Checks whether the IlluminationPowerSettings attribute is present.

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
`boolean`	true if the attribute has been set, false otherwise

`setlluminationPowerSettingsUnit(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`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, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`hasAttenuationMethod()` ¶

Checks whether the 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 attribute has been set, false otherwise

`getAttenuationMethodAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setUsedAcoustoOpticalDevice(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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()` ¶

`hasUsedAcoustoOpticalDevice()` ¶

Checks whether the 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 attribute has been set, false otherwise

LightSourceSettings¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

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) ¶

setID(value, validate=True) ¶

getID() ¶

resetID() ¶

hasID() ¶

setIlluminationPowerSettings(value, validate=True) ¶

getIlluminationPowerSettings() ¶

resetIlluminationPowerSettings() ¶

hasIlluminationPowerSettings() ¶

setlluminationPowerSettingsUnit(value, validate=True) ¶

getlluminationPowerSettingsUnit() ¶

resetlluminationPowerSettingsUnit() ¶

haslluminationPowerSettingsUnit() ¶

setAttenuation(value, validate=True) ¶

getAttenuation() ¶

resetAttenuation() ¶

hasAttenuation() ¶

setAttenuationMethod(value, validate=True) ¶

getAttenuationMethod() ¶

resetAttenuationMethod() ¶

hasAttenuationMethod() ¶

getAttenuationMethodAllowedValues() staticmethod ¶

setUsedAcoustoOpticalDevice(value, validate=True) ¶

getUsedAcoustoOpticalDevice() ¶

resetUsedAcoustoOpticalDevice() ¶

hasUsedAcoustoOpticalDevice() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`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)` ¶

`setID(value, validate=True)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setIlluminationPowerSettings(value, validate=True)` ¶

`getIlluminationPowerSettings()` ¶

`resetIlluminationPowerSettings()` ¶

`hasIlluminationPowerSettings()` ¶

`setlluminationPowerSettingsUnit(value, validate=True)` ¶

`getlluminationPowerSettingsUnit()` ¶

`resetlluminationPowerSettingsUnit()` ¶

`haslluminationPowerSettingsUnit()` ¶

`setAttenuation(value, validate=True)` ¶

`getAttenuation()` ¶

`resetAttenuation()` ¶

`hasAttenuation()` ¶

`setAttenuationMethod(value, validate=True)` ¶

`getAttenuationMethod()` ¶

`resetAttenuationMethod()` ¶

`hasAttenuationMethod()` ¶

`getAttenuationMethodAllowedValues()` `staticmethod` ¶

`setUsedAcoustoOpticalDevice(value, validate=True)` ¶

`getUsedAcoustoOpticalDevice()` ¶

`resetUsedAcoustoOpticalDevice()` ¶

`hasUsedAcoustoOpticalDevice()` ¶