DetectorSettings_Type¶

Bases: Settings_Type

Represents the XML complex type DetectorSettings.

This element holds the Setting applied to the Detector used for the Acquisition of this Channel as well as a reference to the Detector (the ID attribute) in question.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a DetectorSettings_Type.

Parameters:

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

Returns:

Type	Description
`DetectorSettings_Type`	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`	`DetectorID_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
`DetectorID_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

`setEffectiveBitDepth(value, validate=True)` ¶

Sets the value of the EffectiveBitDepth attribute.

If selectable, this field reports the Effective Bit Depth that was used by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer) for the Acquisition of this Channel.

Parameters:

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

`getEffectiveBitDepth()` ¶

Returns the value of the EffectiveBitDepth attribute.

If selectable, this field reports the Effective Bit Depth that was used by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer) for the Acquisition of this Channel.

Returns:

Type	Description
`DigitizerType_Type`	The value of the attribute

`resetEffectiveBitDepth()` ¶

`hasEffectiveBitDepth()` ¶

Checks whether the optional EffectiveBitDepth attribute is present.

If selectable, this field reports the Effective Bit Depth that was used by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer) for the Acquisition of this Channel.

Returns:

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

`setAnalogGain(value, validate=True)` ¶

Sets the value of the AnalogGain attribute.

This field reports the Analog Gain (also known as Inherent Gain or simply as Gain) that was applied during the Acquisition of this Image. The Analog Gain is a property Inherent to the Detector and it specifies how many electrons correspond to 1 signal unit (photon) detected. Gain is reported in terms of electrons/ADU (analog-to-digital unit). A gain of 8 means that the Detector digitizes the light signal so that each ADU corresponds to 8 photoelectrons. NOTE: In the case of Point Detectors the value of Analog Gain can be set freely by the user. Conversely, in the case of Cameras, it is common for the Gain to be preset by the Manufacturer to minimize noise. In this case, either the Analog Gain cannot be changed or the user is given the choice of selecting between a few preset Analog Gains values upon Acquisition. Finally, several Cameras might have so-called Automatic Gain Control (AGC or AutoGain) that will automatically adjusts so the full range of the Analog-to-Digital Converter (ADC) is used. Unless you can turn off the AGC, the use of these Cameras are highly discouraged for quantitative work.

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`

`getAnalogGain()` ¶

Returns the value of the AnalogGain attribute.

This field reports the Analog Gain (also known as Inherent Gain or simply as Gain) that was applied during the Acquisition of this Image. The Analog Gain is a property Inherent to the Detector and it specifies how many electrons correspond to 1 signal unit (photon) detected. Gain is reported in terms of electrons/ADU (analog-to-digital unit). A gain of 8 means that the Detector digitizes the light signal so that each ADU corresponds to 8 photoelectrons. NOTE: In the case of Point Detectors the value of Analog Gain can be set freely by the user. Conversely, in the case of Cameras, it is common for the Gain to be preset by the Manufacturer to minimize noise. In this case, either the Analog Gain cannot be changed or the user is given the choice of selecting between a few preset Analog Gains values upon Acquisition. Finally, several Cameras might have so-called Automatic Gain Control (AGC or AutoGain) that will automatically adjusts so the full range of the Analog-to-Digital Converter (ADC) is used. Unless you can turn off the AGC, the use of these Cameras are highly discouraged for quantitative work.

Returns:

Type	Description
`float`	The value of the attribute

`resetAnalogGain()` ¶

Resets the AnalogGain attribute to an unset state.

This field reports the Analog Gain (also known as Inherent Gain or simply as Gain) that was applied during the Acquisition of this Image. The Analog Gain is a property Inherent to the Detector and it specifies how many electrons correspond to 1 signal unit (photon) detected. Gain is reported in terms of electrons/ADU (analog-to-digital unit). A gain of 8 means that the Detector digitizes the light signal so that each ADU corresponds to 8 photoelectrons. NOTE: In the case of Point Detectors the value of Analog Gain can be set freely by the user. Conversely, in the case of Cameras, it is common for the Gain to be preset by the Manufacturer to minimize noise. In this case, either the Analog Gain cannot be changed or the user is given the choice of selecting between a few preset Analog Gains values upon Acquisition. Finally, several Cameras might have so-called Automatic Gain Control (AGC or AutoGain) that will automatically adjusts so the full range of the Analog-to-Digital Converter (ADC) is used. Unless you can turn off the AGC, the use of these Cameras are highly discouraged for quantitative work.

`hasAnalogGain()` ¶

Checks whether the AnalogGain attribute is present.

This field reports the Analog Gain (also known as Inherent Gain or simply as Gain) that was applied during the Acquisition of this Image. The Analog Gain is a property Inherent to the Detector and it specifies how many electrons correspond to 1 signal unit (photon) detected. Gain is reported in terms of electrons/ADU (analog-to-digital unit). A gain of 8 means that the Detector digitizes the light signal so that each ADU corresponds to 8 photoelectrons. NOTE: In the case of Point Detectors the value of Analog Gain can be set freely by the user. Conversely, in the case of Cameras, it is common for the Gain to be preset by the Manufacturer to minimize noise. In this case, either the Analog Gain cannot be changed or the user is given the choice of selecting between a few preset Analog Gains values upon Acquisition. Finally, several Cameras might have so-called Automatic Gain Control (AGC or AutoGain) that will automatically adjusts so the full range of the Analog-to-Digital Converter (ADC) is used. Unless you can turn off the AGC, the use of these Cameras are highly discouraged for quantitative work.

Returns:

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

`setAmplificationGain(value, validate=True)` ¶

Sets the value of the AmplificationGain attribute.

This field reports the Amplification Gain (i.e., electronic gain as apposed to the inherent Gain) that was set during the Acquisition of this Image. Amplification Gain in general measures of the ability of a Detector to add energy to the input light signal therefore increasing its power or amplitude. Higher Amplification Gain levels amplify the signal and result in greater brightness, contrast and background signal. Examples include: 1) the Electron Multiplication (EM) gain (as opposed to the inherent Analog Gain) for an EMCCD camera. 2) The Gain introduced by the Micro-Channel Plate in an Intensified CCD or CMOS camera. 3) The amplification of the electron current provided by a Photomultiplier Tube, and measured as the ratio of the input photoelectron current emitted by the photocatode and the current reaching the anode. 4) The signal amplification provided by an Avalache Photo Diode (APD).

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`

`getAmplificationGain()` ¶

Returns the value of the AmplificationGain attribute.

This field reports the Amplification Gain (i.e., electronic gain as apposed to the inherent Gain) that was set during the Acquisition of this Image. Amplification Gain in general measures of the ability of a Detector to add energy to the input light signal therefore increasing its power or amplitude. Higher Amplification Gain levels amplify the signal and result in greater brightness, contrast and background signal. Examples include: 1) the Electron Multiplication (EM) gain (as opposed to the inherent Analog Gain) for an EMCCD camera. 2) The Gain introduced by the Micro-Channel Plate in an Intensified CCD or CMOS camera. 3) The amplification of the electron current provided by a Photomultiplier Tube, and measured as the ratio of the input photoelectron current emitted by the photocatode and the current reaching the anode. 4) The signal amplification provided by an Avalache Photo Diode (APD).

Returns:

Type	Description
`float`	The value of the attribute

`resetAmplificationGain()` ¶

Resets the AmplificationGain attribute to an unset state.

This field reports the Amplification Gain (i.e., electronic gain as apposed to the inherent Gain) that was set during the Acquisition of this Image. Amplification Gain in general measures of the ability of a Detector to add energy to the input light signal therefore increasing its power or amplitude. Higher Amplification Gain levels amplify the signal and result in greater brightness, contrast and background signal. Examples include: 1) the Electron Multiplication (EM) gain (as opposed to the inherent Analog Gain) for an EMCCD camera. 2) The Gain introduced by the Micro-Channel Plate in an Intensified CCD or CMOS camera. 3) The amplification of the electron current provided by a Photomultiplier Tube, and measured as the ratio of the input photoelectron current emitted by the photocatode and the current reaching the anode. 4) The signal amplification provided by an Avalache Photo Diode (APD).

`hasAmplificationGain()` ¶

Checks whether the AmplificationGain attribute is present.

This field reports the Amplification Gain (i.e., electronic gain as apposed to the inherent Gain) that was set during the Acquisition of this Image. Amplification Gain in general measures of the ability of a Detector to add energy to the input light signal therefore increasing its power or amplitude. Higher Amplification Gain levels amplify the signal and result in greater brightness, contrast and background signal. Examples include: 1) the Electron Multiplication (EM) gain (as opposed to the inherent Analog Gain) for an EMCCD camera. 2) The Gain introduced by the Micro-Channel Plate in an Intensified CCD or CMOS camera. 3) The amplification of the electron current provided by a Photomultiplier Tube, and measured as the ratio of the input photoelectron current emitted by the photocatode and the current reaching the anode. 4) The signal amplification provided by an Avalache Photo Diode (APD).

Returns:

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

`setOffset(value, validate=True)` ¶

Sets the value of the Offset attribute.

If available, this field reports the actual Offset that was set for this Detector during the Acquisition of this Channel. Offset is an electronic baseline added to the output signal generated by the sensor to ensure that the resulting signal level always correspond to a positive number of counts. Offset defines the black level setting of the image and it should be adjusted so that the lowest signals are near the detection threshold. NOTE: Please note that most modern Cameras do not have the possibility of setting the Offset.

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`

`getOffset()` ¶

Returns the value of the Offset attribute.

If available, this field reports the actual Offset that was set for this Detector during the Acquisition of this Channel. Offset is an electronic baseline added to the output signal generated by the sensor to ensure that the resulting signal level always correspond to a positive number of counts. Offset defines the black level setting of the image and it should be adjusted so that the lowest signals are near the detection threshold. NOTE: Please note that most modern Cameras do not have the possibility of setting the Offset.

Returns:

Type	Description
`float`	The value of the attribute

`resetOffset()` ¶

`hasOffset()` ¶

Checks whether the Offset attribute is present.

If available, this field reports the actual Offset that was set for this Detector during the Acquisition of this Channel. Offset is an electronic baseline added to the output signal generated by the sensor to ensure that the resulting signal level always correspond to a positive number of counts. Offset defines the black level setting of the image and it should be adjusted so that the lowest signals are near the detection threshold. NOTE: Please note that most modern Cameras do not have the possibility of setting the Offset.

Returns:

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

`setOffsetMode(value, validate=True)` ¶

Sets the value of the OffsetMode attribute.

This field describes the way in which the Voltage Offset of the Detector is reported. It typically is expressed as an Arbitrary-units number, a Scaled percent (-100 to 100), or a a Voltage.

Parameters:

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

`getOffsetMode()` ¶

Returns the value of the OffsetMode attribute.

This field describes the way in which the Voltage Offset of the Detector is reported. It typically is expressed as an Arbitrary-units number, a Scaled percent (-100 to 100), or a a Voltage.

Returns:

Type	Description
`DetectorOffsetMode_Type`	The value of the attribute

`resetOffsetMode()` ¶

`hasOffsetMode()` ¶

Checks whether the optional OffsetMode attribute is present.

This field describes the way in which the Voltage Offset of the Detector is reported. It typically is expressed as an Arbitrary-units number, a Scaled percent (-100 to 100), or a a Voltage.

Returns:

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

DetectorSettings_Type¶

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

setEffectiveBitDepth(value, validate=True) ¶

getEffectiveBitDepth() ¶

resetEffectiveBitDepth() ¶

hasEffectiveBitDepth() ¶

setAnalogGain(value, validate=True) ¶

getAnalogGain() ¶

resetAnalogGain() ¶

hasAnalogGain() ¶

setAmplificationGain(value, validate=True) ¶

getAmplificationGain() ¶

resetAmplificationGain() ¶

hasAmplificationGain() ¶

setOffset(value, validate=True) ¶

getOffset() ¶

resetOffset() ¶

hasOffset() ¶

setOffsetMode(value, validate=True) ¶

getOffsetMode() ¶

resetOffsetMode() ¶

hasOffsetMode() ¶

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

`setEffectiveBitDepth(value, validate=True)` ¶

`getEffectiveBitDepth()` ¶

`resetEffectiveBitDepth()` ¶

`hasEffectiveBitDepth()` ¶

`setAnalogGain(value, validate=True)` ¶

`getAnalogGain()` ¶

`resetAnalogGain()` ¶

`hasAnalogGain()` ¶

`setAmplificationGain(value, validate=True)` ¶

`getAmplificationGain()` ¶

`resetAmplificationGain()` ¶

`hasAmplificationGain()` ¶

`setOffset(value, validate=True)` ¶

`getOffset()` ¶

`resetOffset()` ¶

`hasOffset()` ¶

`setOffsetMode(value, validate=True)` ¶

`getOffsetMode()` ¶

`resetOffsetMode()` ¶

`hasOffsetMode()` ¶