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
|
/*=========================================================================
*
* 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 itkLevelSetFunctionWithRefitTerm_h
#define itkLevelSetFunctionWithRefitTerm_h
#include "itkLevelSetFunction.h"
#include "itkSparseImage.h"
#include "itkNumericTraits.h"
namespace itk
{
/**
* \class LevelSetFunctionWithRefitTerm
*
* \brief This class extends the LevelSetFunction class by adding a grow term
* based on a target curvature stored in a sparse image.
*
* \par
* We extend the LevelSetFunction class to add a refitting term. This refitting
* term forces the curvature of the level set interface to match a prescribed
* curvature. The prescribed curvature is provided in a sparse image
* format. The NodeType for the sparse image should contain the member
* variables m_Curvature and m_CurvatureFlag. The refitting term is defined as
* part of the propagation term of the original LevelSetFunction. To this
* purpose we defined the PropagationSpeed method which computes the refitting
* term and also adds to this term the value returned by the new virtual
* OtherPropagationSpeed. Therefore, classes derived from this class MUST NOT
* overwrite the PropagationSpeed method. Instead classes wishing to define a
* propagation term must define OtherPropagationSpeed.
*
* \par IMPORTANT
* Subclasses MUST NOT overwrite the PropagationSpeed method. Define
* OtherPropagationSpeed instead.
* \ingroup ITKLevelSets
*/
template <typename TImageType, typename TSparseImageType>
class ITK_TEMPLATE_EXPORT LevelSetFunctionWithRefitTerm : public LevelSetFunction<TImageType>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(LevelSetFunctionWithRefitTerm);
/** Standard class type aliases. */
using Self = LevelSetFunctionWithRefitTerm;
using Superclass = LevelSetFunction<TImageType>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(LevelSetFunctionWithRefitTerm);
/** Standard New macro. */
itkNewMacro(Self);
/** Extract some parameters from the superclass. */
using typename Superclass::ImageType;
using typename Superclass::FloatOffsetType;
using typename Superclass::ScalarValueType;
using typename Superclass::GlobalDataStruct;
using typename Superclass::NeighborhoodType;
using typename Superclass::NeighborhoodScalesType;
using typename Superclass::TimeStepType;
using NeighborhoodSizeValueType = typename NeighborhoodType::SizeValueType;
/** Index type derived from the ImageType. */
using IndexType = typename ImageType::IndexType;
/** The sparse image type used for the curvature target. */
using SparseImageType = TSparseImageType;
/** The node type of the sparse image. */
using NodeType = typename SparseImageType::NodeType;
/** The type for the normal vectors of the level set image. */
using NormalVectorType = typename NodeType::NodeDataType;
/** Set the relative weight of the refitting term. */
void
SetRefitWeight(const ScalarValueType w)
{
m_RefitWeight = w;
}
/** This is the weight for propagation terms (other than refitting)
* that can be defined by subclasses. */
void
SetOtherPropagationWeight(const ScalarValueType w)
{
m_OtherPropagationWeight = w;
}
/** Sets the sparse image which has nodes containing the member variable
m_Curvature used in refitting. */
void
SetSparseTargetImage(SparseImageType * im)
{
m_SparseTargetImage = im;
}
/** Returns the sparse image. */
SparseImageType *
GetSparseTargetImage() const
{
return m_SparseTargetImage;
}
/** Computes the time step for an update given a global data structure.
* This calls the ComputeGlobalTimeStep method defined in LevelSetFunction
* and then imposes our own restrictions for the refitting term on the
* returned value. */
TimeStepType
ComputeGlobalTimeStep(void * GlobalData) const override;
protected:
/** The weight for the refitting term. */
ScalarValueType m_RefitWeight{};
/** The weight for other scalar propagation terms that can be defined by
classes derived from this class. */
ScalarValueType m_OtherPropagationWeight{};
LevelSetFunctionWithRefitTerm();
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Computes the curvature of a level set neighborhood in a way that matches
the curvature computation from normal vectors. */
ScalarValueType
ComputeCurvature(const NeighborhoodType &) const;
/** Defines the virtual function in LevelSetFunction to add the refitting
* term. This function also calls OtherPropagationSpeed to provide a
* mechanism for subclasses to define other propagation terms. */
ScalarValueType
PropagationSpeed(const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct * = 0) const override;
/** Called by PropagationSpeed and added on to the refitting term. Function
* classes derived from this class should define this method for their
* propagation speed, NOT the actual PropagationSpeed method. */
virtual ScalarValueType
OtherPropagationSpeed(const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct * = 0) const
{
return ScalarValueType{};
}
private:
/** The sparse image that contains the target curvature information. */
typename SparseImageType::Pointer m_SparseTargetImage{};
/** The minimum vector norm parameter. */
ScalarValueType m_MinVectorNorm{};
/** Constants used in computations. */
static const NeighborhoodSizeValueType m_NumVertex;
static const ScalarValueType m_DimConst;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkLevelSetFunctionWithRefitTerm.hxx"
#endif
#endif
|
