Thermal Camera SDK 11.3.0
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
IRImagerConfig.h
Go to the documentation of this file.
1// Copyright (c) 2008-2026 Optris GmbH & Co. KG
2
10
11#pragma once
12
13#include <ostream>
14#include <string>
15
16#include "otcsdk/Api.h"
17#include "otcsdk/Exceptions.h"
26
27
28namespace optris
29{
30
33{
35 static constexpr int CURRENT_VERSION = 3;
36
37
38 // General
42 unsigned long serialNumber = 0;
43
44
50 std::string connectionInterface = "usb";
52 IpAddress ipAddress = IpAddress{192, 168, 0, 101};
54 unsigned short port = 50101;
61 bool checkIp = true;
70
71
79 unsigned short bufferQueueSize = 5;
80
83
84
98 unsigned int processingMaxResultPoolSize = 10;
99
105 int width = 0;
111 int height = 0;
117 int framerate = 0;
118
129
130
136 int fieldOfView = 0;
142 std::string opticsText;
143
150
162
179
197
207 bool autoFlag = true;
209 float minInterval = 12.F;
211 float maxInterval = 0.F;
212
213
218
219
225 float focusMotorPosition = -1.F;
226
233
234
241
242
250
257
265
266
269
270
272 std::vector<MeasurementFieldConfig> measurementFields;
273
274
277
278
289 OTC_SDK_API static void validate(IRImagerConfig& config);
290};
291
292
293// Utility
302OTC_SDK_API std::ostream& operator<<(std::ostream& out, const IRImagerConfig& config);
303
304} // namespace optris
Contains a class encapsulating the configuration of the alarms.
Contains defines controlling the Windows DLL export and import of symbols.
#define OTC_SDK_API
Only needed when working with Windows DLLs.
Definition Api.h:65
Contains an enum for the available chip heating modes.
Contains the exceptions raised by the SDK.
Contains a class holding IP v4 address.
Contains a class encapsulating the configuration of a measurement field.
Contains a class encapsulating the configuration for the process interface.
Contains a struct specifying which outputs should be computed and provided by the SDK.
Contains a class holding the individual radiation parameters.
Contains enum and utility functions for (R)adial (D)istortion (C)orrection modes.
Encapsulates an IP v4 address.
Definition IpAddress.h:33
Main SDK namespace.
Definition AlarmChannel.h:21
OTC_SDK_API std::ostream & operator<<(std::ostream &out, const AlarmChannelConfig &config) noexcept
Output stream operator for alarm channel configurations.
RdcMode
Represents the different modes for radial distortion correction.
Definition RdcMode.h:25
@ Normal
Normal mode.
Definition RdcMode.h:27
ChipHeatingMode
Represents the available chip heating modes.
Definition ChipHeatingMode.h:25
@ Floating
The sensor chip will not be heated.
Definition ChipHeatingMode.h:26
Holds the alarm configuration.
Definition AlarmsConfig.h:25
Holds the SDK settings found in the configuration file.
Definition IRImagerConfig.h:33
unsigned short port
Local UDP port to which the device sends data to.
Definition IRImagerConfig.h:54
PifConfig processInterface
Processing interface configuration.
Definition IRImagerConfig.h:276
std::string opticsText
Optional text further specifying the used optics.
Definition IRImagerConfig.h:142
static constexpr int CURRENT_VERSION
Current version of the configuration file.
Definition IRImagerConfig.h:35
ChipHeatingMode chipHeatingMode
Specified how and if the sensor chip is beeing heated.
Definition IRImagerConfig.h:215
bool enableHighPrecisionTemperature
Use high precision temperatures if available.
Definition IRImagerConfig.h:196
bool enableExtendedTemperatureRange
Extends the chosen temperature range if possible.
Definition IRImagerConfig.h:189
static OTC_SDK_API void validate(IRImagerConfig &config)
Validates the configuration settings.
bool checkIp
Flag indicating whether to only process UDP packages from the IP address specified by the ipAddress m...
Definition IRImagerConfig.h:61
unsigned short bufferQueueSize
Specifies the number of buffers that the subsystems receiving the raw frame data should use (DirectSh...
Definition IRImagerConfig.h:79
float chipHeatingTemperature
Temperature in °C for the fixed chipHeatingMode. The provided value is clamped to [20,...
Definition IRImagerConfig.h:217
int connectionTimeout
Specifies the time in seconds that has to elapse without no new frame received until an connection ti...
Definition IRImagerConfig.h:69
int minTemperature
Lower limit of the desired temperature range in °C.
Definition IRImagerConfig.h:170
std::string connectionInterface
Interface used to connect to the device (USB, Ethernet).
Definition IRImagerConfig.h:50
int fieldOfView
Field of view of the optics in degree.
Definition IRImagerConfig.h:136
unsigned int processingMaxResultPoolSize
Sets the maximum number of processing results that are pooled for reuse to avoid unnecessary allocati...
Definition IRImagerConfig.h:98
float subsampledFramerate
Subsampled output framerate.
Definition IRImagerConfig.h:128
int width
Width in pixels of the output frame.
Definition IRImagerConfig.h:105
RdcMode rdcMode
Mode of radial distortion correction (RDC).
Definition IRImagerConfig.h:161
bool enableMultiThreading
Activate multithreading for postprocessing.
Definition IRImagerConfig.h:240
float minInterval
Minimum time in seconds that has to pass before a new flag cycle can be triggered.
Definition IRImagerConfig.h:209
int maxTemperature
Upper limit of the desired temperature range in °C.
Definition IRImagerConfig.h:178
std::vector< MeasurementFieldConfig > measurementFields
Measurement field configuration.
Definition IRImagerConfig.h:272
unsigned long serialNumber
Serial number of the device.
Definition IRImagerConfig.h:42
bool autoFlag
Enable the automatic triggering of flag cycles.
Definition IRImagerConfig.h:207
float focusMotorPosition
Position of the focus motor in % ([0, 100]).
Definition IRImagerConfig.h:225
int version
Version of the configuration file.
Definition IRImagerConfig.h:40
float maxInterval
Maximum time in seconds that can pass before a new flag cycle is forced.
Definition IRImagerConfig.h:211
int framerate
Output framerate in Hz.
Definition IRImagerConfig.h:117
int failSafeFlagTimeoutsMaxCycleFailures
Specifies the number of failed flag cycles to be tolerated before fail safe is triggered due to flag ...
Definition IRImagerConfig.h:256
bool enableSoSCorrection
Use Size of Source Correction if available in calibration data.
Definition IRImagerConfig.h:149
bool failSafeProcessingChainTimeouts
Indicates whether a failure of the processing chain to reach all of its endpoints (thermal frame and ...
Definition IRImagerConfig.h:264
RadiationParameters radiation
Radiation parameters for the overall thermal frame.
Definition IRImagerConfig.h:232
AlarmsConfig alarms
Alarms configuration.
Definition IRImagerConfig.h:268
int height
Height in pixels of the output frame.
Definition IRImagerConfig.h:111
ProcessingOutputConfig processingOutputs
Specifies which outputs should be computed and provided by the SDK.
Definition IRImagerConfig.h:82
bool failSafeFlagTimeouts
Indicates whether a flag timeout that caused the failure of a flag cycle should trigger the fail safe...
Definition IRImagerConfig.h:249
IpAddress ipAddress
IP address of the device.
Definition IRImagerConfig.h:52
Holds the configuration of the processing interface.
Definition PifConfig.h:29
Specifies which outputs should be computed and provided by the SDK.
Definition ProcessingOutputConfig.h:19
Holds the radiation parameters for a frame or a measurement field.
Definition RadiationParameters.h:35