1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/*=========================================================================
*
* 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 itkLabelOverlayImageFilter_h
#define itkLabelOverlayImageFilter_h
#include "itkLabelOverlayFunctor.h"
#include "itkBinaryGeneratorImageFilter.h"
#include "itkConceptChecking.h"
namespace itk
{
/**
* \class LabelOverlayImageFilter
* \brief Apply a colormap to a label image and put it on top of the
* input image
*
* Apply a colormap to a label image and put it on top of the input image.
* The set of colors is a good selection of distinct colors. The opacity of
* the label image can be defined by the user. The user can also choose if
* the want to use a background and which label value is the background.
* A background label produce a gray pixel with the same intensity
* than the input one.
*
* \author Gaetan Lehmann. Biologie du Developpement et de la Reproduction,
* INRA de Jouy-en-Josas, France.
*
* This class was contributed to the Insight Journal
* https://www.insight-journal.org/browse/publication/79
*
* \sa LabelToRGBImageFilter
* \sa LabelMapOverlayImageFilter, LabelOverlayFunctor
* \ingroup MultiThreaded
*
* \ingroup ITKImageFusion
*
* \sphinx
* \sphinxexample{Filtering/ImageFusion/OverlayLabelMapOnImage,Overlay Label Map On Image}
* \endsphinx
*/
template <typename TInputImage, typename TLabelImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT LabelOverlayImageFilter
: public BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(LabelOverlayImageFilter);
/** Standard class type aliases. */
using Self = LabelOverlayImageFilter;
using Superclass = BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>;
using FunctorType = Functor::LabelOverlayFunctor<typename TInputImage::PixelType,
typename TLabelImage::PixelType,
typename TOutputImage::PixelType>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using OutputImageType = TOutputImage;
using LabelImageType = TLabelImage;
using InputImageType = TInputImage;
using OutputPixelType = typename TOutputImage::PixelType;
using LabelPixelType = typename TLabelImage::PixelType;
using InputPixelType = typename TInputImage::PixelType;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(LabelOverlayImageFilter);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Set/Get the label image. */
void
SetLabelImage(const TLabelImage * input);
const LabelImageType *
GetLabelImage() const;
/** Set/Get the opacity of the colored label image. The value must be
* between 0 and 1.
*/
itkSetMacro(Opacity, double);
itkGetConstReferenceMacro(Opacity, double);
/** Set/Get the background value. */
itkSetMacro(BackgroundValue, LabelPixelType);
itkGetConstReferenceMacro(BackgroundValue, LabelPixelType);
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(OutputPixelShouldHaveValueType, (Concept::HasValueType<OutputPixelType>));
itkConceptMacro(OutputPixelShouldHaveBracketOperator,
(Concept::BracketOperator<OutputPixelType, unsigned int, typename OutputPixelType::ValueType>));
// End concept checking
#endif
/** Empty the color LUT container. */
void
ResetColors();
/** Get number of colors in the LUT container. */
unsigned int
GetNumberOfColors() const;
/** type of the color component. */
using ComponentType = typename OutputPixelType::ComponentType;
/** Add color to the LUT container. */
void
AddColor(ComponentType r, ComponentType g, ComponentType b);
itkGetConstReferenceMacro(Functor, FunctorType);
FunctorType &
GetFunctor()
{
return m_Functor;
}
protected:
LabelOverlayImageFilter();
~LabelOverlayImageFilter() override = default;
/** Process to execute before entering the multithreaded section */
void
BeforeThreadedGenerateData() override;
/** Print internal ivars */
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GenerateOutputInformation() override;
private:
FunctorType m_Functor{};
double m_Opacity{};
LabelPixelType m_BackgroundValue{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkLabelOverlayImageFilter.hxx"
#endif
#endif
|
