pixel_format.h

Go to the documentation of this file.

// Copyright (c) 2011, Hauke Strasdat
// Copyright (c) 2012, Steven Lovegrove
// Copyright (c) 2021, farm-ng, inc.
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.
 
#pragma once
 
#include "sophus/image/image_types.h"
 
namespace sophus {
 
struct PixelFormat {
  template <class TPixel>
  static auto fromTemplate() -> PixelFormat {
    return PixelFormat{
        .number_type =
            std::is_floating_point_v<typename ImageTraits<TPixel>::ChannelT>
                ? NumberType::floating_point
                : NumberType::fixed_point,
        .num_components = ImageTraits<TPixel>::kNumChannels,
        .num_bytes_per_component =
            sizeof(typename ImageTraits<TPixel>::ChannelT)};
  }
 
  [[nodiscard]] inline auto numBytesPerPixel() const -> size_t {
    return num_components * num_bytes_per_component;
  }
 
  template <class TPixel>
  [[nodiscard]] auto is() -> bool {
    return fromTemplate<TPixel>() == *this;
  }
 
  NumberType number_type;
  uint8_t num_components;
  size_t num_bytes_per_component;
};
 
auto operator==(PixelFormat const& lhs, PixelFormat const& rhs) -> bool;
 
/// Example:
/// PixelFormat::fromTemplate<float>() outputs: "1F32";
/// PixelFormat::fromTemplate<Eigen::Matrix<uint8_t,4,1>>() outputs:
/// "4U8";
auto operator<<(std::ostream& os, PixelFormat const& type) -> std::ostream&;
}  // namespace sophus