File: itkFFTDiscreteGaussianImageFilter.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (193 lines) | stat: -rw-r--r-- 7,225 bytes parent folder | download
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
/*=========================================================================
 *
 *  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 itkFFTDiscreteGaussianImageFilter_h
#define itkFFTDiscreteGaussianImageFilter_h

#include "itkDiscreteGaussianImageFilter.h"
#include "itkFFTConvolutionImageFilter.h"
#include "itkImage.h"
#include "itkMacro.h"
#include "ITKSmoothingExport.h"

namespace itk
{
/** \class FFTDiscreteGaussianImageFilterEnums
 * \brief Contains all enum classes used by FFTDiscreteGaussianImageFilter class.
 * \ingroup ITKSmoothing
 */
class FFTDiscreteGaussianImageFilterEnums
{
public:
  /**
   * \class KernelSource
   * \ingroup ITKSmoothing
   * ITK defines multiple possible sources for generating a
   * Gaussian kernel for smoothing.
   *
   * Generating an ND kernel by multiplying
   * N 1D directional operators produces nearly identical
   * results to the DiscreteGaussianImageFilter class.
   *
   * Generating an ND kernel image directly with
   * GaussianImageSource relies on a slightly different
   * spatial function and will produce different smoothing,
   * but kernel generation will be faster.
   */
  enum class KernelSource : uint8_t
  {
    OPERATORS = 0,
    IMAGE_SOURCE,
  };
};
// Define how to print enumeration
extern ITKSmoothing_EXPORT std::ostream &
                           operator<<(std::ostream & out, const FFTDiscreteGaussianImageFilterEnums::KernelSource value);

/**
 * \class FFTDiscreteGaussianImageFilter
 * \brief Blurs an image by convolution with a discrete gaussian kernel
 * in the frequency domain.
 *
 * This filter performs Gaussian blurring by convolution of an image
 * and a discrete Gaussian operator (kernel) in the frequency domain
 * by way of Fast Fourier Transform forward and inverse operations.
 *
 * \sa DiscreteGaussianImageFilter
 * \sa GaussianImageSource
 * \sa FFTConvolutionImageFilter
 * \sa RecursiveGaussianImageFilter
 * \sa ZeroFluxNeumannBoundaryCondition
 *
 * \ingroup ImageEnhancement
 * \ingroup ImageFeatureExtraction
 * \ingroup ITKSmoothing
 */

template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT FFTDiscreteGaussianImageFilter : public DiscreteGaussianImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FFTDiscreteGaussianImageFilter);

  /** Standard class type aliases. */
  using Self = FFTDiscreteGaussianImageFilter;
  using Superclass = DiscreteGaussianImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(FFTDiscreteGaussianImageFilter);

  /** Image type information. */
  using InputImageType = typename Superclass::InputImageType;
  using OutputImageType = typename Superclass::OutputImageType;

  /** Extract some information from the image types.  Dimensionality
   * of the two images is assumed to be the same. */
  using OutputPixelType = typename Superclass::OutputPixelType;
  using OutputInternalPixelType = typename Superclass::OutputInternalPixelType;
  using InputPixelType = typename Superclass::InputPixelType;
  using InputInternalPixelType = typename Superclass::InputInternalPixelType;

  /** Pixel value type for Vector pixel types **/
  using InputPixelValueType = typename Superclass::InputPixelValueType;
  using OutputPixelValueType = typename Superclass::OutputPixelValueType;

  /** Extract some information from the image types.  Dimensionality
   * of the two images is assumed to be the same. */
  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  /** Type of the pixel to use for intermediate results */
  using typename Superclass::RealOutputPixelType;
  using typename Superclass::RealOutputImageType;
  using typename Superclass::RealOutputPixelValueType;
  using RealPixelType = RealOutputPixelType;
  using RealImageType = RealOutputImageType;

  /** Typedef to describe the boundary condition. */
  using typename Superclass::BoundaryConditionType;
  using typename Superclass::InputBoundaryConditionPointerType;
  using typename Superclass::InputDefaultBoundaryConditionType;
  using typename Superclass::RealBoundaryConditionPointerType;
  using typename Superclass::RealDefaultBoundaryConditionType;

  /** Typedef of double containers */
  using typename Superclass::ArrayType;
  using typename Superclass::SigmaArrayType;
  using typename Superclass::ScalarRealType;

  /** Typedef to describe kernel parameters */
  using typename Superclass::KernelType;
  using typename Superclass::RadiusType;

  /** Typedef for convolution */
  using ConvolutionImageFilterType = FFTConvolutionImageFilter<RealImageType, RealImageType, OutputImageType>;

  /** Overridden accessors for unused parameters */

  void
  SetInputBoundaryCondition(const InputBoundaryConditionPointerType) override;

  itkSetMacro(KernelSource, FFTDiscreteGaussianImageFilterEnums::KernelSource);
  itkGetConstMacro(KernelSource, FFTDiscreteGaussianImageFilterEnums::KernelSource);

  itkGetConstMacro(KernelImage, typename RealImageType::Pointer);

protected:
  FFTDiscreteGaussianImageFilter() = default;
  ~FFTDiscreteGaussianImageFilter() override = default;

  /** Pad input region to kernel image size */
  void
  GenerateInputRequestedRegion() override;

  /** Standard pipeline method. While this class does not implement a
   * ThreadedGenerateData(), its GenerateData() delegates all
   * calculations to an NeighborhoodOperatorImageFilter.  Since the
   * NeighborhoodOperatorImageFilter is multithreaded, this filter is
   * multithreaded by default. */
  void
  GenerateData() override;

  /** Create a kernel image matching user input specifications.
   *  Returns a reference to the member m_KernelImage. */
  auto
  GenerateKernelImage() -> RealImageType *;

private:
  /* Enum for choosing among available kernel generation methods */
  FFTDiscreteGaussianImageFilterEnums::KernelSource m_KernelSource =
    FFTDiscreteGaussianImageFilterEnums::KernelSource::OPERATORS;

  /* Kernel image is allocated with GenerateKernelImage() */
  typename RealImageType::Pointer m_KernelImage{};

  /* Persist mini-pipeline filter to minimize construction costs
   * on repeated calls to GenerateData() */
  typename ConvolutionImageFilterType::Pointer m_ConvolutionImageFilter = ConvolutionImageFilterType::New();
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFFTDiscreteGaussianImageFilter.hxx"
#endif

#endif