itkRGBPixel.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkRGBPixel_h
#define itkRGBPixel_h
 
// Undefine an eventual RGBPixel macro
#ifdef RGBPixel
#  undef RGBPixel
#endif
 
#include "itkFixedArray.h"
#include "itkMath.h"
 
namespace itk
{
 
template <typename TComponent = unsigned short>
class ITK_TEMPLATE_EXPORT RGBPixel : public FixedArray<TComponent, 3>
{
public:
  using Self = RGBPixel;
  using Superclass = FixedArray<TComponent, 3>;

  using BaseArray = FixedArray<TComponent, 3>;

  static constexpr unsigned int Dimension = 3;

  static constexpr unsigned int Length = 3;

  using ComponentType = TComponent;
  using LuminanceType = typename NumericTraits<ComponentType>::RealType;

#ifdef ITK_FUTURE_LEGACY_REMOVE
  RGBPixel() = default;
#else
  constexpr RGBPixel()
    : Superclass(Superclass())
  {
    // `: Superclass(Superclass())` is a workaround for an old compiler bug. A simple `: Superclass()` triggered
    // warnings from GCC 9.4.0 saying: "warning: '<anonymous>' may be used uninitialized in this function
    // [-Wmaybe-uninitialized]".
  }
#endif
 
#if defined(ITK_LEGACY_REMOVE)
  explicit RGBPixel(const ComponentType & r) { this->Fill(r); }

  RGBPixel(std::nullptr_t) = delete;
#else

  RGBPixel(const ComponentType & r) { this->Fill(r); }
#endif

  template <typename TRGBPixelValueType>
  RGBPixel(const RGBPixel<TRGBPixelValueType> & r)
    : BaseArray(r)
  {}
  RGBPixel(const ComponentType r[3])
    : BaseArray(r)
  {}


  template <typename TRGBPixelValueType>
  Self &
  operator=(const RGBPixel<TRGBPixelValueType> & r)
  {
    BaseArray::operator=(r);
    return *this;
  }

 
  Self &
  operator=(const ComponentType r[3]);

  Self
  operator+(const Self & r) const;
  Self
  operator-(const Self & r) const;
  Self
  operator*(const ComponentType & r) const;
  Self
  operator/(const ComponentType & r) const;

  const Self &
  operator+=(const Self & r);
  const Self &
  operator-=(const Self & r);
  const Self &
  operator*=(const ComponentType & r);
  const Self &
  operator/=(const ComponentType & r);

  bool
  operator<(const Self & r) const;
 
  bool
  operator==(const Self & r) const;

  static unsigned int
  GetNumberOfComponents()
  {
    return 3;
  }

  [[nodiscard]] ComponentType
  GetNthComponent(int c) const
  {
    return this->operator[](c);
  }

  [[nodiscard]] ComponentType
  GetScalarValue() const
  {
    return static_cast<ComponentType>(
      std::sqrt(static_cast<double>(this->operator[](0)) * static_cast<double>(this->operator[](0)) +
                static_cast<double>(this->operator[](1)) * static_cast<double>(this->operator[](1)) +
                static_cast<double>(this->operator[](2)) * static_cast<double>(this->operator[](2))));
  }

  void
  SetNthComponent(int c, const ComponentType & v)
  {
    this->operator[](c) = v;
  }

  void
  SetRed(ComponentType red)
  {
    this->operator[](0) = red;
  }

  void
  SetGreen(ComponentType green)
  {
    this->operator[](1) = green;
  }

  void
  SetBlue(ComponentType blue)
  {
    this->operator[](2) = blue;
  }

  void
  Set(ComponentType red, ComponentType green, ComponentType blue)
  {
    this->operator[](0) = red;
    this->operator[](1) = green;
    this->operator[](2) = blue;
  }

  [[nodiscard]] const ComponentType &
  GetRed() const
  {
    return this->operator[](0);
  }

  [[nodiscard]] const ComponentType &
  GetGreen() const
  {
    return this->operator[](1);
  }

  [[nodiscard]] const ComponentType &
  GetBlue() const
  {
    return this->operator[](2);
  }

  [[nodiscard]] LuminanceType
  GetLuminance() const;
};
 
template <typename TComponent>
std::ostream &
operator<<(std::ostream & os, const RGBPixel<TComponent> & c);
 
template <typename TComponent>
std::istream &
operator>>(std::istream & is, RGBPixel<TComponent> & c);
 
template <typename T>
inline void
swap(RGBPixel<T> & a, RGBPixel<T> & b) noexcept
{
  a.swap(b);
}
 
} // end namespace itk
 
//
// Numeric traits must be included after (optionally) including the explicit
// instantiations control of this class, in case the implicit instantiation
// needs to be disabled.
//
// NumericTraits must be included before (optionally) including the .hxx file,
// in case the .hxx requires to use NumericTraits.
//
#include "itkNumericTraitsRGBPixel.h"
 
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRGBPixel.hxx"
#endif
 
#endif