com.inscoper.nbo.CameraSettings

Represents the XML element CameraSettings. More...

Inherits from com.inscoper.nbo.DetectorSettings_Type, com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	CameraSettings()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setBinning(Binning_Type value) Sets the value of the Binning attribute.
Binning_Type	getBinning() Returns the value of the Binning attribute.
void	resetBinning() Resets the Binning attribute to an unset state.
boolean	hasBinning() Checks whether the optional Binning attribute is present.
void	setPixelReadOutRate(float value) Sets the value of the PixelReadOutRate attribute.
float	getPixelReadOutRate() Returns the value of the PixelReadOutRate attribute.
void	setPixelReadOutRateUnit(UnitsFrequency_Type value) Sets the value of the PixelReadOutRateUnit attribute.
UnitsFrequency_Type	getPixelReadOutRateUnit() Returns the value of the PixelReadOutRateUnit attribute.
void	resetPixelReadOutRateUnit() Resets the PixelReadOutRateUnit attribute to an unset state.
boolean	hasPixelReadOutRateUnit() Checks whether the optional PixelReadOutRateUnit attribute is present.
void	setSensorExposureMode(CMOSSensorExposureMode_Type value) Sets the value of the SensorExposureMode attribute.
CMOSSensorExposureMode_Type	getSensorExposureMode() Returns the value of the SensorExposureMode attribute.
void	resetSensorExposureMode() Resets the SensorExposureMode attribute to an unset state.
boolean	hasSensorExposureMode() Checks whether the optional SensorExposureMode attribute is present.
void	setIntegration(PositiveInt_Type value) Sets the value of the Integration attribute.
PositiveInt_Type	getIntegration() Returns the value of the Integration attribute.
void	resetIntegration() Resets the Integration attribute to an unset state.
boolean	hasIntegration() Checks whether the optional Integration attribute is present.
void	setFrameRate(float value) Sets the value of the FrameRate attribute.
float	getFrameRate() Returns the value of the FrameRate attribute.
void	setFrameRateUnit(UnitsFrequency_Type value) Sets the value of the FrameRateUnit attribute.
UnitsFrequency_Type	getFrameRateUnit() Returns the value of the FrameRateUnit attribute.
void	resetFrameRateUnit() Resets the FrameRateUnit attribute to an unset state.
boolean	hasFrameRateUnit() Checks whether the optional FrameRateUnit attribute is present.
void	setOperatingTemperature(float value) Sets the value of the OperatingTemperature attribute.
float	getOperatingTemperature() Returns the value of the OperatingTemperature attribute.
void	resetOperatingTemperature() Resets the OperatingTemperature attribute to an unset state.
boolean	hasOperatingTemperature() Checks whether the optional OperatingTemperature attribute is present.
void	setOperatingTemperatureUnit(UnitsTemperature_Type value) Sets the value of the OperatingTemperatureUnit attribute.
UnitsTemperature_Type	getOperatingTemperatureUnit() Returns the value of the OperatingTemperatureUnit attribute.
void	resetOperatingTemperatureUnit() Resets the OperatingTemperatureUnit attribute to an unset state.
boolean	hasOperatingTemperatureUnit() Checks whether the optional OperatingTemperatureUnit attribute is present.
CameraSettings	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	CameraSettings(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(CameraSettings obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.DetectorSettings_Type

	Name
	DetectorSettings_Type()
void	setID(DetectorID_Type value) Sets the value of the ID attribute.
DetectorID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setEffectiveBitDepth(DigitizerType_Type value) Sets the value of the EffectiveBitDepth attribute.
DigitizerType_Type	getEffectiveBitDepth() Returns the value of the EffectiveBitDepth attribute.
void	resetEffectiveBitDepth() Resets the EffectiveBitDepth attribute to an unset state.
boolean	hasEffectiveBitDepth() Checks whether the optional EffectiveBitDepth attribute is present.
void	setAnalogGain(float value) Sets the value of the AnalogGain attribute.
float	getAnalogGain() Returns the value of the AnalogGain attribute.
void	setAmplificationGain(float value) Sets the value of the AmplificationGain attribute.
float	getAmplificationGain() Returns the value of the AmplificationGain attribute.
void	setOffset(float value) Sets the value of the Offset attribute.
float	getOffset() Returns the value of the Offset attribute.
void	resetOffset() Resets the Offset attribute to an unset state.
boolean	hasOffset() Checks whether the optional Offset attribute is present.
void	setOffsetMode(DetectorOffsetMode_Type value) Sets the value of the OffsetMode attribute.
DetectorOffsetMode_Type	getOffsetMode() Returns the value of the OffsetMode attribute.
void	resetOffsetMode() Resets the OffsetMode attribute to an unset state.
boolean	hasOffsetMode() Checks whether the optional OffsetMode attribute is present.

Protected Functions inherited from com.inscoper.nbo.DetectorSettings_Type

	Name
	DetectorSettings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.CameraSettings;

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.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.DetectorSettings_Type.delete

function CameraSettings

public CameraSettings()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.DetectorSettings_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.DetectorSettings_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.DetectorSettings_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.DetectorSettings_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.DetectorSettings_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.DetectorSettings_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.DetectorSettings_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.DetectorSettings_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.DetectorSettings_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.DetectorSettings_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.DetectorSettings_Type.toXmlString

function setBinning

public void setBinning(
    Binning_Type value
)

Sets the value of the Binning attribute.

Parameters:

value The value to set

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

function getBinning

public Binning_Type getBinning()

Returns the value of the Binning attribute.

Return: The value of the attribute

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

function resetBinning

public void 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

function hasBinning

public boolean hasBinning()

Checks whether the optional Binning attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function setPixelReadOutRate

public void setPixelReadOutRate(
    float value
)

Sets the value of the PixelReadOutRate attribute.

Parameters:

value The value to set

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

function getPixelReadOutRate

public float getPixelReadOutRate()

Returns the value of the PixelReadOutRate attribute.

Return: The value of the 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).

function setPixelReadOutRateUnit

public void setPixelReadOutRateUnit(
    UnitsFrequency_Type value
)

Sets the value of the PixelReadOutRateUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPixelReadOutRateUnit

public UnitsFrequency_Type getPixelReadOutRateUnit()

Returns the value of the PixelReadOutRateUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPixelReadOutRateUnit

public void resetPixelReadOutRateUnit()

Resets the PixelReadOutRateUnit attribute to an unset state.

No description available in the XSD standard.

function hasPixelReadOutRateUnit

public boolean hasPixelReadOutRateUnit()

Checks whether the optional PixelReadOutRateUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setSensorExposureMode

public void setSensorExposureMode(
    CMOSSensorExposureMode_Type value
)

Sets the value of the SensorExposureMode attribute.

Parameters:

value The value to set

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.

function getSensorExposureMode

public CMOSSensorExposureMode_Type getSensorExposureMode()

Returns the value of the SensorExposureMode attribute.

Return: The value of the 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.

function resetSensorExposureMode

public void 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.

function hasSensorExposureMode

public boolean hasSensorExposureMode()

Checks whether the optional SensorExposureMode attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setIntegration

public void setIntegration(
    PositiveInt_Type value
)

Sets the value of the Integration attribute.

Parameters:

value The value to set

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

function getIntegration

public PositiveInt_Type getIntegration()

Returns the value of the Integration attribute.

Return: The value of the 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.

function resetIntegration

public void 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.

function hasIntegration

public boolean hasIntegration()

Checks whether the optional Integration attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function setFrameRate

public void setFrameRate(
    float value
)

Sets the value of the FrameRate attribute.

Parameters:

value The value to set

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.

function getFrameRate

public float getFrameRate()

Returns the value of the FrameRate attribute.

Return: The value of the 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.

function setFrameRateUnit

public void setFrameRateUnit(
    UnitsFrequency_Type value
)

Sets the value of the FrameRateUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getFrameRateUnit

public UnitsFrequency_Type getFrameRateUnit()

Returns the value of the FrameRateUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetFrameRateUnit

public void resetFrameRateUnit()

Resets the FrameRateUnit attribute to an unset state.

No description available in the XSD standard.

function hasFrameRateUnit

public boolean hasFrameRateUnit()

Checks whether the optional FrameRateUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setOperatingTemperature

public void setOperatingTemperature(
    float value
)

Sets the value of the OperatingTemperature attribute.

Parameters:

value The value to set

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

function getOperatingTemperature

public float getOperatingTemperature()

Returns the value of the OperatingTemperature attribute.

Return: The value of the attribute

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

function resetOperatingTemperature

public void 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.

function hasOperatingTemperature

public boolean hasOperatingTemperature()

Checks whether the optional OperatingTemperature attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function setOperatingTemperatureUnit

public void setOperatingTemperatureUnit(
    UnitsTemperature_Type value
)

Sets the value of the OperatingTemperatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getOperatingTemperatureUnit

public UnitsTemperature_Type getOperatingTemperatureUnit()

Returns the value of the OperatingTemperatureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetOperatingTemperatureUnit

public void resetOperatingTemperatureUnit()

Resets the OperatingTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

function hasOperatingTemperatureUnit

public boolean hasOperatingTemperatureUnit()

Checks whether the optional OperatingTemperatureUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function __internal_create

public static CameraSettings __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.DetectorSettings_Type.__internal_create

Protected Functions Documentation

function CameraSettings

protected CameraSettings(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.DetectorSettings_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.DetectorSettings_Type.finalize

function getCPtr

protected static long getCPtr(
    CameraSettings obj
)

Updated on 2026-02-13 at 16:10:56 +0100