forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkCurvatureFlowFunction.h
153 lines (125 loc) · 5.41 KB
/
itkCurvatureFlowFunction.h
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
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkCurvatureFlowFunction.h
Language: C++
Date: $Date$
Version: $Revision$
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 __itkCurvatureFlowFunction_h
#define __itkCurvatureFlowFunction_h
#include "itkFiniteDifferenceFunction.h"
#include "itkMacro.h"
namespace itk {
/** \class CurvatureFlowFunction
*
* \brief
* This class encapsulate the finite difference equation which drives a
* curvature flow denoising algorithm.
*
* This class uses a zero flux Neumann boundary condition when computing
* derivatives near the data boundary.
*
* This class operates as part of the finite difference solver hierarchy.
*
* \sa CurvatureFlowImageFilter
* \sa ZeroFluxNeumannBoundaryCondition
* \ingroup FiniteDifferenceFunctions
*/
template <class TImage>
class ITK_EXPORT CurvatureFlowFunction :
public FiniteDifferenceFunction<TImage>
{
public:
/** Standard class typedefs. */
typedef CurvatureFlowFunction Self;
typedef FiniteDifferenceFunction<TImage> 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( CurvatureFlowFunction,
FiniteDifferenceFunction );
/** Inherit some parameters from the superclass type. */
typedef typename Superclass::ImageType ImageType;
typedef typename Superclass::PixelType PixelType;
typedef typename Superclass::RadiusType RadiusType;
typedef PixelType ScalarValueType;
typedef typename Superclass::PixelRealType PixelRealType;
typedef typename Superclass::NeighborhoodType NeighborhoodType;
typedef typename Superclass::NeighborhoodScalesType NeighborhoodScalesType;
typedef typename Superclass::FloatOffsetType FloatOffsetType;
typedef typename Superclass::TimeStepType TimeStepType;
/** Extract superclass dimension. */
itkStaticConstMacro(ImageDimension, unsigned int,Superclass::ImageDimension);
/** Computes the time step for an update given a global data structure.
* The data used in the computation may take different forms depending on
* the nature of the equations. This global data cannot be kept in the
* instance of the equation object itself since the equation object must
* remain stateless for thread safety. The global data is therefore managed
* for each thread by the finite difference solver filters.
*
* Currently, this function returns the user specified constant time step.
* \todo compute timestep based on CFL condition.
*/
virtual TimeStepType ComputeGlobalTimeStep(void *GlobalData) const;
/** Returns a pointer to a global data structure that is passed to this
* object from the solver at each calculation. The idea is that the solver
* holds the state of any global values needed to calculate the time step,
* while the equation object performs the actual calculations. The global
* data should also be initialized in this method. */
virtual void *GetGlobalDataPointer() const
{
GlobalDataStruct *ans = new GlobalDataStruct();
ans->m_MaxChange = NumericTraits<ScalarValueType>::Zero;
return ans;
}
/** When the finite difference solver filter has finished using a global
* data pointer, it passes it to this method, which frees the memory.
* The solver cannot free the memory because it does not know the type
* to which the pointer points. */
virtual void ReleaseGlobalDataPointer(void *GlobalData) const
{ delete (GlobalDataStruct *) GlobalData; }
/** Set the time step parameter */
void SetTimeStep( const TimeStepType & t )
{ m_TimeStep = t; }
/** Get the time step parameter */
const TimeStepType &GetTimeStep() const
{ return m_TimeStep; }
/** This method computes the solution update for each pixel that does not
* lie on a the data set boundary. */
virtual PixelType ComputeUpdate(const NeighborhoodType &neighborhood,
void * globalData,
const FloatOffsetType& offset = FloatOffsetType(0.0)
);
protected:
/** A global data type for this class of equations. Used to store
* values that are needed in calculating the time step. */
/// @cond
struct GlobalDataStruct
{
GlobalDataStruct()
{
m_MaxChange = NumericTraits<ScalarValueType>::Zero;
}
~GlobalDataStruct() {}
ScalarValueType m_MaxChange;
};
/// @endcond
CurvatureFlowFunction();
~CurvatureFlowFunction() {}
private:
CurvatureFlowFunction(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
TimeStepType m_TimeStep;
};
}// end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCurvatureFlowFunction.txx"
#endif
#endif