PixelTypes.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_io_PixelTypes_h
#define viskores_io_PixelTypes_h
 
#include <viskores/Types.h>
#include <viskores/VecTraits.h>
 
namespace viskores
{
 
namespace io
{
 
namespace internal
{
 
extern int GreyColorType;
extern int RGBColorType;
 
}
 
// ----------------------------------------------------------------------
// Define custom SFINAE structures to calculate the VISKORES types associated
// with provided BitDepths
template <const viskores::Id size, typename = void>
struct ComponentTypeFromSize
{
};
 
template <const viskores::Id size>
struct ComponentTypeFromSize<size, typename std::enable_if<(size == 8)>::type>
{
  using type = viskores::UInt8;
};
template <const viskores::Id size>
struct ComponentTypeFromSize<size, typename std::enable_if<(size == 16)>::type>
{
  using type = viskores::UInt16;
};
// ----------------------------------------------------------------------
 
template <const viskores::Id BitDepth, const viskores::IdComponent Channels>
class BasePixel : public viskores::Vec<typename ComponentTypeFromSize<BitDepth>::type, Channels>
{
  static_assert(BitDepth >= 8, "BitDepth not >= 8");
  static_assert(!(BitDepth & (BitDepth - 1)), "BitDepth not a power of 2");
 
public:
  using Superclass = viskores::Vec<typename ComponentTypeFromSize<BitDepth>::type, Channels>;
  using ComponentType = typename Superclass::ComponentType;
  using BaseType = BasePixel<BitDepth, Channels>;
 
  static constexpr viskores::IdComponent BIT_DEPTH = BitDepth;
  static constexpr viskores::IdComponent NUM_BYTES = BitDepth / 8;
  static constexpr viskores::IdComponent MAX_COLOR_VALUE = (1 << BitDepth) - 1;
  static constexpr viskores::IdComponent NUM_CHANNELS = Superclass::NUM_COMPONENTS;
  static constexpr viskores::IdComponent BYTES_PER_PIXEL = NUM_CHANNELS * NUM_BYTES;
  static constexpr viskores::IdComponent GetBitDepth()
  {
    return BasePixel<BitDepth, Channels>::BIT_DEPTH;
  }
 
  using Superclass::Superclass;
  BasePixel() = default;
 
  BasePixel(const unsigned char* imageData, const viskores::Id index)
    : Superclass(0)
  {
    ConstructPixelFromImage(imageData, index);
  }
 
  virtual ~BasePixel() = default;
 
  virtual ComponentType Diff(const BaseType& pixel) const = 0;
 
  virtual viskores::Vec4f_32 ToVec4f() const = 0;
 
  friend std::ostream& operator<<(std::ostream& os, const BaseType& basePixel)
  {
    basePixel.print(os);
    return os;
  }
 
  void FillImageAtIndexWithPixel(unsigned char* imageData, const viskores::Id index);
 
protected:
  void ConstructPixelFromImage(const unsigned char* imageData, const viskores::Id index);
 
  virtual void print(std::ostream& os) const = 0;
};
 
 
template <const viskores::Id BitDepth>
class RGBPixel : public BasePixel<BitDepth, 3>
{
public:
  // RGB values are stored in a viskores::Vec<ComponentType, 3>
  using Superclass = BasePixel<BitDepth, 3>;
  using ComponentType = typename Superclass::ComponentType;
 
  using Superclass::Superclass;
  RGBPixel() = default;
  RGBPixel(viskores::Vec4f_32 tuple)
    : Superclass(static_cast<ComponentType>(tuple[0] * this->MAX_COLOR_VALUE),
                 static_cast<ComponentType>(tuple[1] * this->MAX_COLOR_VALUE),
                 static_cast<ComponentType>(tuple[2] * this->MAX_COLOR_VALUE))
  {
  }
 
  virtual ~RGBPixel() = default;
 
  // Get the implementation specific color type (Gray|RGB) value
  static int GetColorType();
 
  ComponentType Diff(const Superclass& pixel) const override;
  viskores::Vec4f_32 ToVec4f() const override;
 
protected:
  void print(std::ostream& os) const override
  {
    os << "(" << (int)this->Components[0] << "," << (int)this->Components[1] << ","
       << (int)this->Components[2] << ")";
  }
};
 
// Default types for 8 and 16 bit RGB pixels
using RGBPixel_8 = RGBPixel<8>;
using RGBPixel_16 = RGBPixel<16>;
 
template <const viskores::Id BitDepth>
class GreyPixel : public BasePixel<BitDepth, 1>
{
public:
  // Grey values are stored in a viskores::Vec<ComponentType, 1>
  // Note: A vec of size 1 is used instead of just a `ComponentType`
  // in order to simplify the pixel helper functions
  using Superclass = BasePixel<BitDepth, 1>;
  using ComponentType = typename Superclass::ComponentType;
 
  using Superclass::Superclass;
  GreyPixel() = default;
  GreyPixel(viskores::Vec4f_32 tuple)
    : Superclass(
        static_cast<ComponentType>((tuple[0] + tuple[1] + tuple[2]) * this->MAX_COLOR_VALUE / 3))
  {
  }
 
  virtual ~GreyPixel() = default;
 
  // Get the implementation specific color type (Gray|RGB) value
  static int GetColorType();
 
  ComponentType Diff(const Superclass& pixel) const override;
  viskores::Vec4f_32 ToVec4f() const override;
 
protected:
  void print(std::ostream& os) const override { os << "(" << (int)this->Components[0] << ")"; }
};
 
// Default types for 8 and 16 bit Grey pixels
using GreyPixel_16 = GreyPixel<16>;
using GreyPixel_8 = GreyPixel<8>;
 
} // namespace io
} // namespace viskores
 
#include <viskores/io/PixelTypes.hxx>
 
#endif //viskores_io_PixelTypes_h