Bases: ManufacturerSpec_Type
Represents the XML complex type Detector.
This element describes a Detector available for this Instrument. An Instrument may have more than one Detector of different types, such as a Photomultiplier, or a Camera. The Detector ID can be used as a reference within the Channel element. The values stored in Detector represent the fixed values, variable values modified during the Acquisition go in DetectorSettings.
fromBase ( base )
staticmethod
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 )
setName ( value , validate = True )
setMount ( value , validate = True )
setMaxBitDepth ( value , validate = True )
setQuantumEfficiency ( value , validate = True )
Sets the value of the QuantumEfficiency attribute.
This field records the Quantum Efficiency observed at Peak Wavelength, according to the Manufacturer. Quantum Efficiency is generally defined as is the ratio of incident photons to converted electrons. Typically expressed as a number between 0 and 1.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getQuantumEfficiency ()
Returns the value of the QuantumEfficiency attribute.
This field records the Quantum Efficiency observed at Peak Wavelength, according to the Manufacturer. Quantum Efficiency is generally defined as is the ratio of incident photons to converted electrons. Typically expressed as a number between 0 and 1.
Returns:
Type
Description
float
The value of the attribute
resetQuantumEfficiency ()
Resets the QuantumEfficiency attribute to an unset state.
This field records the Quantum Efficiency observed at Peak Wavelength, according to the Manufacturer. Quantum Efficiency is generally defined as is the ratio of incident photons to converted electrons. Typically expressed as a number between 0 and 1.
hasQuantumEfficiency ()
Checks whether the QuantumEfficiency attribute is present.
This field records the Quantum Efficiency observed at Peak Wavelength, according to the Manufacturer. Quantum Efficiency is generally defined as is the ratio of incident photons to converted electrons. Typically expressed as a number between 0 and 1.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setElectronicConversionFactor ( value , validate = True )
Sets the value of the ElectronicConversionFactor attribute.
This field records the Electron-Conversion Factor for this Detector, as specified by the Manufacturer. The Electron Conversion Factor relates the actual number of electrons generated by the Detector with the digital number associated with each Pixel. It is expressed in electrons/Analog-to-Digital-Unit (ADU). Note that ADU can also be referred to as Digital Number (DN) or Binary Number. It is sometimes referred to as Digital Gain or, in case of CCD cameras as CCD Gain.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getElectronicConversionFactor ()
Returns the value of the ElectronicConversionFactor attribute.
This field records the Electron-Conversion Factor for this Detector, as specified by the Manufacturer. The Electron Conversion Factor relates the actual number of electrons generated by the Detector with the digital number associated with each Pixel. It is expressed in electrons/Analog-to-Digital-Unit (ADU). Note that ADU can also be referred to as Digital Number (DN) or Binary Number. It is sometimes referred to as Digital Gain or, in case of CCD cameras as CCD Gain.
Returns:
Type
Description
float
The value of the attribute
resetElectronicConversionFactor ()
Resets the ElectronicConversionFactor attribute to an unset state.
This field records the Electron-Conversion Factor for this Detector, as specified by the Manufacturer. The Electron Conversion Factor relates the actual number of electrons generated by the Detector with the digital number associated with each Pixel. It is expressed in electrons/Analog-to-Digital-Unit (ADU). Note that ADU can also be referred to as Digital Number (DN) or Binary Number. It is sometimes referred to as Digital Gain or, in case of CCD cameras as CCD Gain.
hasElectronicConversionFactor ()
Checks whether the ElectronicConversionFactor attribute is present.
This field records the Electron-Conversion Factor for this Detector, as specified by the Manufacturer. The Electron Conversion Factor relates the actual number of electrons generated by the Detector with the digital number associated with each Pixel. It is expressed in electrons/Analog-to-Digital-Unit (ADU). Note that ADU can also be referred to as Digital Number (DN) or Binary Number. It is sometimes referred to as Digital Gain or, in case of CCD cameras as CCD Gain.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setReadOutNoise ( value , validate = True )
Sets the value of the ReadOutNoise attribute.
This field captures the Read-out Noise associated with this Detector, as specified by the Manufacturer. Read-out Noise is a constant amount of noise and it includes thermal noise build-up and clock induced charge added by the CCD chip, the readout amplifier and surrounding electronics. It is generally expressed in photo-electrons (i.e., e- root-mean-square).
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getReadOutNoise ()
Returns the value of the ReadOutNoise attribute.
This field captures the Read-out Noise associated with this Detector, as specified by the Manufacturer. Read-out Noise is a constant amount of noise and it includes thermal noise build-up and clock induced charge added by the CCD chip, the readout amplifier and surrounding electronics. It is generally expressed in photo-electrons (i.e., e- root-mean-square).
Returns:
Type
Description
float
The value of the attribute
resetReadOutNoise ()
Resets the ReadOutNoise attribute to an unset state.
This field captures the Read-out Noise associated with this Detector, as specified by the Manufacturer. Read-out Noise is a constant amount of noise and it includes thermal noise build-up and clock induced charge added by the CCD chip, the readout amplifier and surrounding electronics. It is generally expressed in photo-electrons (i.e., e- root-mean-square).
hasReadOutNoise ()
Checks whether the ReadOutNoise attribute is present.
This field captures the Read-out Noise associated with this Detector, as specified by the Manufacturer. Read-out Noise is a constant amount of noise and it includes thermal noise build-up and clock induced charge added by the CCD chip, the readout amplifier and surrounding electronics. It is generally expressed in photo-electrons (i.e., e- root-mean-square).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setReadNoiseUnit ( value , validate = True )
setDetectorNoiseModel ( value , validate = True )
resetDetectorNoiseModel ()
setDarkCurrentRate ( value , validate = True )
Sets the value of the DarkCurrentRate attribute.
This field records the Dark Current Rate of this Detector as specified by the Manufacturer. The Dark Current Rate is the median current detected in the absence of light. Generally expressed in e-/Pixel/sec.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getDarkCurrentRate ()
Returns the value of the DarkCurrentRate attribute.
This field records the Dark Current Rate of this Detector as specified by the Manufacturer. The Dark Current Rate is the median current detected in the absence of light. Generally expressed in e-/Pixel/sec.
Returns:
Type
Description
float
The value of the attribute
resetDarkCurrentRate ()
Resets the DarkCurrentRate attribute to an unset state.
This field records the Dark Current Rate of this Detector as specified by the Manufacturer. The Dark Current Rate is the median current detected in the absence of light. Generally expressed in e-/Pixel/sec.
hasDarkCurrentRate ()
Checks whether the DarkCurrentRate attribute is present.
This field records the Dark Current Rate of this Detector as specified by the Manufacturer. The Dark Current Rate is the median current detected in the absence of light. Generally expressed in e-/Pixel/sec.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setDarkCurrentRateUnit ( value , validate = True )
resetDarkCurrentRateUnit ()
setDynamicRange ( value , validate = True )
setDynamicRangeUnit ( value , validate = True )
setAmbientOperatingTemperature ( value , validate = True )
Sets the value of the AmbientOperatingTemperature attribute.
This field records the Ambient Temperature at which this Detector is designed to operate, according to the Manufacturer.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getAmbientOperatingTemperature ()
Returns the value of the AmbientOperatingTemperature attribute.
This field records the Ambient Temperature at which this Detector is designed to operate, according to the Manufacturer.
Returns:
Type
Description
float
The value of the attribute
resetAmbientOperatingTemperature ()
Resets the AmbientOperatingTemperature attribute to an unset state.
This field records the Ambient Temperature at which this Detector is designed to operate, according to the Manufacturer.
hasAmbientOperatingTemperature ()
Checks whether the AmbientOperatingTemperature attribute is present.
This field records the Ambient Temperature at which this Detector is designed to operate, according to the Manufacturer.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setAmbientOperatingTemperatureUnit ( value , validate = True )
getAmbientOperatingTemperatureUnit ()
resetAmbientOperatingTemperatureUnit ()
hasAmbientOperatingTemperatureUnit ()
setAmbientOperatingHumidity ( value , validate = True )
Sets the value of the AmbientOperatingHumidity attribute.
This field records the Ambient Humidity at which this detector is designed to operate, according to the Manufacturer.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getAmbientOperatingHumidity ()
Returns the value of the AmbientOperatingHumidity attribute.
This field records the Ambient Humidity at which this detector is designed to operate, according to the Manufacturer.
Returns:
Type
Description
float
The value of the attribute
resetAmbientOperatingHumidity ()
Resets the AmbientOperatingHumidity attribute to an unset state.
This field records the Ambient Humidity at which this detector is designed to operate, according to the Manufacturer.
hasAmbientOperatingHumidity ()
Checks whether the AmbientOperatingHumidity attribute is present.
This field records the Ambient Humidity at which this detector is designed to operate, according to the Manufacturer.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setRelayLensRef ( value , validate = True )
setAnnotationRef_List ( value , validate = True )
addToAnnotationRef_List ( value , validate = True )
clearAnnotationRef_List ()
setWavelengthRange_List ( value , validate = True )
Sets the list of WavelengthRange elements.
This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.
Parameters:
Name
Type
Description
Default
value
List [Detector_Type_InlineWavelengthRange ]
The new list of WavelengthRange elements
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getWavelengthRange_List ()
Returns the list of WavelengthRange elements.
This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.
Returns:
Type
Description
List[Detector_Type_InlineWavelengthRange]
The list of WavelengthRange elements
addToWavelengthRange_List ( value , validate = True )
Adds a new WavelengthRange element to this object.
This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.
Parameters:
clearWavelengthRange_List ()
Clear the list of WavelengthRange.
This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.