Thermal Camera SDK 10.1.1
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
PifProperties.h
Go to the documentation of this file.
1// Copyright (c) 2008-2025 Optris GmbH & Co. KG
2
10
11#pragma once
12
13#include <ostream>
14#include <string>
15
16#include "otcsdk/Api.h"
17
18
19namespace optris
20{
21
22// Device
36
37
38// Modes
48
50enum class PifDiMode
51{
54};
55
67
77
79enum class PifFsMode
80{
83};
84
85
93
94
95// Utility functions
103OTC_SDK_API float lowerLimit(PifAoOutputMode outputMode) noexcept;
104
112OTC_SDK_API float upperLimit(PifAoOutputMode outputMode) noexcept;
113
122OTC_SDK_API float clampValue(float value, PifAoOutputMode outputMode) noexcept;
123
133OTC_SDK_API std::string toString(PifDeviceType type) noexcept;
134
144OTC_SDK_API std::string toString(PifAiMode analogInputMode) noexcept;
145
155OTC_SDK_API std::string toString(PifDiMode digitalInputMode) noexcept;
156
166OTC_SDK_API std::string toString(PifAoMode analogOutputMode) noexcept;
167
177OTC_SDK_API std::string toString(PifDoMode digitalOutputMode) noexcept;
178
188OTC_SDK_API std::string toString(PifFsMode failSafeMode) noexcept;
189
199OTC_SDK_API std::string toString(PifAoOutputMode outputMode) noexcept;
200
201
210OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDeviceType deviceType) noexcept;
211
220OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAiMode analogInputMode) noexcept;
221
230OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDiMode digitalInputMode) noexcept;
231
240OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAoMode analogOutputMode) noexcept;
241
250OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDoMode digitalOutputMode) noexcept;
251
260OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifFsMode failSafeMode) noexcept;
261
270OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAoOutputMode outputMode) noexcept;
271
272} // namespace optris
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
Rectangular measurement field with individual radiation parameters.
Definition MeasurementField.h:33
Main SDK namespace.
Definition DeviceInfo.h:24
OTC_SDK_API float clampValue(float value, PifAoOutputMode outputMode) noexcept
Clamps the given value to the limits of the specified PIF analog output mode.
PifAoMode
Represents the available modes for PIF analog output channels.
Definition PifProperties.h:58
@ ExternalCommunication
The output value can be controlled by clients of the SDK.
Definition PifProperties.h:63
@ InternalTemperature
The internal camera temperature is output.
Definition PifProperties.h:65
@ FrameSync
Every time a new frame is capture a pulse is output.
Definition PifProperties.h:61
@ FlagStatus
The status of the shutter flag is output.
Definition PifProperties.h:60
@ FailSafe
A heart beat signal is provided that indicates whether the camera and SDK are working correctly.
Definition PifProperties.h:62
PifAiMode
Represents the available modes for PIF analog input channels.
Definition PifProperties.h:41
@ UncommittedValue
The input voltage value is transformed and provided to IRImagerClients via a callback.
Definition PifProperties.h:46
@ AmbientTemperature
Ambient temperature for the thermal frame is derived from the input voltage.
Definition PifProperties.h:45
@ Emissivity
Emissivity for the thermal frame is derived from the input voltage.
Definition PifProperties.h:44
@ FlagControl
The shutter flag is controlled by the input voltage.
Definition PifProperties.h:43
@ Off
Off.
Definition PifProperties.h:42
PifFsMode
Represents the available modes for PIF fail safe channels.
Definition PifProperties.h:80
@ On
On.
Definition PifProperties.h:82
PifDiMode
Represents the available modes for PIF digital input channels.
Definition PifProperties.h:51
@ Standard
Standard precision.
Definition TemperaturePrecision.h:34
OTC_SDK_API std::string toString(DeviceType deviceType) noexcept
Returns a string representation of the given device type.
PifDeviceType
Represents the supported PIF device types.
Definition PifProperties.h:25
@ Proprietary
The pins of the PIF connector on the camera are used directly.
Definition PifProperties.h:34
@ Automatic
Use the PIF type reported by the camera firmware.
Definition PifProperties.h:26
@ Stackable
Stackable PIF.
Definition PifProperties.h:32
@ None
No PIF.
Definition PifProperties.h:27
@ IndustrialMA
Industrial PIF with current based analog outputs.
Definition PifProperties.h:30
@ Internal
Internal PIF.
Definition PifProperties.h:31
@ TemperatureProbe
Instead of a PIF an external temperature probe is used.
Definition PifProperties.h:33
@ IndustrialMV
Industrial PIF with voltage based analog outputs.
Definition PifProperties.h:29
OTC_SDK_API std::ostream & operator<<(std::ostream &out, DeviceType deviceType) noexcept
Output stream operator for device types.
PifAoOutputMode
Represents the available output modes for PIF analog output channels.
Definition PifProperties.h:88
@ _0_20mA
0 mA - 20 mA
Definition PifProperties.h:89
@ _0_10V
0 V - 10 V
Definition PifProperties.h:91
@ _4_20mA
4 mA - 20 mA
Definition PifProperties.h:90
OTC_SDK_API float upperLimit(PifAoOutputMode outputMode) noexcept
Returns the upper limit of the specified PIF analog output mode as a number value.
OTC_SDK_API float lowerLimit(PifAoOutputMode outputMode) noexcept
Returns the lower limit of the specified PIF analog output mode as a number value.
PifDoMode
Represents the available modes for PIF digital output channels.
Definition PifProperties.h:70