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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*=========================================================================
*
* 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 itkMovingHistogramImageFilterBase_h
#define itkMovingHistogramImageFilterBase_h
#include "itkKernelImageFilter.h"
#include "itkLexicographicCompare.h"
#include <list>
#include <map>
#include <set>
namespace itk
{
/**
* \class MovingHistogramImageFilterBase
* \brief Implements a generic moving histogram algorithm
*
* This filter is a base class to implement efficiently many neighborhood
* filters. Instead of visiting all the neighbors of a pixel, the set
* of pixels in the neighborhood is updated when the filter is moving
* to a new pixel. The number of pixels read for each pixel can be very
* smaller than the number of pixels read by a basic algorithm.
*
* This filter moves the neighborhood over all the pixels of the output requested region,
* and pass the pixel added and removed of the neighborhood to the an
* histogram class. This filter doesn't implement the histogram class - it
* must be implement and passed as template parameter. The histogram class
* is not necessary a real histogram. It can be implemented in many ways,
* and only has to provide the methods described below.
*
* This filter takes 4 template parameters: the input and output image type,
* the structuring element (or kernel) type, and the histogram type.
* The input and output image must have the same number of dimension.
*
* The histogram type is a class which has to implements seven methods:
* + a default constructor which takes no parameter.
* + void AddPixel( const InputPixelType &p ) is called when a new pixel
* is added to the histogram.
* + void RemovePixel( const InputPixelType &p ) is called when a pixel
* is removed of the histogram.
* + void AddBoundary() is called when a pixel outside the image is added.
* No value is provided: it's the responsibility to the histogram class to
* get it if needed. This method can be kept empty to ignore the boundary
* pixels.
* + void RemoveBoundary() is called to when a pixel outside the image is removed.
* No value is provided: it's the responsibility to the histogram class to
* get it if needed. This method can be kept empty to ignore the boundary
* pixels.
* + AType GetValue() is called to set the value of the output image. AType
* must be the output pixel type, or a type castable to the output pixel type.
*
* MovingHistogramImageFilterBase add the new pixels before removing the old ones,
* so, if AddBoundary() is implemented and/or the kernel is symmetric, it is safe
* to consider that the histogram will never be empty.
*
* One histogram is created for each thread by the method NewHistogram().
* The NewHistogram() method can be overridden to pass some parameters to the
* histogram.
*
* The neighborhood is defined by a structuring element, and must a
* itk::Neighborhood object or a subclass.
* The structuring element is assumed to be composed of binary
* values (zero or one). Only elements of the structuring element
* having values > 0 are candidates for affecting the center pixel.
*
* \sa MovingWindowMeanImageFilter, RankImageFilter, MaskedMovingHistogramImageFilter,
* \sa MovingHistogramMorphologicalGradientImageFilter
* \ingroup ImageEnhancement MathematicalMorphologyImageFilters
*
* \author Gaetan Lehmann
* \author Richard Beare
* \ingroup ITKImageFilterBase
*/
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT MovingHistogramImageFilterBase : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(MovingHistogramImageFilterBase);
/** Standard class type aliases. */
using Self = MovingHistogramImageFilterBase;
using Superclass = KernelImageFilter<TInputImage, TOutputImage, TKernel>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Standard New method. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(MovingHistogramImageFilterBase);
/** Image related type alias. */
using InputImageType = TInputImage;
using OutputImageType = TOutputImage;
using RegionType = typename TInputImage::RegionType;
using SizeType = typename TInputImage::SizeType;
using IndexType = typename TInputImage::IndexType;
using PixelType = typename TInputImage::PixelType;
using OffsetType = typename TInputImage::OffsetType;
using typename Superclass::OutputImageRegionType;
using OutputPixelType = typename TOutputImage::PixelType;
/** Image related type alias. */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
/** Kernel type alias. */
using KernelType = TKernel;
/** Kernel (structuring element) iterator. */
using KernelIteratorType = typename KernelType::ConstIterator;
/** n-dimensional Kernel radius. */
using RadiusType = typename KernelType::SizeType;
using OffsetListType = typename std::list<OffsetType>;
using OffsetMapType = typename std::map<OffsetType, OffsetListType, Functor::LexicographicCompare>;
/** Set kernel (structuring element). */
void
SetKernel(const KernelType & kernel) override;
itkGetConstMacro(PixelsPerTranslation, SizeValueType);
protected:
MovingHistogramImageFilterBase();
~MovingHistogramImageFilterBase() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GetDirAndOffset(const IndexType LineStart,
const IndexType PrevLineStart,
OffsetType & LineOffset,
OffsetType & Changes,
int & LineDirection);
// store the added and removed pixel offset in a list
OffsetMapType m_AddedOffsets{};
OffsetMapType m_RemovedOffsets{};
// store the offset of the kernel to initialize the histogram
OffsetListType m_KernelOffsets{};
FixedArray<int, Self::ImageDimension> m_Axes{};
SizeValueType m_PixelsPerTranslation{};
private:
class DirectionCost
{
public:
DirectionCost(int dimension, int count)
{
m_Dimension = dimension;
m_Count = count;
}
/**
* return true if the object is a worth choice for the best axis
* than the object in parameter
*/
inline bool
operator<(const DirectionCost & dc) const
{
if (m_Count > dc.m_Count)
{
return true;
}
else if (m_Count < dc.m_Count)
{
return false;
}
else // if (m_Count == dc.m_Count)
{
return m_Dimension > dc.m_Dimension;
}
}
int m_Dimension;
int m_Count;
};
}; // end of class
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkMovingHistogramImageFilterBase.hxx"
#endif
#endif
|
