itkScalarToRGBPixelFunctor.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 itkScalarToRGBPixelFunctor_h
#define itkScalarToRGBPixelFunctor_h
 
#include "itkRGBPixel.h"
 
namespace itk::Functor
{
template <typename TScalar>
class ITK_TEMPLATE_EXPORT ScalarToRGBPixelFunctor
{
public:
  ScalarToRGBPixelFunctor();
  ~ScalarToRGBPixelFunctor() = default;
 
  using RGBComponentType = unsigned char;
  using RGBPixelType = RGBPixel<RGBComponentType>;
  using ScalarType = TScalar;
 
  RGBPixelType
  operator()(const TScalar &) const;
 
  void
  SetLittleEndian()
  {
    m_UseMSBForHashing = false;
  }
 
  void
  SetBigEndian()
  {
    m_UseMSBForHashing = true;
  }
 
  void
  SetUseMSBForHashing(bool value)
  {
    m_UseMSBForHashing = value;
  }
 
  [[nodiscard]] bool
  GetUseMSBForHashing() const
  {
    return m_UseMSBForHashing;
  }
 
  void
  UseMSBForHashingOn()
  {
    m_UseMSBForHashing = true;
  }
 
  void
  UseMSBForHashingOff()
  {
    m_UseMSBForHashing = false;
  }
 
 
private:
  bool         m_UseMSBForHashing;
  unsigned int m_ColorIndex[3];
};
} // namespace itk::Functor
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarToRGBPixelFunctor.hxx"
#endif
 
#endif