Important Files

Contents

• Configuration
• Calibration
• Normalization
• Format Definitions
• Dynamic Dead Pixels

Configuration

The configuration file defines the device specific settings and features the following options:

<?xml version="1.0" encoding="UTF-8"?>
 
<imager>
  <!--
    Version
 
    configuration [int]   : version of this configuration.
    sdk           [string]: version of the SDK that generated this configuration.
  -->
  <version>
    <configuration>1</configuration>
    <sdk>10.0.0</sdk>
  </version>
 
  <!--
    serial_number [int]: serial number of the device this configuration applies to.
  -->
  <serial_number>1234567</serial_number>
 
  <!--
    Connection
 
    interface  [string]: string defining the connection interface between the device and the SDK. Natively the SDK supports:
                         - usb
                         - ethernet
                         (case insensitive)
    ip_address [string]: IP v4 address under which the device can be reached.
    port       [int]   : local port on which to receive data (ethernet) or remote port to connect to.
    check_ip   [bool]  : if true, received data will be checked whether it originated from the IP address specified above.
    timeout    [int]   : time in seconds until a connection is considered timed out when no frames are being received.
  -->
  <connection>
    <interface>usb</interface>
 
    <ip_address>192.168.0.101</ip_address>
    <port>50101</port>
    <check_ip>true</check_ip>
    <timeout>10</timeout>
  </connection>
 
  <!--
    buffer_queue_size [int]: number of buffers used to receive frames. Does not refer to the actual size of the
                             individual buffers themselves.
  -->
  <buffer_queue_size>5</buffer_queue_size>
 
  <!--
    Optics
 
    field_of_view [int]   : field of view of the used optics in degrees.
    text          [string]: optional text further specifying the used optics.
 
    If field_of_view is 0 and text is blank, the SDK will automatically choose the first available optics.
  -->
  <optics>
    <field_of_view>30</field_of_view>
    <text></text>
  </optics>
 
  <!--
    Temperature Range
 
    min                   [int] : lower limit of the range in degree Celsius (not extended).
    max                   [int] : upper limit of the range in degree Celsius (not extended).
    extended              [bool]: enables a potential range extension. Note, extended ranges feature poor precision and
                                  should not be used for measurements.
    enable_high_precision [bool]: if true, high precision temperatures will be used when available.
 
    If min and max are both 0, the SDK will automatically choose the first available temperature range.
  -->
  <temperature_range>
    <min>150</min>
    <max>900</max>
 
    <extended>false</extended>
    <enable_high_precision>true</enable_high_precision>
  </temperature_range>
 
  <!--
    Video Format
 
    width                [int]  : width in pixels of the output thermal frame.
    height               [int]  : height in pixels of the output thermal frame.
    framerate            [int]  : framerate in Hz with which thermal frames are output.
    subsampled_framerate [float]: framerate in Hz to which the SDK should reduce the output rate of thermal frames. This
                                  setting does not affect the device itself. The reduction is achieved within the SDK.
                                  Leave the setting blank, to deactivate this option.
 
    If width, height and framerate are all 0, the SDK will automatically choose the first available video format.
  -->
  <video_format>
    <width>382</width>
    <height>288</height>
    <framerate>27</framerate>
 
    <subsampled_framerate></subsampled_framerate>
  </video_format>
 
  <!--
    Auto Flag
 
    All devices feature an internal shutter flag. It needs to be closed periodically in order for the SDK to compensate for
    drifting temperature measurements.
 
    enable       [bool] : if true, the SDK will automatically trigger a flag cycle, if one of the temperatures measured by
                          the internal probes changes by more than 0.1 degree Celsius.
    min_interval [float]: minimum time in seconds that has to pass before an new flag cycle can be triggered.
    max_interval [float]: maximum time in seconds allowed to pass until a new flag cycle is forced.
  -->
  <auto_flag>
    <enable>true</enable>
 
    <min_interval>12</min_interval>
    <max_interval>0</max_interval>
  </auto_flag>
 
  <!--
    Sensor Chip Heating
 
    mode        [string]: The following modes specify how the sensor chip will be heated:
                          - floating: The sensor chip will not be heated.
                          - auto    : The sensor chip will be heated to the temperature specified in the calibrations.
                          - fixed   : The sensor chip will be heated to the temperature specified below.
                          (case insensitive)
    temperature [float] : temperature in degree Celsius for the fixed heating mode.
  -->
  <chip_heating>
    <mode>floating</mode>
 
    <temperature>40</temperature>
  </chip_heating>
 
  <!--
    focus_motor_position [float]: focus motor position in percent ([0., 100.]). Leave blank, if position should not be adjusted.
  -->
  <focus_motor_position></focus_motor_position>
 
  <!--
    Radiation Parameters
 
    emissivity     [float]: emissivity of the observed objects. Should be in [0., 1.].
    transmissivity [float]: transmissivity of the observed objects. Should be in [0., 1.].
    ambient        [float]: ambient temperature in degree Celsius. Leave blank or set it to a temperature less or equal to -100 to
                            force the SDK to estimate the ambient temperature based on thermal probe readings of the device.
  -->
  <radiation>
    <emissivity>0.7</emissivity>
    <transmissivity>1</transmissivity>
    <ambient>20</ambient>
  </radiation>
</imager>

File Name

<Serial Number>.xml

How To Get It

The configuration file is automatically generated by the SDK when connecting to a new camera. The file is placed in the user settings directory

• <User AppData>\Roaming\Imager\Configs on Windows
• ~/.config/optris/Configs on Linux

SDK Search Hierarchy

1. Working directory of the application.
2. User settings directory
   • <User AppData>\Roaming\Imager\Configs on Windows
   • ~/.config/optris/Configs on Linux

Calibration

The calibration files for a device consists out of up to three different file types:

• A XML based configuration file called Cali-<Serial Number>.xml specifying available optics, temperature ranges, video formats and other device specific parameters.
• Calibration files named Cali-<Serial Number>-<...>.dat
• Optional files named Kennlinie-<Serial Number>-<...>.prn specifying characteristic curves.

How To Get Them

The SDK automatically tries to acquire missing calibration files. By default it attempts to copy them from a local source directory on the filesystem. The location of this source directory is not set out of the box. When that fails the SDK tries to download the missing files from Optris servers.

Note

You can adjust the priority of the different ways the SDK tries to acquire missing calibration files with the help of the Sdk class. Refer to the API documentation of its setCalibrationFileSources() method for more details.

The automatically downloaded or copied files will be placed in the user settings directory:

• <User AppData>\Roaming\Imager\Cali on Windows
• ~/.config/optris/Cali on Linux

SDK Search Hierarchy

1. User settings directory
   • <User AppData>\Roaming\Imager\Cali on Windows
   • ~/.config/optris/Cali on Linux

Normalization

These files contain corrections for the temperature calculation when the emissivity is not 1. They consist of two different types of files:

• A XML based file named Norm.xml defining which normalization file apply for a specific camera type.
• Normalization files named Norm-<Id>.prn containing the corrections.

How To Get Them

These files are automatically installed.

SDK Search Hierarchy

1. Norm\ subfolder in the working directory of the application.
2. User settings directory
   • <User AppData>\Roaming\Imager\Cali\Norm on Windows
   • ~/.config/optris/Cali/Norm on Linux
3. SDK install directory
   • <SDK Install Directory>\norm on Windows
   • /usr/share/otcsdk/norm on Linux

Formats Definitions

The formats definitions file specifies what video formats are supported by the different devices. It also tells the SDK how to process received data frames.

File Name

Formats.def

How To Get It

The file is automatically installed. If lost, you can download it from an Optris server.

SDK Search Hierarchy

1. Working directory of the application.
2. User settings directory
   • <User AppData>\Roaming\Imager\ on Windows
   • ~/.config/optris/ on Linux
3. SDK install directory
   • <SDK Install Directory>\ on Windows
   • /usr/share/otcsdk/ on Linux

Dynamic Dead Pixels

This file contains dead pixels detected by the SDK.

File Name

DP-<Serial Number>.dat

How To Get It

The file is automatically generated by the SDK once a dead pixel is detected.

SDK Search Hierarchy

1. User settings directory
   • <User AppData>\Roaming\Imager\DynamicDeadPixels on Windows
   • ~/.config/optris/DynamicDeadPixels on Linux