Image.h

Go to the documentation of this file.

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

 
#pragma once
 
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
#include "otcsdk/common/Pixel.h"
#include "otcsdk/common/ImageInfo.h"
#include "otcsdk/common/ImageIterator.h"
 
 
namespace optris
{

class Image
{
  // Special iterator access.
  friend class ImageIterator;
  friend class ConstImageIterator;
 
 
public:
  OTC_SDK_API Image(ColorFormat colorFormat, WidthAlignment widthAlignment) noexcept;
 

  OTC_SDK_API Pixel getPixel(int index) const;

  OTC_SDK_API Pixel getPixel(int x, int y) const;

  OTC_SDK_API void setPixel(int index, const Pixel& pixel);

  OTC_SDK_API void setPixel(int x, int y, const Pixel& pixel);

  OTC_SDK_API ImageIterator getIterator() noexcept;

  OTC_SDK_API ConstImageIterator getConstIterator() const noexcept;

  OTC_SDK_API int getWidth() const noexcept;

  OTC_SDK_API int getStride() const noexcept;

  OTC_SDK_API int getHeight() const noexcept;

  OTC_SDK_API int getSize() const noexcept;

  OTC_SDK_API int getSizeInBytes() const noexcept;

  OTC_SDK_API bool isEmpty() const noexcept;

  OTC_SDK_API void clear();

  OTC_SDK_API void resize(int width, int height);

  OTC_SDK_API ColorFormat getColorFormat() const noexcept;

  OTC_SDK_API WidthAlignment getWidthAlignment() const noexcept;

  OTC_SDK_API Image clone() const noexcept;

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

  OTC_SDK_API const unsigned char* getData() const noexcept;
 
 
private:
  ImageInfo _info;
 
  std::vector<unsigned char> _pixelValues;
};
 
 
// Inline implementations
inline ImageIterator Image::getIterator() noexcept
{
  return ImageIterator{*this};
}
 
inline ConstImageIterator Image::getConstIterator() const noexcept
{
  return ConstImageIterator{*this};
}
 
inline int Image::getWidth() const noexcept
{
  return _info.getWidth();
}
 
inline int Image::getStride() const noexcept
{
  return _info.getStride();
}
 
inline int Image::getHeight() const noexcept
{
  return _info.getHeight();
}
 
inline int Image::getSize() const noexcept
{
  return _info.getSize();
}
 
inline int Image::getSizeInBytes() const noexcept
{
  return static_cast<unsigned int>(_pixelValues.size());
}
 
inline bool Image::isEmpty() const noexcept
{
  return _pixelValues.empty();
}
 
inline ColorFormat Image::getColorFormat() const noexcept
{
  return _info.getColorFormat();
}
 
inline WidthAlignment Image::getWidthAlignment() const noexcept
{
  return _info.getWidthAlignment();
}
 
inline Image Image::clone() const noexcept
{
  return Image{*this};
}
 
inline const unsigned char* Image::getData() const noexcept
{
  return _pixelValues.data();
}
 
} // namespace optris