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
|
/*=========================================================================
*
* 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 itkGradientMagnitudeImageFilter_h
#define itkGradientMagnitudeImageFilter_h
#include "itkImageToImageFilter.h"
namespace itk
{
/**
* \class GradientMagnitudeImageFilter
* \brief Computes the gradient magnitude of an image region at each pixel.
*
* \ingroup GradientFilters
*
* \sa Image
* \sa Neighborhood
* \sa NeighborhoodOperator
* \sa NeighborhoodIterator
* \ingroup ITKImageGradient
*
* \sphinx
* \sphinxexample{Filtering/ImageGradient/ComputeGradientMagnitude,Compute Gradient Magnitude Of Grayscale Image}
* \endsphinx
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT GradientMagnitudeImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(GradientMagnitudeImageFilter);
/** Standard class type aliases. */
using Self = GradientMagnitudeImageFilter;
using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(GradientMagnitudeImageFilter);
/** Extract some information from the image types. Dimensionality
* of the two images is assumed to be the same. */
using OutputPixelType = typename TOutputImage::PixelType;
using InputPixelType = typename TInputImage::PixelType;
using RealType = typename NumericTraits<InputPixelType>::RealType;
/** Extract some information from the image types. Dimensionality
* of the two images is assumed to be the same. */
static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
/** Image type alias support */
using InputImageType = TInputImage;
using OutputImageType = TOutputImage;
using InputImagePointer = typename InputImageType::Pointer;
using OutputImagePointer = typename OutputImageType::Pointer;
/** Superclass type alias. */
using typename Superclass::OutputImageRegionType;
/** GradientMagnitudeImageFilter needs a larger input requested
* region than the output requested region (larger by the kernel
* size to calculate derivatives). As such,
* GradientMagnitudeImageFilter needs to provide an implementation
* for GenerateInputRequestedRegion() in order to inform the
* pipeline execution model.
*
* \sa ImageToImageFilter::GenerateInputRequestedRegion() */
void
GenerateInputRequestedRegion() override;
/** Set/Get whether or not the filter will use the spacing of the input
* image in the computation of the derivatives. Use On to compute the
* gradient in physical space; use Off to ignore image spacing and to
* compute the gradient in isotropic voxel space. Default is On. */
itkSetMacro(UseImageSpacing, bool);
itkGetConstMacro(UseImageSpacing, bool);
itkBooleanMacro(UseImageSpacing);
#if !defined(ITK_FUTURE_LEGACY_REMOVE)
/** Use the image spacing information in calculations. Use this option if you
* want derivatives in physical space. Default is UseImageSpacingOn.
\deprecated Use GradientMagnitudeImageFilter::UseImageSpacingOn instead. */
void
SetUseImageSpacingOn()
{
this->SetUseImageSpacing(true);
}
/** Ignore the image spacing. Use this option if you want derivatives in
isotropic pixel space. Default is UseImageSpacingOn.
\deprecated Use GradientMagnitudeImageFilter::UseImageSpacingOff instead. */
void
SetUseImageSpacingOff()
{
this->SetUseImageSpacing(false);
}
#endif
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
// End concept checking
#endif
protected:
GradientMagnitudeImageFilter();
~GradientMagnitudeImageFilter() override = default;
/** GradientMagnitudeImageFilter can be implemented as a
* multithreaded filter. Therefore, this implementation provides a
* DynamicThreadedGenerateData() routine which is called for each
* processing thread. The output image data is allocated
* automatically by the superclass prior to calling
* DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to
* the portion of the output image specified by the parameter
* "outputRegionForThread"
*
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
void
DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
void
PrintSelf(std::ostream &, Indent) const override;
private:
bool m_UseImageSpacing{ true };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkGradientMagnitudeImageFilter.hxx"
#endif
#endif
|
