MeasurementField.h

Go to the documentation of this file.

// Copyright (c) 2008-2025 Optris GmbH & Co. KG

 
#pragma once
 
#include <string>
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
#include "otcsdk/common/TemperatureConverter.h"
#include "otcsdk/fields/MeasurementFieldConfig.h"
#include "otcsdk/fields/MeasurementFieldIterator.h"
 
 
namespace optris
{

class MeasurementField
{
  // Special iterator access.
  friend class ConstMeasurementFieldIterator;
  
 
public:
  OTC_SDK_API MeasurementField() noexcept;

  OTC_SDK_API MeasurementField(const MeasurementFieldConfig& config, 
                               long long                     fieldId,
                               int                           referenceFrameWidth,
                               int                           referenceFrameHeight);
 

  OTC_SDK_API MeasurementField(const MeasurementField& rhs) = default;
  OTC_SDK_API MeasurementField& operator=(const MeasurementField& rhs) = default;

  OTC_SDK_API MeasurementField(MeasurementField&& rhs) noexcept = default;
  OTC_SDK_API MeasurementField& operator=(MeasurementField&& rhs) noexcept = default;

  OTC_SDK_API ~MeasurementField() = default;
 

  MeasurementFieldConfig getConfig() const noexcept;

  long long getId() const noexcept;

  int getIndex() const noexcept;

  void setIndex(int index) noexcept;

  std::string getName() const noexcept;

  void setName(const std::string& name) noexcept;

  OTC_SDK_API unsigned short getValue(int index) const;

  float getTemperature(int index) const;

  OTC_SDK_API unsigned short getValue(int x, int y) const;

  float getTemperature(int x, int y) const noexcept(false);
 

  ConstMeasurementFieldIterator getConstIterator() const noexcept;

  TemperaturePrecision getTemperaturePrecision() const noexcept;

  int getX() const noexcept;

  int getY() const noexcept;

  OTC_SDK_API void setPosition(int x, int y) noexcept;

  FieldShape getShape() const noexcept;

  FieldMode getMode() const noexcept;

  void setMode(FieldMode mode) noexcept;

  int getWidth() const noexcept;

  int getHeight() const noexcept;

  int getSize() const noexcept;

  OTC_SDK_API void resize(int width, int height);

  OTC_SDK_API void scale(int frameWidth, int frameHeight);
 

  RadiationParameterSource getEmissivitySource() const noexcept;

  RadiationParameterSource getTransmissivitySource() const noexcept;

  RadiationParameterSource getAmbientTemperatureSource() const noexcept;
 

  RadiationParameters getRadiationParameters() const noexcept;

  void setRadiationParameters(const RadiationParameters& radiation) noexcept;

  void setRadiationParameterSources(RadiationParameterSource   emissivitySource,
                                    RadiationParameterSource   ambientTemperatureSource) noexcept;
 

  float getMeanTemperature() const noexcept;

  float getMinTemperature() const noexcept;

  float getMaxTemperature() const noexcept;

  OTC_SDK_API float getDataPoint() const noexcept;

  void setTemperatures(float mean, float min, float max) noexcept;
 

  TemperatureConverter getConverter() const noexcept;
  

  MeasurementField clone() const noexcept;

  OTC_SDK_API void setData(const unsigned short* source, int frameWidth, TemperaturePrecision precision);

  OTC_SDK_API void setFromRawData(const void* source, TemperaturePrecision precision);

  OTC_SDK_API void copyTemperaturesTo(float* destination, int size) const noexcept;

  OTC_SDK_API void copyDataTo(unsigned short* destination, int size) const noexcept;

  const unsigned short* getData() const noexcept;
  
 
private:
  MeasurementFieldConfig _config;

  long long _id;
  int _index;

  int _positionXScaled;
  int _positionYScaled;

  int _widthScaled;
  int _heightScaled;

  int _referenceFrameWidth;
  int _referenceFrameHeight;

  RadiationParameterSource _emissivitySource;
  RadiationParameterSource _ambientTemperatureSource;

  std::vector<unsigned short> _values;

  float _meanTemperature;
  float _minTemperature;
  float _maxTemperature;

  TemperatureConverter _converter;
};
 
 
// Inline implementations
inline MeasurementFieldConfig MeasurementField::getConfig() const noexcept
{
  return _config;
}
 
inline long long MeasurementField::getId() const noexcept
{
  return _id;
}
 
inline int MeasurementField::getIndex() const noexcept
{
  return _index;
}
 
inline void MeasurementField::setIndex(int index) noexcept
{
  _index = index;
}
 
inline std::string MeasurementField::getName() const noexcept
{
  return _config.name;
}
 
inline void MeasurementField::setName(const std::string& name) noexcept
{
  _config.name = name;
}
 
inline float MeasurementField::getTemperature(int index) const noexcept(false)
{
  return _converter.toTemperature(getValue(index));
}
 
inline float MeasurementField::getTemperature(int x, int y) const noexcept(false)
{
  return _converter.toTemperature(getValue(x, y));
}
 
inline ConstMeasurementFieldIterator MeasurementField::getConstIterator() const noexcept
{
  return ConstMeasurementFieldIterator{*this};
}
 
inline TemperaturePrecision MeasurementField::getTemperaturePrecision() const noexcept
{
  return _converter.getPrecision();
}
 
inline int MeasurementField::getX() const noexcept
{
  return _positionXScaled;
}
 
inline int MeasurementField::getY() const noexcept
{
  return _positionYScaled;
}
 
inline FieldShape MeasurementField::getShape() const noexcept
{
  return _config.shape;
}
 
inline FieldMode MeasurementField::getMode() const noexcept
{
  return _config.mode;
}
 
inline void MeasurementField::setMode(FieldMode mode) noexcept
{
  _config.mode = mode;
}
 
inline int MeasurementField::getWidth() const noexcept
{
  return _widthScaled;
}
 
inline int MeasurementField::getHeight() const noexcept
{
  return _heightScaled;
}
 
inline int MeasurementField::getSize() const noexcept
{
  return static_cast<int>(_values.size());
}
 
inline RadiationParameterSource MeasurementField::getEmissivitySource() const noexcept
{
  return _emissivitySource;
}
 
inline RadiationParameterSource MeasurementField::getTransmissivitySource() const noexcept
{
  return RadiationParameterSource::Sdk;
}
 
inline RadiationParameterSource MeasurementField::getAmbientTemperatureSource() const noexcept
{
  return _ambientTemperatureSource;
}
 
inline RadiationParameters MeasurementField::getRadiationParameters() const noexcept
{
  return _config.radiation;
}
 
inline void MeasurementField::setRadiationParameters(const RadiationParameters& radiation) noexcept
{
  _config.radiation = radiation;
}
 
inline void MeasurementField::setRadiationParameterSources(RadiationParameterSource emissivitySource,
                                                           RadiationParameterSource ambientTemperatureSource) noexcept
{
  _emissivitySource         = emissivitySource;
  _ambientTemperatureSource = ambientTemperatureSource;
}
 
inline float MeasurementField::getMeanTemperature() const noexcept
{
  return _meanTemperature;
}
 
inline float MeasurementField::getMinTemperature() const noexcept
{
  return _minTemperature;
}
 
inline float MeasurementField::getMaxTemperature() const noexcept
{
  return _maxTemperature;
}
 
inline void MeasurementField::setTemperatures(float mean, float min, float max) noexcept
{
  _meanTemperature = mean;
  _minTemperature  = min;
  _maxTemperature  = max;
}
 
inline TemperatureConverter MeasurementField::getConverter() const noexcept
{
  return _converter;
}
 
inline MeasurementField MeasurementField::clone() const noexcept
{
  return MeasurementField{*this};
}
 
inline const unsigned short* MeasurementField::getData() const noexcept
{
  return _values.data();
}
 
} // namespace optris