Interface defining the API for interacting with Optris thermal cameras. More...

#include <IRImager.h>

Collaboration diagram for optris::IRImager:

Public Member Functions
	IRImager ()=default
	Constructor.

	IRImager (const IRImager &)=delete
	No copy constructor.

IRImager &	operator= (const IRImager &)=delete
	No copy assignment.

	IRImager (IRImager &&)=delete
	No move constructor.

IRImager &	operator= (IRImager &&)=delete
	No move assignment.

virtual	~IRImager ()=default
	Destructor.

virtual void	connect (IRImagerConfig config)=0
	Connects to the device with the given configuration.

virtual void	connect (const DeviceInfo &deviceInfo)=0
	Connects to the device with the given device information.

virtual void	connect (unsigned long serialNumber)=0
	Connects to the device with the given serial number.

virtual void	disconnect ()=0
	Disconnects from the current device.

virtual bool	isConnected () const noexcept=0
	Returns whether a connection is established.

virtual void	addClient (IRImagerClient *client)=0
	Adds an observer/client that will be updated when new data arrives.

virtual bool	removeClient (IRImagerClient *client)=0
	Removes the given observer/client.

virtual void	run ()=0
	Runs the processing loop continuously.

virtual bool	runAsync ()=0
	Runs the processing loop continuously in a dedicated thread.

virtual void	stopRunning ()=0
	Stops the continuously running processing loop.

virtual bool	isRunning () const noexcept=0
	Returns whether the processing loop is currently running.

virtual DeviceType	getDeviceType () const =0
	Returns the type of device the IRImager is connected to.

virtual unsigned long	getSerialNumber () const =0
	Returns the serial number of the connected device.

virtual unsigned int	getHardwareRevision () const =0
	Returns the hardware revision of the connected device.

virtual unsigned int	getFirmwareRevision () const =0
	Returns the firmware revision of the connected device.

virtual std::string	getConnectionInterface () const noexcept=0
	Returns the name of the connection interface used to communication with the device.

virtual IpAddress	getIpAddress () const noexcept=0
	Returns the IP address of the connected device.

virtual Port	getPort () const noexcept=0
	Returns the number of the port on which the device data is received.

virtual std::vector< std::shared_ptr< OperationMode > >	getOperationModes ()=0
	Returns the operation modes for the currently connected device.

virtual void	setActiveOperationMode (const std::shared_ptr< OperationMode > &mode)=0
	Sets the active operation mode for the currently connected device.

virtual void	setActiveOperationMode (int opticsFieldOfView, const std::string &opticsText, float temperatureLowerLimit, float temperatureUpperLimit, int width, int height, int framerate)=0
	Sets the active operation mode for the currently connected device.

virtual std::shared_ptr< OperationMode >	getActiveOperationMode ()=0
	Returns the active operation mode for the currently connected device.

virtual void	setSoSCorrectionEnabled (bool enable)=0
	Enables or disables the Size of Source Correction.

virtual bool	isSoSCorrectionEnabled () const =0
	Checks if the Size of Source Correction is enabled.

virtual void	setTemperatureRangeExtensionEnabled (bool enabled)=0
	Die-/Enables temperature range extension.

virtual bool	isTemperatureRangeExtensionEnabled () const noexcept=0
	Returns whether the temperature ranges are being extended.

virtual void	setTemperatureHighPrecisionEnabled (bool enabled)=0
	Dis-/Enables high precision temperature measurements.

virtual bool	isTemperatureHighPrecisionEnabled () const noexcept=0
	Returns whether high precision temperature measurements are enabled.

virtual int	getWidth () const =0
	Returns the width in pixels of the thermal frame.

virtual int	getHeight () const =0
	Returns the height in pixels of thermal frame.

virtual int	addMeasurementField (const MeasurementFieldConfig &config)=0
	Adds a measurement field that is processed for every new thermal frame.

virtual void	setAutoFlagEnabled (bool enable)=0
	Sets the automatic triggering of flag cycles en-/disabled.

virtual bool	isAutoFlagEnabled () const =0
	Returns whether flag cycles are triggered automatically.

virtual void	setFlagInterval (float minInterval, float maxInterval)=0
	Sets the minimum and maximum flag intervals in seconds.

virtual float	getFlagMinInterval () const =0
	Returns the minimum flag interval in seconds.

virtual float	getFlagMaxInterval () const =0
	Returns the maximum flag interval in seconds.

virtual void	forceFlagEvent (float time=0.F)=0
	Force a flag cycle manually.

virtual bool	isFlagOpen () const =0
	Returns whether the shutter flag is open.

virtual void	setFlagForecastEnabled (bool enable)=0
	Set the shutter flag forecast en-/disabled.

virtual bool	isFlagForecastEnabled () const =0
	Returns whether the shutter flag forecast is en-/disabled.

virtual float	getTemperatureFlag () const =0
	Returns the temperature of the shutter flag in °C.

virtual float	getTemperatureBox () const =0
	Returns the temperature of the device housing in °C.

virtual float	getTemperatureChip () const =0
	Returns the temperature of the sensor chip.

virtual void	setChipHeatingEnabled (bool enable)=0
	Enables the heating of the sensor chip.

virtual bool	isChipHeatingEnabled () const =0
	Return whether the sensor chip heating is enabled.

virtual void	setTemperatureChipReference (float temperature)=0
	Sets the reference temperature in °C for the sensor chip heating.

virtual float	getTemperatureChipReference () const =0
	Returns the reference temperature in °C of the sensor chip heating.

virtual RadiationParameterSource	getEmissivitySource () const noexcept=0
	Returns the source that currently defines the emissivity for the thermal frame.

virtual RadiationParameterSource	getTransmissivitySource () const noexcept=0
	Returns the source that currently defines the transmissivity for the thermal frame.

virtual RadiationParameterSource	getAmbientTemperatureSource () const noexcept=0
	Returns the source that currently defines the ambient temperature for the thermal frame.

virtual void	setRadiationParameters (const RadiationParameters &radiation)=0
	Sets the radiation parameters (emissivity, transmissivity and ambient temperature).

virtual RadiationParameters	getRadiationParameters () const =0
	Returns the set/configured radiation parameters.

virtual void	setFocusMotorPosition (float position)=0
	Sets the position of the focus motor.

virtual float	getFocusMotorPosition () const =0
	Returns the position of the focus motor.

virtual void	setReferenceTemperature (float referenceTemperature, float measuredTemperature, float ambientTemperature=INVALID_TEMPERATURE)=0
	Sets a reference temperature to a known reference source inside the view of the device to improve measurement accuracy.

virtual void	resetReferenceTemperature ()=0
	Resets a previously set reference temperature.

virtual void	setDeviceNetworkConfig (const DeviceNetworkConfig &networkConfig)=0
	Sets the network configuration of the device.

virtual DeviceNetworkConfig	getDeviceNetworkConfig ()=0
	Returns the network configuration of the device.

virtual ProcessInterface &	getPif ()=0
	Grants access to the process interface.

virtual const ProcessInterface &	getPif () const =0
	Grants read access to the process interface.

virtual void	interruptFailSafe (bool active, const std::string &reason)=0
	Interrups the all clear fail safe signal.

Detailed Description

Interface defining the API for interacting with Optris thermal cameras.

Member Function Documentation

◆ addClient()

virtual void optris::IRImager::addClient ( IRImagerClient * client )

pure virtual

Adds an observer/client that will be updated when new data arrives.

Parameters

[in] client callback client.

◆ addMeasurementField()

virtual int optris::IRImager::addMeasurementField ( const MeasurementFieldConfig & config )

pure virtual

Adds a measurement field that is processed for every new thermal frame.

The resulting data can be accessed via the IRImagerClient::onMeasurementField() callback.

Parameters

[in] config of the measurement field to add.

Returns: the index of the added measurement field.

Exceptions

SDKException if not connected or if the measurement field is not completely within the thermal frame or if adding it failed.

◆ connect() [1/3]

virtual void optris::IRImager::connect ( const DeviceInfo & deviceInfo )

pure virtual

Connects to the device with the given device information.

Note: If the serial number is set to 0, the SDK will use the EnumerationManager to find a device to connect to.

Parameters

[in] deviceInfo device information.

Exceptions

SDKException if connecting fails.

◆ connect() [2/3]

virtual void optris::IRImager::connect ( IRImagerConfig config )

pure virtual

Connects to the device with the given configuration.

Note: If the serial number in IRImagerConfig is set to 0, the SDK will use the EnumerationManager to find a device to connect to. Its remaining data points will be ignored and the SDK will generate a default configuration for the detected device but without saving it.

Parameters

[in] config configuration.

Exceptions

SDKException if connecting fails.

◆ connect() [3/3]

virtual void optris::IRImager::connect ( unsigned long serialNumber )

pure virtual

Connects to the device with the given serial number.

Note: If the serial number is set to 0, the SDK will use the EnumerationManager to find a device to connect to.

Parameters

[in] serialNumber of the device.

Exceptions

SDKException if connecting fails.

◆ forceFlagEvent()

virtual void optris::IRImager::forceFlagEvent ( float time = 0.F )

pure virtual

Force a flag cycle manually.

Parameters

[in] time point of time in future in milliseconds, when the shutter flag should be closed.

Exceptions

SDKException if not connected.

◆ getActiveOperationMode()

virtual std::shared_ptr< OperationMode > optris::IRImager::getActiveOperationMode ( )

pure virtual

Returns the active operation mode for the currently connected device.

Each operation mode holds a valid combination of optics, temperature range and video format settings for the currently connected device.

Returns: active operation mode for the currently connected device.

Exceptions

SDKException if not connected.

◆ getAmbientTemperatureSource()

virtual RadiationParameterSource optris::IRImager::getAmbientTemperatureSource ( ) const

pure virtualnoexcept

Returns the source that currently defines the ambient temperature for the thermal frame.

Returns: source that currently defines the ambient temperature for the thermal frame or RadiationParameterSource::Sdk if not connected.

◆ getConnectionInterface()

virtual std::string optris::IRImager::getConnectionInterface ( ) const

pure virtualnoexcept

Returns the name of the connection interface used to communication with the device.

Returns: name of the connection interface used to communication with the device or an empty string if not connected.

◆ getDeviceNetworkConfig()

virtual DeviceNetworkConfig optris::IRImager::getDeviceNetworkConfig ( )

pure virtual

Returns the network configuration of the device.

Returns: network configuration of the device.

Exceptions

SDKException if not connect via USB or if device does not support Ethernet or if getting the device network configuration failed.

◆ getDeviceType()

virtual DeviceType optris::IRImager::getDeviceType ( ) const

pure virtual

Returns the type of device the IRImager is connected to.

Returns: type of device the IRImager is connected to or unknown if not connected.

◆ getEmissivitySource()

virtual RadiationParameterSource optris::IRImager::getEmissivitySource ( ) const

pure virtualnoexcept

Returns the source that currently defines the emissivity for the thermal frame.

Returns: source that currently defines the emissivity for the thermal frame or RadiationParameterSource::Sdk if not connected.

◆ getFirmwareRevision()

virtual unsigned int optris::IRImager::getFirmwareRevision ( ) const

pure virtual

Returns the firmware revision of the connected device.

Returns: firmware revision number of the connected device or 0 if not connected.

◆ getFlagMaxInterval()

virtual float optris::IRImager::getFlagMaxInterval ( ) const

pure virtual

Returns the maximum flag interval in seconds.

Maximum time that can elapse before a new flag cycle is triggered.

Returns: maximum flag interval in seconds or 0 if not connected.

◆ getFlagMinInterval()

virtual float optris::IRImager::getFlagMinInterval ( ) const

pure virtual

Returns the minimum flag interval in seconds.

Minimum time that has to elapse before a new flag cycle is triggered.

Returns: minimum flag interval in seconds or 0 if not connected.

◆ getFocusMotorPosition()

virtual float optris::IRImager::getFocusMotorPosition ( ) const

pure virtual

Returns the position of the focus motor.

Returns: focus motor position in % or -1.0 if not connected or if no focus motor is available.

◆ getHardwareRevision()

virtual unsigned int optris::IRImager::getHardwareRevision ( ) const

pure virtual

Returns the hardware revision of the connected device.

Returns: hardware revision number of the connected device or 0 if not connected.

◆ getHeight()

virtual int optris::IRImager::getHeight ( ) const

pure virtual

Returns the height in pixels of thermal frame.

Returns: height in pixels of the thermal frame, i.e. number of rows or 0 if not connected.

◆ getIpAddress()

virtual IpAddress optris::IRImager::getIpAddress ( ) const

pure virtualnoexcept

Returns the IP address of the connected device.

Note: The returned value is only relevant when connected to an Ethernet device.

Returns: IP address of the connected device or 192.168.0.101 if not connected.

◆ getOperationModes()

virtual std::vector< std::shared_ptr< OperationMode > > optris::IRImager::getOperationModes ( )

pure virtual

Returns the operation modes for the currently connected device.

Each operation mode holds a valid combination of optics, temperature range and video format settings for the currently connected device.

The returned container is always sorted in an ascending order based on the optics, temperature range and video format properties.

With OperationMode::getIndex() you can conveniently inquire a mode for its index within the returned container.

Returns: operation modes for the currently connected device.

Exceptions

SDKException if not connected.

See also: OperationMode::getIndex()

◆ getPif() [1/2]

virtual const ProcessInterface & optris::IRImager::getPif ( ) const

pure virtual

Grants read access to the process interface.

Warning: The reference becomes invalid on disconnects.

Returns: constant reference to the process interface.

Exceptions

SDKException if not connected.

◆ getPif() [2/2]

virtual ProcessInterface & optris::IRImager::getPif ( )

pure virtual

Grants access to the process interface.

Warning: The reference becomes invalid on disconnects.

Returns: reference to the process interface.

Exceptions

SDKException if not connected.

◆ getPort()

virtual Port optris::IRImager::getPort ( ) const

pure virtualnoexcept

Returns the number of the port on which the device data is received.

Note: The returned value is only relevant when connected to an Ethernet device.

Returns: number of the port on which the device data is received or 50101 if not connected.

◆ getRadiationParameters()

virtual RadiationParameters optris::IRImager::getRadiationParameters ( ) const

pure virtual

Returns the set/configured radiation parameters.

Attention: The radiation parameters may be modified via the process interface (PIF) and through automated ambient temperature estimations. This method return the parameters set in the configuration or vis IRImager::setRadiationParameters().

To get the actually applied parameters see the FrameMetadata::getRadiationParameters() for the thermal frame and the MeasurementField::getRadiationParameters() for measurement fields.

Returns: the set/configured radiation parameters or their default values if not connected.

◆ getSerialNumber()

virtual unsigned long optris::IRImager::getSerialNumber ( ) const

pure virtual

Returns the serial number of the connected device.

Returns: serial number of the connected device or 0 if not connected.

◆ getTemperatureBox()

virtual float optris::IRImager::getTemperatureBox ( ) const

pure virtual

Returns the temperature of the device housing in °C.

Returns: temperature of the device housing in °C or INVALID_TEMPERATURE if not connected or 35.0 °C if connected but processing has not yet started (s. run() and runAsync()).

◆ getTemperatureChip()

virtual float optris::IRImager::getTemperatureChip ( ) const

pure virtual

Returns the temperature of the sensor chip.

Returns: temperature of the sensor chip in °C or INVALID_TEMPERATURE if not connected or 35.0 °C if connected but processing has not yet started (s. run() and runAsync()).

◆ getTemperatureChipReference()

virtual float optris::IRImager::getTemperatureChipReference ( ) const

pure virtual

Returns the reference temperature in °C of the sensor chip heating.

Returns: temperature of the sensor chip in °C or INVALID_TEMPERATURE if not connected.

◆ getTemperatureFlag()

virtual float optris::IRImager::getTemperatureFlag ( ) const

pure virtual

Returns the temperature of the shutter flag in °C.

Returns: temperature of the shutter flag in °C or INVALID_TEMPERATURE if not connected or 35.0 °C if connected but processing has not yet started (s. run() and runAsync()).

◆ getTransmissivitySource()

virtual RadiationParameterSource optris::IRImager::getTransmissivitySource ( ) const

pure virtualnoexcept

Returns the source that currently defines the transmissivity for the thermal frame.

Returns: source that currently defines the transmissivity for the thermal frame or RadiationParameterSource::Sdk if not connected.

◆ getWidth()

virtual int optris::IRImager::getWidth ( ) const

pure virtual

Returns the width in pixels of the thermal frame.

Returns: width in pixels of the thermal frame, i.e. number of columns or 0 if not connected.

◆ interruptFailSafe()

virtual void optris::IRImager::interruptFailSafe	(	bool	active,
		const std::string &	reason )

pure virtual

Interrups the all clear fail safe signal.

Note: The client is only one source that can trigger the fail safe. If any of these sources detects an error, the fail safe will be triggered and it will only be released, if ALL the sources report an all clear.

Parameters

[in]	active	if true the all clear signal is interrupted. If false, the all clear may be restored, if all other sources report an all clear.
[in]	reason	to be displayed in the logs.

Exceptions

SDKException if not connected.

◆ isAutoFlagEnabled()

virtual bool optris::IRImager::isAutoFlagEnabled ( ) const

pure virtual

Returns whether flag cycles are triggered automatically.

Returns: true, if flag cycles are triggered automatically. False is automatic triggering is diabled or if not connected.

◆ isChipHeatingEnabled()

virtual bool optris::IRImager::isChipHeatingEnabled ( ) const

pure virtual

Return whether the sensor chip heating is enabled.

Returns: true, if the sensor chip heating is enabled. False if heating is disabled of if not connected.

◆ isConnected()

virtual bool optris::IRImager::isConnected ( ) const

pure virtualnoexcept

Returns whether a connection is established.

Returns: true if a connection is established. False otherwise.

◆ isFlagForecastEnabled()

virtual bool optris::IRImager::isFlagForecastEnabled ( ) const

pure virtual

Returns whether the shutter flag forecast is en-/disabled.

Returns: true if the shutter flag forecast is enabled. False if flag forecast is disabled or if not connected.

◆ isFlagOpen()

virtual bool optris::IRImager::isFlagOpen ( ) const

pure virtual

Returns whether the shutter flag is open.

Returns: true if the shutter flag is open. False if the shutter flag is closed or if not connected.

◆ isRunning()

virtual bool optris::IRImager::isRunning ( ) const

pure virtualnoexcept

Returns whether the processing loop is currently running.

Returns: true if the processing loop is running. False otherwise.

◆ isSoSCorrectionEnabled()

virtual bool optris::IRImager::isSoSCorrectionEnabled ( ) const

pure virtual

Checks if the Size of Source Correction is enabled.

Returns: true if the Size of Source Correction is enabled, false otherwise.

Exceptions

SDKException if not connected.

◆ isTemperatureHighPrecisionEnabled()

virtual bool optris::IRImager::isTemperatureHighPrecisionEnabled ( ) const

pure virtualnoexcept

Returns whether high precision temperature measurements are enabled.

Note: Not all temperature ranges on all devices feature high precision temperature measurements.

Returns: true, if high precision temperature measurements are enabled. False, otherwise or if not connected.

See also: OperationMode::isTemperatureHighPrecision(), OperationMode::isTemperatureHighPrecisionAvailable()

◆ isTemperatureRangeExtensionEnabled()

virtual bool optris::IRImager::isTemperatureRangeExtensionEnabled ( ) const

pure virtualnoexcept

Returns whether the temperature ranges are being extended.

Note: Not all temperature ranges can be extended.

Returns: true, if the temperature ranges are being extended. False, otherwise or if not connected.

See also: OperationMode::isTemperatureRangeExtended(), OperationMode::isTemperatureRangeExtendable()

◆ removeClient()

virtual bool optris::IRImager::removeClient ( IRImagerClient * client )

pure virtual

Removes the given observer/client.

Parameters

[in] client to remove.

Returns: true, if the client was removed. False otherwise.

◆ resetReferenceTemperature()

virtual void optris::IRImager::resetReferenceTemperature ( )

pure virtual

Resets a previously set reference temperature.

Exceptions

SDKException if not connected.

◆ run()

virtual void optris::IRImager::run ( )

pure virtual

Runs the processing loop continuously.

Blocks until stopRunning() or disconnect() is called from another thread or until the application terminates.

See also: stopRunning(), disconnect()

◆ runAsync()

virtual bool optris::IRImager::runAsync ( )

pure virtual

Runs the processing loop continuously in a dedicated thread.

Runs until stopRunning() or disconnect() is called from another thread or until the application terminates.

Note: All callback methods of a registered client now are called from this processing thread.

Returns: true if the thread started within a second. False otherwise.

See also: stopRunning(), disconnect()

◆ setActiveOperationMode() [1/2]

virtual void optris::IRImager::setActiveOperationMode ( const std::shared_ptr< OperationMode > & mode )

pure virtual

Sets the active operation mode for the currently connected device.

Each operation mode holds a valid combination of optics, temperature range and video format settings for the currently connected device.

Parameters

[in] mode to set active.

Exceptions

SDKException if not connected, if mode is not supported by device or if applying the mode fails.

◆ setActiveOperationMode() [2/2]

virtual void optris::IRImager::setActiveOperationMode	(	int	opticsFieldOfView,
		const std::string &	opticsText,
		float	temperatureLowerLimit,
		float	temperatureUpperLimit,
		int	width,
		int	height,
		int	framerate )

pure virtual

Sets the active operation mode for the currently connected device.

Each operation mode holds a valid combination of optics, temperature range and video format settings for the currently connected device.

Note

You can use "wildcards", if you do not want to specify the optics, temperature range or video format explicitly:

optics : set opticsFieldOfView to 0 AND leave opticsText empty.
temperature range: set temperatureLowerLimit AND temperatureUpperLimit to 0.
video format : set width, height AND framerate to 0.

Parameters

[in]	opticsFieldOfView	in degrees.
[in]	opticsText	further specifying the optics if the field of view is not unique enough.
[in]	temperatureLowerLimit	in degree Celsius (not extended).
[in]	temperatureUpperLimit	in degree Celsius (not extended).
[in]	width	in pixel of the output frame.
[in]	height	in pixel of the output frame.
[in]	framerate	in Hz (not sub-sampled).

Exceptions

SDKException SDKException if not connected, if mode is not supported by device or if applying the mode fails.

◆ setAutoFlagEnabled()

virtual void optris::IRImager::setAutoFlagEnabled ( bool enable )

pure virtual

Sets the automatic triggering of flag cycles en-/disabled.

Parameters

[in] enable or disable automatic triggering of flag cycles.

◆ setChipHeatingEnabled()

virtual void optris::IRImager::setChipHeatingEnabled ( bool enable )

pure virtual

Enables the heating of the sensor chip.

Parameters

[in] enable indicates whether to enable heating.

Exceptions

SDKException if not connected.

◆ setDeviceNetworkConfig()

virtual void optris::IRImager::setDeviceNetworkConfig ( const DeviceNetworkConfig & networkConfig )

pure virtual

Sets the network configuration of the device.

Parameters

[in] networkConfig to set.

Exceptions

SDKException if not connect via USB or if device does not support Ethernet or if setting the device network configuration failed.

◆ setFlagForecastEnabled()

virtual void optris::IRImager::setFlagForecastEnabled ( bool enable )

pure virtual

Set the shutter flag forecast en-/disabled.

Parameters

enable of disable the shutter flag forecast.

Exceptions

SDKException if not connected.

◆ setFlagInterval()

virtual void optris::IRImager::setFlagInterval	(	float	minInterval,
		float	maxInterval )

pure virtual

Sets the minimum and maximum flag intervals in seconds.

Parameters

[in]	minInterval	minimal time in seconds that has to elapse before a new flag cycle is triggered.
[in]	maxInterval	maximum time in seconds that can elapse until a new flag cycle is triggered. Set to 0 to deactivate.

Exceptions

SDKException if provided intervals are negative.

◆ setFocusMotorPosition()

virtual void optris::IRImager::setFocusMotorPosition ( float position )

pure virtual

Sets the position of the focus motor.

The position should be in [0, 100] %. If not, the position will automatically be clipped.

Parameters

[in] position focus motor position in %.

Exceptions

SDKException if not connected or if no focus motor is available.

◆ setRadiationParameters()

virtual void optris::IRImager::setRadiationParameters ( const RadiationParameters & radiation )

pure virtual

Sets the radiation parameters (emissivity, transmissivity and ambient temperature).

Parameters

[in] radiation parameters to set.

Exceptions

SDKException if not connected or if parameters are invalid or if setting the parameters fails.

◆ setReferenceTemperature()

virtual void optris::IRImager::setReferenceTemperature	(	float	referenceTemperature,
		float	measuredTemperature,
		float	ambientTemperature = INVALID_TEMPERATURE )

pure virtual

Sets a reference temperature to a known reference source inside the view of the device to improve measurement accuracy.

Parameters

[in]	referenceTemperature	real temperature of reference source.
[in]	measuredTemperature	measured temperature from the device of reference source.
[in]	ambientTemperature	in °C. Set it to INVALID_TEMPERATURE or less to force the SDK to estimate the ambient temperature based on thermal probe readings of the device.

Exceptions

SDKException if not connected.

◆ setSoSCorrectionEnabled()

virtual void optris::IRImager::setSoSCorrectionEnabled ( bool enable )

pure virtual

Enables or disables the Size of Source Correction.

Parameters

[in] enable indicates whether to enable or disable the Size of Source Correction.

Exceptions

SDKException if not connected.

◆ setTemperatureChipReference()

virtual void optris::IRImager::setTemperatureChipReference ( float temperature )

pure virtual

Sets the reference temperature in °C for the sensor chip heating.

The specified temperature should be in [20, 55] °C. If not, the temperature will automatically be clipped. The current chip temperature can be monitored with getTemperatureChip().

Parameters

[in] temperature to set in °C.

Exceptions

SDKException if not connected.

◆ setTemperatureHighPrecisionEnabled()

virtual void optris::IRImager::setTemperatureHighPrecisionEnabled ( bool enabled )

pure virtual

Dis-/Enables high precision temperature measurements.

Note: Not all temperature ranges on all devices feature high precision temperature measurements.

Parameters

[in] enabled if true high temperature measurements are enabled.

Exceptions

SDKException if setting enabled failed or if not connected.

◆ setTemperatureRangeExtensionEnabled()

virtual void optris::IRImager::setTemperatureRangeExtensionEnabled ( bool enabled )

pure virtual

Die-/Enables temperature range extension.

Attention: Extended temperature ranges feature poor precision and should not be used for measurements. The main purpose of this feature is to give users an easier time to physically align the field of view of the device when a temperature range has a high lower limit.

Note: Not all temperature ranges can be extended.

Parameters

[in] enabled if true temperature range extension is enabled.

The documentation for this class was generated from the following file:

IRImager.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ addClient()

◆ addMeasurementField()

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ forceFlagEvent()

◆ getActiveOperationMode()

◆ getAmbientTemperatureSource()

◆ getConnectionInterface()

◆ getDeviceNetworkConfig()

◆ getDeviceType()

◆ getEmissivitySource()

◆ getFirmwareRevision()

◆ getFlagMaxInterval()

◆ getFlagMinInterval()

◆ getFocusMotorPosition()

◆ getHardwareRevision()

◆ getHeight()

◆ getIpAddress()

◆ getOperationModes()

◆ getPif() [1/2]

◆ getPif() [2/2]

◆ getPort()

◆ getRadiationParameters()

◆ getSerialNumber()

◆ getTemperatureBox()

◆ getTemperatureChip()

◆ getTemperatureChipReference()

◆ getTemperatureFlag()

◆ getTransmissivitySource()

◆ getWidth()

◆ interruptFailSafe()

◆ isAutoFlagEnabled()

◆ isChipHeatingEnabled()

◆ isConnected()

◆ isFlagForecastEnabled()

◆ isFlagOpen()

◆ isRunning()

◆ isSoSCorrectionEnabled()

◆ isTemperatureHighPrecisionEnabled()

◆ isTemperatureRangeExtensionEnabled()

◆ removeClient()

◆ resetReferenceTemperature()

◆ run()

◆ runAsync()

◆ setActiveOperationMode() [1/2]

◆ setActiveOperationMode() [2/2]

◆ setAutoFlagEnabled()

◆ setChipHeatingEnabled()

◆ setDeviceNetworkConfig()

◆ setFlagForecastEnabled()

◆ setFlagInterval()

◆ setFocusMotorPosition()

◆ setRadiationParameters()

◆ setReferenceTemperature()

◆ setSoSCorrectionEnabled()

◆ setTemperatureChipReference()

◆ setTemperatureHighPrecisionEnabled()

◆ setTemperatureRangeExtensionEnabled()