ITK  5.3.0
Insight Toolkit
itkLevelSetEquationAdvectionTerm.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef itkLevelSetEquationAdvectionTerm_h
20 #define itkLevelSetEquationAdvectionTerm_h
21 
25 #include "itkVector.h"
26 #include "vnl/vnl_matrix_fixed.h"
27 
28 namespace itk
29 {
50 template <typename TInput, // Input image or mesh
51  typename TLevelSetContainer>
52 class ITK_TEMPLATE_EXPORT LevelSetEquationAdvectionTerm : public LevelSetEquationTermBase<TInput, TLevelSetContainer>
53 {
54 public:
55  ITK_DISALLOW_COPY_AND_MOVE(LevelSetEquationAdvectionTerm);
57 
62 
64  itkNewMacro(Self);
65 
68 
69  using typename Superclass::InputImageType;
70  using typename Superclass::InputImagePointer;
71  using typename Superclass::InputPixelType;
72  using typename Superclass::InputPixelRealType;
73 
74  using typename Superclass::LevelSetContainerType;
75  using typename Superclass::LevelSetContainerPointer;
76  using typename Superclass::LevelSetType;
77  using typename Superclass::LevelSetPointer;
78  using typename Superclass::LevelSetOutputPixelType;
79  using typename Superclass::LevelSetOutputRealType;
80  using typename Superclass::LevelSetInputIndexType;
81  using typename Superclass::LevelSetGradientType;
82  using typename Superclass::LevelSetHessianType;
83  using typename Superclass::LevelSetIdentifierType;
84  using typename Superclass::LevelSetDataType;
85 
86  using typename Superclass::HeavisideType;
87  using typename Superclass::HeavisideConstPointer;
88 
89  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
90 
92 
95 
96 
97  void
98  SetAdvectionImage(AdvectionImageType * iImage);
99  itkGetModifiableObjectMacro(AdvectionImage, AdvectionImageType);
100 
101  itkSetMacro(DerivativeSigma, LevelSetOutputRealType);
102  itkGetMacro(DerivativeSigma, LevelSetOutputRealType);
103 
108 
110 
112  void
113  Update() override;
114 
116  void
117  InitializeParameters() override;
118 
120  void
121  Initialize(const LevelSetInputIndexType &) override;
122 
124  void
125  UpdatePixel(const LevelSetInputIndexType & iP,
126  const LevelSetOutputRealType & oldValue,
127  const LevelSetOutputRealType & newValue) override;
128 
129 protected:
131 
132  ~LevelSetEquationAdvectionTerm() override = default;
133 
135 
138  VectorType
139  AdvectionSpeed(const LevelSetInputIndexType & iP) const;
140 
144  Value(const LevelSetInputIndexType & iP) override;
146  Value(const LevelSetInputIndexType & iP, const LevelSetDataType & iData) override;
148 
149  LevelSetOutputRealType m_NeighborhoodScales[ImageDimension];
150 
151 private:
153 
155 
156  void
157  GenerateAdvectionImage();
158 };
159 
160 } // namespace itk
161 
162 #ifndef ITK_MANUAL_INSTANTIATION
163 # include "itkLevelSetEquationAdvectionTerm.hxx"
164 #endif
165 
166 #endif
itk::LevelSetEquationAdvectionTerm::m_AdvectionImage
AdvectionImagePointer m_AdvectionImage
Definition: itkLevelSetEquationAdvectionTerm.h:134
itk::LevelSetEquationAdvectionTerm::m_AutoGenerateAdvectionImage
bool m_AutoGenerateAdvectionImage
Definition: itkLevelSetEquationAdvectionTerm.h:154
itkConstNeighborhoodIterator.h
itk::Size
Represent a n-dimensional size (bounds) of a n-dimensional image.
Definition: itkSize.h:69
itk::Vector
A templated class holding a n-Dimensional vector.
Definition: itkVector.h:62
itk::SmartPointer< Self >
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::LevelSetEquationAdvectionTerm::VectorType
LevelSetGradientType VectorType
Definition: itkLevelSetEquationAdvectionTerm.h:91
itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetInputIndexType
typename LevelSetContainerType::InputIndexType LevelSetInputIndexType
Definition: itkLevelSetEquationTermBase.h:76
itk::LevelSetEquationTermBase
Abstract class to represents a term in the level-set evolution PDE.
Definition: itkLevelSetEquationTermBase.h:49
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ConstNeighborhoodIterator
Const version of NeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pi...
Definition: itkConstNeighborhoodIterator.h:51
itk::LevelSetEquationAdvectionTerm::AdvectionImagePointer
typename AdvectionImageType::Pointer AdvectionImagePointer
Definition: itkLevelSetEquationAdvectionTerm.h:94
itkVector.h
itk::LevelSetEquationAdvectionTerm::m_DerivativeSigma
LevelSetOutputRealType m_DerivativeSigma
Definition: itkLevelSetEquationAdvectionTerm.h:152
itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetDataType
typename LevelSetContainerType::LevelSetDataType LevelSetDataType
Definition: itkLevelSetEquationTermBase.h:79
itk::LevelSetEquationAdvectionTerm::RadiusType
typename ConstNeighborhoodIterator< InputImageType >::RadiusType RadiusType
Definition: itkLevelSetEquationAdvectionTerm.h:106
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:88
itk::LevelSetEquationAdvectionTerm
Derived class to represents an advection term in the level-set evolution PDE.
Definition: itkLevelSetEquationAdvectionTerm.h:52
itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetGradientType
typename LevelSetContainerType::GradientType LevelSetGradientType
Definition: itkLevelSetEquationTermBase.h:77
itkLevelSetEquationTermBase.h
itk::ZeroFluxNeumannBoundaryCondition< InputImageType >
itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetOutputRealType
typename LevelSetContainerType::OutputRealType LevelSetOutputRealType
Definition: itkLevelSetEquationTermBase.h:75
itkZeroFluxNeumannBoundaryCondition.h