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
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkGradientImageFilter.h,v $
Language: C++
Date: $Date: 2007-10-08 11:18:50 $
Version: $Revision: 1.16 $
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkGradientImageFilter_h
#define __itkGradientImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkImage.h"
#include "itkCovariantVector.h"
namespace itk
{
/** \class GradientImageFilter
* \brief Computes the gradient of an image using directional derivatives.
*
* Computes the gradient of an image using directional derivatives.
* The directional derivative at each pixel location is computed by
* convolution with a first-order derivative operator.
*
* The second template parameter defines the value type used in the
* derivative operator (defaults to float). The third template
* parameter defines the value type used for output image (defaults to
* float). The output image is defined as a covariant vector image
* whose value type is specified as this third template parameter.
*
*
* \sa Image
* \sa Neighborhood
* \sa NeighborhoodOperator
* \sa NeighborhoodIterator
*
* \ingroup GradientFilters
*/
template <class TInputImage, class TOperatorValueType=float, class TOutputValueType=float>
class ITK_EXPORT GradientImageFilter :
public ImageToImageFilter< TInputImage,
Image<CovariantVector<TOutputValueType, ::itk::GetImageDimension<TInputImage>::ImageDimension>, ::itk::GetImageDimension<TInputImage>::ImageDimension> >
{
public:
/** Extract dimension from input image. */
itkStaticConstMacro(InputImageDimension, unsigned int,
TInputImage::ImageDimension);
itkStaticConstMacro(OutputImageDimension, unsigned int,
TInputImage::ImageDimension);
/** Standard class typedefs. */
typedef GradientImageFilter Self;
/** Convenient typedefs for simplifying declarations. */
typedef TInputImage InputImageType;
typedef typename InputImageType::Pointer InputImagePointer;
typedef Image<CovariantVector<TOutputValueType, itkGetStaticConstMacro(OutputImageDimension)>, itkGetStaticConstMacro(OutputImageDimension)> OutputImageType;
typedef typename OutputImageType::Pointer OutputImagePointer;
/** Standard class typedefs. */
typedef ImageToImageFilter< InputImageType, OutputImageType> Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(GradientImageFilter, ImageToImageFilter);
/** Image typedef support. */
typedef typename InputImageType::PixelType InputPixelType;
typedef TOperatorValueType OperatorValueType;
typedef TOutputValueType OutputValueType;
typedef CovariantVector<OutputValueType, itkGetStaticConstMacro(OutputImageDimension)> OutputPixelType;
typedef typename OutputImageType::RegionType OutputImageRegionType;
/** GradientImageFilter needs a larger input requested region than
* the output requested region. As such, GradientImageFilter needs
* to provide an implementation for GenerateInputRequestedRegion()
* in order to inform the pipeline execution model.
*
* \sa ImageToImageFilter::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() throw(InvalidRequestedRegionError);
/** Use the image spacing information in calculations. Use this option if you
* want derivatives in physical space. Default is UseImageSpacingOn. */
void SetUseImageSpacingOn()
{ this->SetUseImageSpacing(true); }
/** Ignore the image spacing. Use this option if you want derivatives in
isotropic pixel space. Default is UseImageSpacingOn. */
void SetUseImageSpacingOff()
{ this->SetUseImageSpacing(false); }
/** Set/Get whether or not the filter will use the spacing of the input
image in its calculations */
itkSetMacro(UseImageSpacing, bool);
itkGetMacro(UseImageSpacing, bool);
#ifdef ITK_USE_CONCEPT_CHECKING
/** Begin concept checking */
itkConceptMacro(InputConvertibleToOutputCheck,
(Concept::Convertible<InputPixelType, OutputValueType>));
itkConceptMacro(OutputHasNumericTraitsCheck,
(Concept::HasNumericTraits<OutputValueType>));
/** End concept checking */
#endif
/** The UseImageDirection flag determines whether image derivatives are
* computed with respect to the image grid or with respect to the physical
* space. When this flag is ON the derivatives are computed with respect to
* the coodinate system of physical space. The difference is whether we take
* into account the image Direction or not. The flag ON will take into
* account the image direction and will result in an extra matrix
* multiplication compared to the amount of computation performed when the
* flag is OFF. This flag is OFF by default.*/
itkSetMacro( UseImageDirection, bool );
itkGetMacro( UseImageDirection, bool );
itkBooleanMacro( UseImageDirection );
protected:
GradientImageFilter();
virtual ~GradientImageFilter();
void PrintSelf(std::ostream& os, Indent indent) const;
/** GradientImageFilter can be implemented as a multithreaded filter.
* Therefore, this implementation provides a ThreadedGenerateData()
* routine which is called for each processing thread. The output
* image data is allocated automatically by the superclass prior to
* calling ThreadedGenerateData(). ThreadedGenerateData can only
* write to the portion of the output image specified by the
* parameter "outputRegionForThread"
*
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
int threadId );
private:
GradientImageFilter(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
bool m_UseImageSpacing;
// flag to take or not the image direction into account
// when computing the derivatives.
bool m_UseImageDirection;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGradientImageFilter.txx"
#endif
#endif
|
