Thermal Camera SDK 11.3.0
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
FieldStatus.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 <cstdint>
14#include <ostream>
15#include <string>
16
17#include "otcsdk/Api.h"
20
21
22namespace optris
23{
24
25// Forward declaration
26struct ProcessingParams;
27
28
31{
32public:
35
36
42 const std::string& getName() const noexcept;
43
49 std::int32_t getId() const noexcept;
50
56 std::uint32_t getIndex() const noexcept;
57
63 const FieldStats& getStats() const noexcept;
64
70 const RadiationParameters& getRadiation() const noexcept;
71
78
85
92
93
101 OTC_SDK_API void update(std::int32_t id, const FieldStats& stats, const ProcessingParams& params) noexcept;
102
103
104private:
105 std::string _name;
106 std::uint32_t _index;
107 std::int32_t _id;
108
109 FieldStats _stats;
110
111 RadiationParameters _radiation;
112 RadiationParameterSource _ambientTemperatureSource;
113};
114
115
116// Utility function
125OTC_SDK_API std::ostream& operator<<(std::ostream& out, const FieldStatus& status);
126
127
128// Inline implementations
129inline const std::string& FieldStatus::getName() const noexcept
130{
131 return _name;
132}
133
134inline std::int32_t FieldStatus::getId() const noexcept
135{
136 return _id;
137}
138
139inline std::uint32_t FieldStatus::getIndex() const noexcept
140{
141 return _index;
142}
143
144inline const FieldStats& FieldStatus::getStats() const noexcept
145{
146 return _stats;
147}
148
149inline const RadiationParameters& FieldStatus::getRadiation() const noexcept
150{
151 return _radiation;
152}
153
158
163
165{
166 return _ambientTemperatureSource;
167}
168
169} // 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
Contains various enums and structs representing the properties of fields.
Contains a class holding the individual radiation parameters.
Encapsulates the status of a processed measurement field.
Definition FieldStatus.h:31
OTC_SDK_API void update(std::int32_t id, const FieldStats &stats, const ProcessingParams &params) noexcept
Sets the field status.
const FieldStats & getStats() const noexcept
Returns the results of the statistical analysis of the measurement field.
Definition FieldStatus.h:144
RadiationParameterSource getAmbientTemperatureSource() const noexcept
Returns the source of the ambient temperature value used to process the measurement field.
Definition FieldStatus.h:164
std::uint32_t getIndex() const noexcept
Returns the field index.
Definition FieldStatus.h:139
OTC_SDK_API FieldStatus() noexcept
Constructor.
RadiationParameterSource getTransmissivitySource() const noexcept
Returns the source of the transmissivity value used to process the measurement field.
Definition FieldStatus.h:159
const std::string & getName() const noexcept
Returns the field name.
Definition FieldStatus.h:129
const RadiationParameters & getRadiation() const noexcept
Returns the radiation parameters used to process the measurement field.
Definition FieldStatus.h:149
RadiationParameterSource getEmissivitySource() const noexcept
Returns the source of the emissivity value used to process the measurement field.
Definition FieldStatus.h:154
std::int32_t getId() const noexcept
Returns the unique field ID.
Definition FieldStatus.h:134
Main SDK namespace.
Definition AlarmChannel.h:21
RadiationParameterSource
Represents the different sources of radiation parameters.
Definition RadiationParameters.h:27
@ Sdk
The radiation parameter are/can be set via the SDK.
Definition RadiationParameters.h:28
Encapsulates the results of the statistical analysis of a measurement field.
Definition FieldProperties.h:42
Holds the radiation parameters for a frame or a measurement field.
Definition RadiationParameters.h:35