Detector_Type

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

Cast a NBOBaseClass to a CMOS.

Parameters:

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

Returns:

Type	Description
Detector_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()

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

setName(value, validate=True)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

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

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setMount(value, validate=True)

Sets the value of the Mount attribute.

This field records the type of Mount used to connect this detector to the Microscope Stand.

Parameters:

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

getMount()

Returns the value of the Mount attribute.

This field records the type of Mount used to connect this detector to the Microscope Stand.

Returns:

Type	Description
DetectorMount_Type	The value of the attribute

resetMount()

Resets the Mount attribute to an unset state.

This field records the type of Mount used to connect this detector to the Microscope Stand.

hasMount()

Checks whether the optional Mount attribute is present.

This field records the type of Mount used to connect this detector to the Microscope Stand.

Returns:

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

setMaxBitDepth(value, validate=True)

Sets the value of the MaxBitDepth attribute.

This field records the Maximum Bit Depth provided by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer).

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

getMaxBitDepth()

Returns the value of the MaxBitDepth attribute.

This field records the Maximum Bit Depth provided by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer).

Returns:

Type	Description
DigitizerType_Type	The value of the attribute

resetMaxBitDepth()

Resets the MaxBitDepth attribute to an unset state.

This field records the Maximum Bit Depth provided by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer).

hasMaxBitDepth()

Checks whether the optional MaxBitDepth attribute is present.

This field records the Maximum Bit Depth provided by the Detector's Analog to Digital Converter (ADC; also referred to as Digitizer).

Returns:

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

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	The value to set	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	The value to set	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	The value to set	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)

Sets the value of the ReadNoiseUnit attribute.

No description available in the XSD standard.

Parameters:

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

getReadNoiseUnit()

Returns the value of the ReadNoiseUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsElectricCurrent_Type	The value of the attribute

resetReadNoiseUnit()

Resets the ReadNoiseUnit attribute to an unset state.

No description available in the XSD standard.

hasReadNoiseUnit()

Checks whether the optional ReadNoiseUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setDetectorNoiseModel(value, validate=True)

Sets the value of the DetectorNoiseModel attribute.

This field records the Noise Model associated with this Detector.

Parameters:

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

getDetectorNoiseModel()

Returns the value of the DetectorNoiseModel attribute.

This field records the Noise Model associated with this Detector.

Returns:

Type	Description
DetectorNoiseModel_Type	The value of the attribute

resetDetectorNoiseModel()

Resets the DetectorNoiseModel attribute to an unset state.

This field records the Noise Model associated with this Detector.

hasDetectorNoiseModel()

Checks whether the optional DetectorNoiseModel attribute is present.

This field records the Noise Model associated with this Detector.

Returns:

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

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	The value to set	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)

Sets the value of the DarkCurrentRateUnit attribute.

No description available in the XSD standard.

Parameters:

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

getDarkCurrentRateUnit()

Returns the value of the DarkCurrentRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsElectricCurrent_Type	The value of the attribute

resetDarkCurrentRateUnit()

Resets the DarkCurrentRateUnit attribute to an unset state.

No description available in the XSD standard.

hasDarkCurrentRateUnit()

Checks whether the optional DarkCurrentRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setDynamicRange(value, validate=True)

Sets the value of the DynamicRange attribute.

This field records the Dynamic Range of this Detector in deciBel (dB).

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

getDynamicRange()

Returns the value of the DynamicRange attribute.

This field records the Dynamic Range of this Detector in deciBel (dB).

Returns:

Type	Description
float	The value of the attribute

resetDynamicRange()

Resets the DynamicRange attribute to an unset state.

This field records the Dynamic Range of this Detector in deciBel (dB).

hasDynamicRange()

Checks whether the DynamicRange attribute is present.

This field records the Dynamic Range of this Detector in deciBel (dB).

Returns:

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

setDynamicRangeUnit(value, validate=True)

Sets the value of the DynamicRangeUnit attribute.

No description available in the XSD standard.

Parameters:

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

getDynamicRangeUnit()

Returns the value of the DynamicRangeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsRatio_Type	The value of the attribute

resetDynamicRangeUnit()

Resets the DynamicRangeUnit attribute to an unset state.

No description available in the XSD standard.

hasDynamicRangeUnit()

Checks whether the optional DynamicRangeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

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	The value to set	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)

Sets the value of the AmbientOperatingTemperatureUnit attribute.

No description available in the XSD standard.

Parameters:

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

getAmbientOperatingTemperatureUnit()

Returns the value of the AmbientOperatingTemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetAmbientOperatingTemperatureUnit()

Resets the AmbientOperatingTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasAmbientOperatingTemperatureUnit()

Checks whether the optional AmbientOperatingTemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

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	The value to set	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)

Sets the value of the RelayLensRef element.

This is a reference to a lens positioned at the mount connecting this detector to the microscope body.

Parameters:

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

getRelayLensRef()

Returns the value of the RelayLensRef element.

This is a reference to a lens positioned at the mount connecting this detector to the microscope body.

Returns:

Type	Description
LensRef_Type	The value of the element

resetRelayLensRef()

Resets the RelayLensRef element to an unset state.

This is a reference to a lens positioned at the mount connecting this detector to the microscope body.

hasRelayLensRef()

Checks whether the optional RelayLensRef element is present.

This is a reference to a lens positioned at the mount connecting this detector to the microscope body.

Returns:

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

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

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:

Name	Type	Description	Default
value	Detector_Type_InlineWavelengthRange	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

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.