ImageBuilder.h

Go to the documentation of this file.

// Copyright (c) 2008-2026 Optris GmbH & Co. KG
 
#pragma once
 
#include <array>
#include <cstdint>
#include <vector>
#include <string>
 
#include "otcsdk/Api.h"
 
#include "otcsdk/common/ThermalFrame.h"
#include "otcsdk/common/Image.h"
 
 
namespace optris
{
 
struct OTC_SDK_API TemperatureRegion
{
  TemperatureRegion() noexcept;
 
  TemperatureRegion(int x1, int y1, int x2, int y2) noexcept;
 
  void reset() noexcept;
 
  bool fitsInRectangle(int width, int height, int padding = 0) const noexcept;
 
 
  float temperature;
 
  int x1;
  int y1;
 
  int x2;
  int y2;
};
 
 
struct IntegralPixel
{
  std::uint64_t value = 0;
  std::uint32_t count = 0;
};
 
 
 
enum class TemperatureScalingMode
{
  Manual,  
  MinMax,  
  Sigma1,  
  Sigma3,  
};
 
 
class ImageBuilder
{
public:
  using LookupTable = std::array<unsigned int, 65536>;
 
 
  OTC_SDK_API ImageBuilder(ColorFormat colorFormat, WidthAlignment widthAlignment);
 
 
  OTC_SDK_API void setThermalFrame(const ThermalFrame& thermalFrame);
 
  const ThermalFrame& getThermalFrame() const noexcept;
 
  int getWidth() const noexcept;
 
  int getHeight() const noexcept;
 
  OTC_SDK_API float getTemperature(int index) const;
 
  OTC_SDK_API float getTemperature(int x, int y) const;
 
  OTC_SDK_API bool getMeanTemperatureInRegion(TemperatureRegion& meanRegion);
 
  OTC_SDK_API bool getMinMaxRegions(int radius, TemperatureRegion& minRegion, TemperatureRegion& maxRegion);
 
 
  // Image conversion
  OTC_SDK_API void setTemperatureScaling(float min, float max);
 
  OTC_SDK_API float getTemperatureScalingMin() const noexcept;
 
  OTC_SDK_API float getTemperatureScalingMax() const noexcept;
 
  OTC_SDK_API float getTemperatureScalingMinFiltered() const noexcept;
 
  OTC_SDK_API float getTemperatureScalingMaxFiltered() const noexcept;
 
  OTC_SDK_API void setTemperatureScalingFilterFactor(float filterFactor);
 
  OTC_SDK_API float getTemperatureScalingFilterFactor() const noexcept;
 
  void setTemperatureScalingMode(TemperatureScalingMode mode) noexcept;
 
  TemperatureScalingMode getTemperatureScalingMode() const noexcept;
 
  OTC_SDK_API void setPalette(const std::string& name);
 
  OTC_SDK_API std::string getPaletteName() const noexcept;
 
  const Image& getImage() noexcept;
 
  int getImageSizeInBytes() const noexcept;
 
  int getImageStride() const noexcept;
 
  OTC_SDK_API void copyImageDataTo(unsigned char* destination, int size) const noexcept;
  
  OTC_SDK_API LookupTable createLookupTable();
 
 
  OTC_SDK_API void convertTemperatureToPaletteImage();
 
  OTC_SDK_API void convertTemperatureToPaletteImage(const LookupTable& lut);
 
  OTC_SDK_API void convertTemperatureToPaletteImage(void* destination, int size);
 
 
private:
  static constexpr float DEFAULT_TEMPERATURE_SCALING_FILTER_FACTOR = 0.96F;
  
 
  void calculateIntegralImage();
 
  void calcMinMaxScalingFactor();
 
  void updateMinValue(float filterFactor = 1.F);
 
  void updateMaxValue(float filterFactor = 1.F);
 
  void calcSigmaScalingFactor(float sigma);
 
  void writeColorImage(unsigned char* dest);
 
  void updateBgraPalette() noexcept;
 
 
  ThermalFrame _thermalFrame;
  TemperatureConverter _converter;
 
  std::vector<IntegralPixel> _integral;
  bool _integralIsDirty;
 
  Image _image;
 
  ImageInfo _imageInfo;
 
  TemperatureScalingMode _scalingMode;
 
  unsigned short _min;
 
  unsigned short _max;
 
  float _minFloat;
 
  float _maxFloat;
  
  float _minFiltered;
 
  float _maxFiltered;
 
  float _scalingFilterFactor;
 
  std::string _paletteName;
  std::array<std::array<uint8_t, 3>, 240> _paletteColors;
  std::array<std::uint32_t, 240> _paletteColorsBgra;
};
 
 
// Inline implementations
inline const ThermalFrame& ImageBuilder::getThermalFrame() const noexcept
{
  return _thermalFrame;
}
 
inline int ImageBuilder::getWidth() const noexcept
{
  return _thermalFrame.getWidth();
}
 
inline int ImageBuilder::getHeight() const noexcept
{
  return _thermalFrame.getHeight();
}
 
inline void ImageBuilder::setTemperatureScalingMode(TemperatureScalingMode mode) noexcept
{
  _scalingMode = mode;
}
 
inline TemperatureScalingMode ImageBuilder::getTemperatureScalingMode() const noexcept
{
  return _scalingMode;
}
 
inline std::string ImageBuilder::getPaletteName() const noexcept
{
  return _paletteName;
}
 
inline const Image& ImageBuilder::getImage() noexcept
{
  return _image;
}
 
inline int ImageBuilder::getImageSizeInBytes() const noexcept
{
  return _imageInfo.getHeight() * _imageInfo.getStride();
}
 
inline int ImageBuilder::getImageStride() const noexcept
{
  return _imageInfo.getStride();
}
 
} // namespace optris