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
|
/*=========================================================================
Program: VMTK
Module: $RCSfile: itkUpwindGradientMagnitudeImageFilter.h,v $
Language: C++
Date: $Date: 2005/10/06 11:03:26 $
Version: $Revision: 1.2 $
Copyright (c) Luca Antiga, David Steinman. All rights reserved.
See LICENCE file for details.
Portions of this code are covered under the VTK copyright.
See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm
for details.
Portions of this code are covered under the ITK copyright.
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 __itkUpwindGradientMagnitudeImageFilter_h
#define __itkUpwindGradientMagnitudeImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkImage.h"
namespace itk
{
/** \class UpwindGradientMagnitudeImageFilter
* \brief Computes the gradient magnitude of an image region at each pixel.
*
*
* \ingroup GradientFilters
*
* \sa Image
* \sa Neighborhood
* \sa NeighborhoodOperator
* \sa NeighborhoodIterator
*/
template <typename TInputImage, typename TOutputImage>
class ITK_EXPORT UpwindGradientMagnitudeImageFilter :
public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
/** Standard class typedefs. */
typedef UpwindGradientMagnitudeImageFilter Self;
typedef ImageToImageFilter< TInputImage, TOutputImage > 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(UpwindGradientMagnitudeImageFilter, ImageToImageFilter);
/** Extract some information from the image types. Dimensionality
* of the two images is assumed to be the same. */
typedef typename TOutputImage::PixelType OutputPixelType;
typedef typename TInputImage::PixelType InputPixelType;
typedef typename NumericTraits<InputPixelType>::RealType RealType;
/** Extract some information from the image types. Dimensionality
* of the two images is assumed to be the same. */
itkStaticConstMacro(ImageDimension, unsigned int,
TOutputImage::ImageDimension);
/** Image typedef support */
typedef TInputImage InputImageType;
typedef TOutputImage OutputImageType;
typedef typename InputImageType::Pointer InputImagePointer;
typedef typename OutputImageType::Pointer OutputImagePointer;
/** Superclass typedefs. */
typedef typename Superclass::OutputImageRegionType OutputImageRegionType;
/** UpwindGradientMagnitudeImageFilter needs a larger input requested
* region than the output requested region (larger by the kernel
* size to calculate derivatives). As such,
* UpwindGradientMagnitudeImageFilter 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);
/** Set/Get the upwind factor: 1.0 full upwind, 0.0 centered
finite differences, -1.0 full downwind */
itkSetMacro(UpwindFactor, double);
itkGetMacro(UpwindFactor, double);
protected:
UpwindGradientMagnitudeImageFilter()
{
m_UseImageSpacing = true;
m_UpwindFactor = 1.0;
}
virtual ~UpwindGradientMagnitudeImageFilter() {}
/** UpwindGradientMagnitudeImageFilter 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 );
void PrintSelf(std::ostream&, Indent) const;
private:
UpwindGradientMagnitudeImageFilter(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
double m_UpwindFactor;
bool m_UseImageSpacing;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkUpwindGradientMagnitudeImageFilter.txx"
#endif
#endif
|
