ImageBuilder.h

Go to the documentation of this file.

// Copyright (c) 2025 Optris GmbH Co. KG

 
#pragma once
 
#include <memory>
#include <array>
 
#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;
};
 
 
enum class ColoringPalette
{
  AlarmBlue,    
  AlarmBlueHi,  
  GrayBW,       
  GrayWB,       
  AlarmGreen,   
  Iron,         
  IronHi,       
  Medical,      
  Rainbow,      
  RainbowHi,    
  AlarmRed,     
};
 

enum class PaletteScalingMethod
{
  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 setManualTemperatureRange(float min, float max);

  OTC_SDK_API float getIsothermalMin() const noexcept;

  OTC_SDK_API float getIsothermalMax() const noexcept;

  void setPaletteScalingMethod(PaletteScalingMethod method) noexcept;

  PaletteScalingMethod getPaletteScalingMethod() const noexcept;

  void setPalette(ColoringPalette palette) noexcept;

  OTC_SDK_API ColoringPalette getPalette() 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);
 
 
private:
  using PaletteTable = unsigned char (*)[3];
 

  void getPaletteTable(PaletteTable& table) const noexcept;
 

  void calculateIntegralImage();

  void calcMinMaxScalingFactor();

  void calcSigmaScalingFactor(float sigma);
 

  ThermalFrame _thermalFrame;
  TemperatureConverter _converter;

  std::unique_ptr<unsigned long[]> _integral;
  bool _integralIsDirty;

  Image _image;

  PaletteScalingMethod _scalingMethod;

  unsigned short _min;
  unsigned short _max;

  ColoringPalette _palette;
};
 
 
// 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::setPaletteScalingMethod(PaletteScalingMethod method) noexcept
{
  _scalingMethod = method;
}
 
inline PaletteScalingMethod ImageBuilder::getPaletteScalingMethod() const noexcept
{
  return _scalingMethod;
}
 
inline void ImageBuilder::setPalette(ColoringPalette palette) noexcept
{
  _palette = palette;
}
 
inline ColoringPalette ImageBuilder::getPalette() const noexcept
{
  return _palette;
}
 
inline const Image& ImageBuilder::getImage() noexcept
{
  return _image;
}
 
inline int ImageBuilder::getImageSizeInBytes() const noexcept
{
  return _image.getSizeInBytes();
}
 
inline int ImageBuilder::getImageStride() const noexcept 
{ 
  return _image.getStride(); 
}
 
} // namespace optris