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
|
/*=========================================================================
*
* 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 itkConvolutionImageFilterBase_h
#define itkConvolutionImageFilterBase_h
#include "itkImageToImageFilter.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"
#include "ITKConvolutionExport.h"
namespace itk
{
/** \class ConvolutionImageFilterBaseEnums
* \brief Contains all enum classes used by ConvolutionImageFilterBase class.
* \ingroup ITKConvolution
*/
class ConvolutionImageFilterBaseEnums
{
public:
/**
* \class ConvolutionImageFilterOutputRegion
* \ingroup ITKConvolution
* Output region mode type enumeration
*/
enum class ConvolutionImageFilterOutputRegion : uint8_t
{
SAME = 0,
VALID
};
};
/** Define how to print enumerations */
extern ITKConvolution_EXPORT std::ostream &
operator<<(std::ostream & out, const ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion value);
/**
* \class ConvolutionImageFilterBase
* \brief Abstract base class for the convolution image filters.
*
* \ingroup ITKConvolution
* \sa ConvolutionImageFilter FFTConvolutionImageFilter
*/
template <typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ConvolutionImageFilterBase : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ConvolutionImageFilterBase);
using Self = ConvolutionImageFilterBase;
using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ConvolutionImageFilterBase);
/** Dimensionality of input and output data is assumed to be the same. */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
using InputImageType = TInputImage;
using OutputImageType = TOutputImage;
using KernelImageType = TKernelImage;
using InputPixelType = typename InputImageType::PixelType;
using OutputPixelType = typename OutputImageType::PixelType;
using KernelPixelType = typename KernelImageType::PixelType;
using InputIndexType = typename InputImageType::IndexType;
using OutputIndexType = typename OutputImageType::IndexType;
using KernelIndexType = typename KernelImageType::IndexType;
using InputSizeType = typename InputImageType::SizeType;
using OutputSizeType = typename OutputImageType::SizeType;
using KernelSizeType = typename KernelImageType::SizeType;
using SizeValueType = typename InputSizeType::SizeValueType;
using InputRegionType = typename InputImageType::RegionType;
using OutputRegionType = typename OutputImageType::RegionType;
using KernelRegionType = typename KernelImageType::RegionType;
/** Typedef to describe the boundary condition. */
using BoundaryConditionType = ImageBoundaryCondition<TInputImage>;
#ifndef ITK_FUTURE_LEGACY_REMOVE
using BoundaryConditionPointerType [[deprecated("Please just use `BoundaryConditionType *` instead!")]] =
BoundaryConditionType *;
#endif
using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<TInputImage>;
/** Set/get the boundary condition. */
itkSetMacro(BoundaryCondition, BoundaryConditionType *);
itkGetConstMacro(BoundaryCondition, BoundaryConditionType *);
/** Set/get the image kernel. */
itkSetInputMacro(KernelImage, KernelImageType);
itkGetInputMacro(KernelImage, KernelImageType);
/** Normalize the output image by the sum of the kernel
* components. Defaults to off. */
itkSetMacro(Normalize, bool);
itkGetConstMacro(Normalize, bool);
itkBooleanMacro(Normalize);
/** Reverse compatibility for enumerations */
using OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion;
#if !defined(ITK_LEGACY_REMOVE)
using OutputRegionModeType = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion;
// We need to expose the enum values at the class level
// for backwards compatibility
static constexpr OutputRegionModeEnum SAME = OutputRegionModeEnum::SAME;
static constexpr OutputRegionModeEnum VALID = OutputRegionModeEnum::VALID;
#endif
/** Sets the output region mode. If set to SAME, the output region
* will be the same as the input region, and regions of the image
* near the boundaries will contain contributions from outside the
* input image as determined by the boundary condition set in
* SetBoundaryCondition(). If set to VALID, the output region
* consists of pixels computed only from pixels in the input image
* (no extrapolated contributions from the boundary condition are
* needed). The output is therefore smaller than the input
* region. Default output region mode is SAME. */
itkSetEnumMacro(OutputRegionMode, OutputRegionModeEnum);
itkGetEnumMacro(OutputRegionMode, OutputRegionModeEnum);
virtual void
SetOutputRegionModeToSame();
virtual void
SetOutputRegionModeToValid();
protected:
ConvolutionImageFilterBase();
~ConvolutionImageFilterBase() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** The largest possible output region may differ from the largest
* possible input region. */
void
GenerateOutputInformation() override;
/** Get the valid region of the convolution. */
OutputRegionType
GetValidRegion() const;
/** Default superclass implementation ensures that input images
* occupy same physical space. This is not needed for this filter. */
void
VerifyInputInformation() ITKv5_CONST override{};
private:
bool m_Normalize{ false };
DefaultBoundaryConditionType m_DefaultBoundaryCondition{};
BoundaryConditionType * m_BoundaryCondition{};
OutputRegionModeEnum m_OutputRegionMode{ ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion::SAME };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkConvolutionImageFilterBase.hxx"
#endif
#endif
|
