CameraSettings

Bases: DetectorSettings_Type

Represents the XML element CameraSettings.

This element refers to the Camera used to acquire this Channel and it holds the Settings that were applied to the Camera during this Acquisition.

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

setBinning(value)

Sets the value of the Binning attribute.

This field represents the number of adjacent pixels whose electric charge is combined in the resulting Image (e.g. binning

Parameters:

Name	Type	Description	Default
value	Binning_Type	The value to set	required

getBinning()

Returns the value of the Binning attribute.

This field represents the number of adjacent pixels whose electric charge is combined in the resulting Image (e.g. binning

Returns:

Type	Description
Binning_Type	The value of the attribute

resetBinning()

Resets the Binning attribute to an unset state.

This field represents the number of adjacent pixels whose electric charge is combined in the resulting Image (e.g. binning

hasBinning()

Checks whether the optional Binning attribute is present.

This field represents the number of adjacent pixels whose electric charge is combined in the resulting Image (e.g. binning

Returns:

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

setPixelReadOutRate(value)

Sets the value of the PixelReadOutRate attribute.

This represents the effective Pixel Readout Rate used for the Acquisition of this Channel. This value is defined as the inverse of the time required to digitize a single pixel (also referred to as serial conversion time). Pixel readout rate can be considered similar to a baud rate as it depends on the bytes per second that can be read from the detector and written on disk. Readout rates are usually given in pixels/second (e.g., 500 kilopixels/second).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPixelReadOutRate()

Returns the value of the PixelReadOutRate attribute.

This represents the effective Pixel Readout Rate used for the Acquisition of this Channel. This value is defined as the inverse of the time required to digitize a single pixel (also referred to as serial conversion time). Pixel readout rate can be considered similar to a baud rate as it depends on the bytes per second that can be read from the detector and written on disk. Readout rates are usually given in pixels/second (e.g., 500 kilopixels/second).

Returns:

Type	Description
float	The value of the attribute

setPixelReadOutRateUnit(value)

Sets the value of the PixelReadOutRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getPixelReadOutRateUnit()

Returns the value of the PixelReadOutRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetPixelReadOutRateUnit()

Resets the PixelReadOutRateUnit attribute to an unset state.

No description available in the XSD standard.

hasPixelReadOutRateUnit()

Checks whether the optional PixelReadOutRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setSensorExposureMode(value)

Sets the value of the SensorExposureMode attribute.

In case of a CMOS Camera and if selectable, this field reports the sensor Exposure modality used for the Acquisition of this Channel. In the Rolling Exposure mode adjacent rows of the array are exposed at slightly different times as the readout 'waves' sweep through each half of the sensor. In the Global Exposure mode (i.e., 'Snapshot' exposure mode) all pixels of the array are exposed simultaneously, thus enabling 'freeze frame' capture of fast moving or fast changing events. In this modality the CMOS Camera behaves like an interline CCD sensor.

Parameters:

Name	Type	Description	Default
value	CMOSSensorExposureMode_Type	The value to set	required

getSensorExposureMode()

Returns the value of the SensorExposureMode attribute.

In case of a CMOS Camera and if selectable, this field reports the sensor Exposure modality used for the Acquisition of this Channel. In the Rolling Exposure mode adjacent rows of the array are exposed at slightly different times as the readout 'waves' sweep through each half of the sensor. In the Global Exposure mode (i.e., 'Snapshot' exposure mode) all pixels of the array are exposed simultaneously, thus enabling 'freeze frame' capture of fast moving or fast changing events. In this modality the CMOS Camera behaves like an interline CCD sensor.

Returns:

Type	Description
CMOSSensorExposureMode_Type	The value of the attribute

resetSensorExposureMode()

Resets the SensorExposureMode attribute to an unset state.

In case of a CMOS Camera and if selectable, this field reports the sensor Exposure modality used for the Acquisition of this Channel. In the Rolling Exposure mode adjacent rows of the array are exposed at slightly different times as the readout 'waves' sweep through each half of the sensor. In the Global Exposure mode (i.e., 'Snapshot' exposure mode) all pixels of the array are exposed simultaneously, thus enabling 'freeze frame' capture of fast moving or fast changing events. In this modality the CMOS Camera behaves like an interline CCD sensor.

hasSensorExposureMode()

Checks whether the optional SensorExposureMode attribute is present.

In case of a CMOS Camera and if selectable, this field reports the sensor Exposure modality used for the Acquisition of this Channel. In the Rolling Exposure mode adjacent rows of the array are exposed at slightly different times as the readout 'waves' sweep through each half of the sensor. In the Global Exposure mode (i.e., 'Snapshot' exposure mode) all pixels of the array are exposed simultaneously, thus enabling 'freeze frame' capture of fast moving or fast changing events. In this modality the CMOS Camera behaves like an interline CCD sensor.

Returns:

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

setIntegration(value)

Sets the value of the Integration attribute.

This field represents the number of sequential frames that have been averaged to obtain this image, to improve the overall signal-to-noise ratio.

Parameters:

Name	Type	Description	Default
value	PositiveInt_Type	The value to set	required

getIntegration()

Returns the value of the Integration attribute.

This field represents the number of sequential frames that have been averaged to obtain this image, to improve the overall signal-to-noise ratio.

Returns:

Type	Description
PositiveInt_Type	The value of the attribute

resetIntegration()

Resets the Integration attribute to an unset state.

This field represents the number of sequential frames that have been averaged to obtain this image, to improve the overall signal-to-noise ratio.

hasIntegration()

Checks whether the optional Integration attribute is present.

This field represents the number of sequential frames that have been averaged to obtain this image, to improve the overall signal-to-noise ratio.

Returns:

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

setFrameRate(value)

Sets the value of the FrameRate attribute.

Frame Rate is the inverse of the time needed for the CCD to acquire a single Frame (or Plane) and then completely read that image out. Frame Rate is typically expressed in frames per second (fps). Often, the Frame Rate can be approximately calculated from the total number of pixels and the readout rate, combined with the total exposure time. This field represents the effective Frame Rate used for the Acquisition of this Image.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getFrameRate()

Returns the value of the FrameRate attribute.

Frame Rate is the inverse of the time needed for the CCD to acquire a single Frame (or Plane) and then completely read that image out. Frame Rate is typically expressed in frames per second (fps). Often, the Frame Rate can be approximately calculated from the total number of pixels and the readout rate, combined with the total exposure time. This field represents the effective Frame Rate used for the Acquisition of this Image.

Returns:

Type	Description
float	The value of the attribute

setFrameRateUnit(value)

Sets the value of the FrameRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getFrameRateUnit()

Returns the value of the FrameRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetFrameRateUnit()

Resets the FrameRateUnit attribute to an unset state.

No description available in the XSD standard.

hasFrameRateUnit()

Checks whether the optional FrameRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setOperatingTemperature(value)

Sets the value of the OperatingTemperature attribute.

This field represents the effective temperature the sensor was kept at during the Acquisition of this image.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getOperatingTemperature()

Returns the value of the OperatingTemperature attribute.

This field represents the effective temperature the sensor was kept at during the Acquisition of this image.

Returns:

Type	Description
float	The value of the attribute

resetOperatingTemperature()

Resets the OperatingTemperature attribute to an unset state.

This field represents the effective temperature the sensor was kept at during the Acquisition of this image.

hasOperatingTemperature()

Checks whether the optional OperatingTemperature attribute is present.

This field represents the effective temperature the sensor was kept at during the Acquisition of this image.

Returns:

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

setOperatingTemperatureUnit(value)

Sets the value of the OperatingTemperatureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTemperature_Type	The value to set	required

getOperatingTemperatureUnit()

Returns the value of the OperatingTemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetOperatingTemperatureUnit()

Resets the OperatingTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasOperatingTemperatureUnit()

Checks whether the optional OperatingTemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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