ImageType.h

#pragma once
 
#include <cstdint>
#include <initializer_list>
#include <string>
 
#include <iolink/IOLinkAPI.h>
 
namespace iolink
{
 
enum class ImageDimension
{
  COLUMN = 0,
  ROW = 1,
  SLICE = 2,
  CHANNEL = 3,
  SEQUENCE = 4,
};
 
// create an alias for ImageDimension
using ImageAxis = ImageDimension;
 
class IOLINK_API ImageType
{
public:
  ImageType();
 
  explicit ImageType(ImageDimension dimension);
 
  explicit ImageType(const ImageDimension* dimensionsList, size_t count);
 
  explicit ImageType(std::initializer_list<ImageDimension> dimensionsList);
 
  explicit ImageType(uint64_t val);
 
  bool has(ImageDimension dimension) const;
 
  void add(ImageDimension dimension);
 
  size_t dimensionCount() const;
 
  void add(ImageType other);
 
  void remove(ImageDimension dimension);
 
  void remove(size_t index);
 
  void remove(ImageType other);
 
  ImageDimension dimension(size_t index) const;
 
  size_t indexDimension(ImageDimension dimension);
 
  ImageType operator|(ImageDimension rhs) const;
 
  bool operator==(ImageType other) const;
 
  bool operator!=(ImageType other) const;
 
  std::string toString() const;
 
  uint64_t value() const;
 
private:
  static uint64_t dimensionFlag(ImageDimension dimension);
 
  uint64_t m_value;
};
 
inline ImageType
operator|(ImageDimension lhs, ImageDimension rhs)
{
  return ImageType(ImageType(lhs) | rhs);
}
 
// create an alias for ImageType
using AxesInterpretation = ImageType;
 
inline ImageType
operator|(ImageDimension lhs, ImageType rhs)
{
  return rhs | lhs;
}
 
class IOLINK_API ImageTypeId
{
public:
  static const ImageType UNKNOWN;
  static const ImageType IMAGE;
  static const ImageType VOLUME;
  static const ImageType MULTISPECTRAL_IMAGE;
  static const ImageType MULTISPECTRAL_VOLUME;
  static const ImageType IMAGE_SEQUENCE;
  static const ImageType VOLUME_SEQUENCE;
  static const ImageType MULTISPECTRAL_IMAGE_SEQUENCE;
  static const ImageType MULTISPECTRAL_VOLUME_SEQUENCE;
};
 
// create an alias for ImageTypeId
using AxesInterpretationId = ImageTypeId;
 
} // end namespace iolink