ImageInfoProperty.h

#pragma once
 
#include <iolink/DataType.h>
#include <iolink/IOLinkAPI.h>
#include <iolink/ImageType.h>
#include <iolink/Vector.h>
 
#include <cstdint>
 
namespace iolink
{
 
enum class ImageInterpretation
{
  UNKNOWN = 0x00,
 
  //==============//
  // Mono channel //
  //==============//
 
  GRAYSCALE = 0x01,
 
  LABEL = 0x02,
 
  BINARY = 0x03,
 
  //==================//
  // CIE color spaces //
  //==================//
 
  CIE_XYZ = 0x11,
 
  CIE_XYZ_CHROMATICITY = 0x12,
 
  CIE_UVW = 0x14,
 
  CIE_LUV = 0x15,
 
  CIE_LAB = 0x16,
 
  //=====================//
  // RGB color encodings //
  //=====================//
 
  RGB = 0x21,
 
  RGB_CHROMATICITY = 0x22,
 
  SRGB = 0x23,
 
  //=============================//
  // Luma/Chroma color encodings //
  //=============================//
 
  YUV = 0x31,
 
  YCC = 0x32,
 
  YIQ = 0x33,
 
  YDD = 0x34,
 
  //===========================//
  // HSX color encoding family //
  //===========================//
 
  HSL = 0x41,
 
  HSV = 0x42,
 
  //============================//
  // CMYK color encoding family //
  //============================//
 
  CMYK = 0x51,
 
  //==========================//
  // Specific interpretations //
  //==========================//
 
  MULTISPECTRAL = 0xFF,
};
 
class IOLINK_API ImageInfoProperty final
{
public:
  static size_t channelCount(ImageInterpretation interpretation);
 
  ImageInfoProperty(ImageType axesInterpretation,
                    ImageInterpretation interpretation,
                    bool hasAlpha,
                    size_t bitDepth,
                    const Vector2d& valueRange);
 
  explicit ImageInfoProperty(ImageType axesInterpretation,
                             ImageInterpretation interpretation,
                             bool hasAlpha,
                             DataType dataType);
 
  explicit ImageInfoProperty(DataType dataType);
 
  ImageInfoProperty(ImageType axesInterpretation, DataType dataType);
 
  ImageInfoProperty(const ImageInfoProperty& other);
  ImageInfoProperty& operator=(const ImageInfoProperty& other);
 
  ImageInfoProperty(ImageInfoProperty&& other) noexcept;
  ImageInfoProperty& operator=(ImageInfoProperty&& other) noexcept;
 
  ~ImageInfoProperty();
 
  ImageType axesInterpretation() const;
 
  void setAxesInterpretation(ImageType type);
 
  ImageInterpretation interpretation() const;
 
  bool hasAlpha() const;
 
  size_t bitDepth() const;
 
  Vector2d valueRange() const;
 
  void setInterpretation(ImageInterpretation interpretation);
 
  void setAlpha(bool hasAlpha);
 
  void setBitDepth(size_t bitdepth);
 
  void setValueRange(const Vector2d& range);
 
  bool operator==(const ImageInfoProperty& other) const;
 
  std::string toString() const;
 
private:
  class Private;
  Private* m_private;
};
 
} // end namespace iolink