itkNumericTraitsRGBPixel.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 itkNumericTraitsRGBPixel_h
#define itkNumericTraitsRGBPixel_h
 
#include "itkNumericTraits.h"
#include "itkRGBPixel.h"
 
namespace itk
{
template <typename T>
class NumericTraits<RGBPixel<T>>
{
private:
  using ElementAbsType = typename NumericTraits<T>::AbsType;
  using ElementAccumulateType = typename NumericTraits<T>::AccumulateType;
  using ElementFloatType = typename NumericTraits<T>::FloatType;
  using ElementPrintType = typename NumericTraits<T>::PrintType;
  using ElementRealType = typename NumericTraits<T>::RealType;
 
public:
  using ValueType = T;
 
  using Self = RGBPixel<T>;

  using AbsType = RGBPixel<ElementAbsType>;

  using AccumulateType = RGBPixel<ElementAccumulateType>;

  using FloatType = RGBPixel<ElementFloatType>;

  using PrintType = RGBPixel<ElementPrintType>;

  using RealType = RGBPixel<ElementRealType>;

  using ScalarRealType = ElementRealType;

  using MeasurementVectorType = Self;

  static Self
  max(const Self &)
  {
    return MakeFilled<Self>(NumericTraits<T>::max());
  }
 
  static Self
  min(const Self &)
  {
    return MakeFilled<Self>(NumericTraits<T>::min());
  }
 
  static Self
  max()
  {
    return MakeFilled<Self>(NumericTraits<T>::max());
  }
 
  static Self
  min()
  {
    return MakeFilled<Self>(NumericTraits<T>::min());
  }
 
  static Self
  NonpositiveMin()
  {
    return MakeFilled<Self>(NumericTraits<T>::NonpositiveMin());
  }
 
  static Self
  ZeroValue()
  {
    return Self{};
  }
 
  static Self
  OneValue()
  {
    return MakeFilled<Self>(NumericTraits<T>::OneValue());
  }
 
  static Self
  NonpositiveMin(const Self &)
  {
    return NonpositiveMin();
  }
 
  static Self
  ZeroValue(const Self &)
  {
    return ZeroValue();
  }
 
  static Self
  OneValue(const Self &)
  {
    return OneValue();
  }

  static bool
  IsPositive(Self val)
  {
    return NumericTraits<typename Self::LuminanceType>::IsPositive(val.GetLuminance());
  }

  static bool
  IsNonpositive(Self val)
  {
    return NumericTraits<typename Self::LuminanceType>::IsNonpositive(val.GetLuminance());
  }

  static bool
  IsNegative(Self val)
  {
    return NumericTraits<typename Self::LuminanceType>::IsNegative(val.GetLuminance());
  }

  static bool
  IsNonnegative(Self val)
  {
    return NumericTraits<typename Self::LuminanceType>::IsNonnegative(val.GetLuminance());
  }
 
  static constexpr bool IsSigned = std::is_signed_v<ValueType>;
  static constexpr bool IsInteger = std::is_integral_v<ValueType>;
  static constexpr bool IsComplex = NumericTraits<ValueType>::IsComplex;

  static void
  SetLength(RGBPixel<T> & m, const unsigned int s)
  {
    if (s != 3)
    {
      itkGenericExceptionMacro("Cannot set the size of a RGBPixel to anything other than 3.");
    }
    m.Fill(T{});
  }

  static constexpr unsigned int
  GetLength(const RGBPixel<T> &)
  {
    return 3;
  }

  static constexpr unsigned int
  GetLength()
  {
    return 3;
  }
 
  static void
  AssignToArray(const Self & v, MeasurementVectorType & mv)
  {
    mv = v;
  }
 
  template <typename TArray>
  static void
  AssignToArray(const Self & v, TArray & mv)
  {
    for (unsigned int i = 0; i < 3; ++i)
    {
      mv[i] = v[i];
    }
  }

  static const Self ITKCommon_EXPORT Zero;
  static const Self ITKCommon_EXPORT One;
};
} // end namespace itk
 
#endif // itkNumericTraitsRGBPixel_h