Operation Modes

Contents

• Overview
• Getting The Available And Active Modes
• Setting The Active Mode

Operation Modes

An operation mode represents a valid combination of optics, temperature range and video format settings that is supported by a device. These three categories are comprised out of the following individual setting options:

Category	Individual Setting Options
Optics	Field of view (FOV), optics text
Temperature Range	Non-extended lower and upper limit
Video Format	Frame width, frame height and framerate (not sub-sampled)

The availability of the different operation modes depends on the device type, the available calibration data and the used device connection interface (USB, Ethernet).

Attention

Different operation modes may be available for devices of the same type because of

• additional or different optics.
  Each of these optics require their own set of calibration data. Otherwise, they can not be utilized.
• different connection interfaces (USB, Ethernet).
  Ethernet connections typically offer a higher bandwidth. Thus, they allow for larger formats and/or higher framerates like for the Xi 410.

Note

If the connection interface of an Ethernet capable device has changed, the SDK will automatically select the first suitable video format when the one specified in the configuration is not supported.

If no calibration is found and could not be acquired, the SDK will not be able to determine available optics and temperature ranges. As a result, operation modes are solely derived from the supported video format. The values for field of view and the temperature range limits are set to the invalid values 0 and -100 respectively.

Operation modes of a PI 640I without a calibration.

Getting Available And Active Modes

You can use the IRImager::getOperationModes() method to get a container with all the available operation modes for the current device connection. The container is always sorted in ascending order with the following prioritization of the individual settings:

field of view > optics text > lower temperature limit > upper temperature limit > frame width > frame height > framerate

The currently active operation mode is returned by the IRImager::getActiveOperationMode() method. With its OperationMode::getIndex() method you can identify its index within the container of available modes.

Setting The Active Mode

You have two options to set the active operations mode:

• In the configuration file with the optics, temperature range and video format settings.
  Please note, that all three of these sections in the configuration file feature some additional options that have no direct impact on the operation modes.
• At runtime via the IRImager::setActiveOperationMode() methods.
  You can either provide the instance of the operation mode to set or you can specify the desired mode by providing all the individual setting options listed in the table above. The second approach features the same support for "wildcards" as their configuration file counterparts. This means you can, for example, let the SDK choose the video format by providing zeros for the width, height and framerate arguments.

When changing an active operation mode at runtime, the SDK pauses the processing of thermal frames while reconfiguring the incoming data stream and reinitializing the processing pipeline. Once completed it enters an initialization phase similar to the startup calibration upon a new device connection. This phase, however, is significantly shorter. Nevertheless, thermal data during this phase is equally unreliable. The SDK denotes that phase by setting the FlagState to Initializing. SDK clients can check for this value either via the IRImagerClient::onFlagStateChange() callback or via the state contained within the FrameMetadata object returned by the IRImagerClient::onThermalFrame() callback.

Attention

If the newly active operation mode features different frame dimensions from the old one, the SDK will scale the position and dimensions of all active measurement fields to ensure that they stay completely within the frame. For more details please refer to the measurement fields section.