ITK  5.2.0
Insight Toolkit
itkScalarToRGBPixelFunctor.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkScalarToRGBPixelFunctor_h
19 #define itkScalarToRGBPixelFunctor_h
20 
21 #include "itkRGBPixel.h"
22 
23 namespace itk
24 {
25 namespace Functor
26 {
43 template <typename TScalar>
44 class ITK_TEMPLATE_EXPORT ScalarToRGBPixelFunctor
45 {
46 public:
48  ~ScalarToRGBPixelFunctor() = default;
50 
51  using RGBComponentType = unsigned char;
53  using ScalarType = TScalar;
54 
56  operator()(const TScalar &) const;
57 
58  void
60  {
61  m_UseMSBForHashing = false;
62  }
63 
64  void
66  {
67  m_UseMSBForHashing = true;
68  }
69 
70  void
71  SetUseMSBForHashing(bool value)
72  {
73  m_UseMSBForHashing = value;
74  }
75 
76  bool
78  {
79  return m_UseMSBForHashing;
80  }
81 
82  void
84  {
85  m_UseMSBForHashing = true;
86  }
87 
88  void
90  {
91  m_UseMSBForHashing = false;
92  }
93 
94 
95 private:
97  unsigned int m_ColorIndex[3];
98 };
99 } // end namespace Functor
100 } // end namespace itk
101 
102 #ifndef ITK_MANUAL_INSTANTIATION
103 # include "itkScalarToRGBPixelFunctor.hxx"
104 #endif
105 
106 #endif
itk::RGBPixel
Represent Red, Green and Blue components for color images.
Definition: itkRGBPixel.h:58
itk::Functor::ScalarToRGBPixelFunctor
A Function object which maps a scalar value into an RGB pixel value.
Definition: itkScalarToRGBPixelFunctor.h:44
itkRGBPixel.h
itk::Functor::ScalarToRGBPixelFunctor::SetBigEndian
void SetBigEndian()
Definition: itkScalarToRGBPixelFunctor.h:65
itk::Functor::ScalarToRGBPixelFunctor::UseMSBForHashingOff
void UseMSBForHashingOff()
Definition: itkScalarToRGBPixelFunctor.h:89
itk::Functor::ScalarToRGBPixelFunctor::SetLittleEndian
void SetLittleEndian()
Definition: itkScalarToRGBPixelFunctor.h:59
itk::Functor::ScalarToRGBPixelFunctor::GetUseMSBForHashing
bool GetUseMSBForHashing() const
Definition: itkScalarToRGBPixelFunctor.h:77
itk::Functor::ScalarToRGBPixelFunctor::ScalarType
TScalar ScalarType
Definition: itkScalarToRGBPixelFunctor.h:53
itk::Functor::ScalarToRGBPixelFunctor::UseMSBForHashingOn
void UseMSBForHashingOn()
Definition: itkScalarToRGBPixelFunctor.h:83
itk::Functor::ScalarToRGBPixelFunctor::RGBComponentType
unsigned char RGBComponentType
Definition: itkScalarToRGBPixelFunctor.h:51
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Functor::ScalarToRGBPixelFunctor::SetUseMSBForHashing
void SetUseMSBForHashing(bool value)
Definition: itkScalarToRGBPixelFunctor.h:71
itk::Functor::ScalarToRGBPixelFunctor::m_UseMSBForHashing
bool m_UseMSBForHashing
Definition: itkScalarToRGBPixelFunctor.h:96