ITK  6.0.0
Insight Toolkit
itkLevelSetEvolutionStoppingCriterion.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  * https://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 itkLevelSetEvolutionStoppingCriterion_h
20 #define itkLevelSetEvolutionStoppingCriterion_h
21 
23 #include "itkNumericTraits.h"
24 #include "itkIntTypes.h"
25 
26 namespace itk
27 {
32 template <typename TLevelSetContainer>
34 {
35 public:
36  ITK_DISALLOW_COPY_AND_MOVE(LevelSetEvolutionStoppingCriterion);
37 
42 
44  itkOverrideGetNameOfClassMacro(LevelSetEvolutionStoppingCriterion);
45 
46  using LevelSetContainerType = TLevelSetContainer;
48 
49  using LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType;
50 
51  using LevelSetType = typename LevelSetContainerType::LevelSetType;
52  using LevelSetPointer = typename LevelSetContainerType::LevelSetPointer;
53 
54  using InputIndexType = typename LevelSetContainerType::InputIndexType;
55  using OutputType = typename LevelSetContainerType::OutputType;
56  using OutputRealType = typename LevelSetContainerType::OutputRealType;
57  using GradientType = typename LevelSetContainerType::GradientType;
58  using HessianType = typename LevelSetContainerType::HessianType;
59 
60  using HeavisideType = typename LevelSetContainerType::HeavisideType;
61  using HeavisidePointer = typename LevelSetContainerType::HeavisideType;
62 
64 
65  itkSetObjectMacro(LevelSetContainer, LevelSetContainerType);
66  itkGetModifiableObjectMacro(LevelSetContainer, LevelSetContainerType);
67 
68  itkSetMacro(NumberOfIterations, IterationIdType);
69  itkGetMacro(NumberOfIterations, IterationIdType);
70 
71  itkSetMacro(CurrentIteration, IterationIdType);
72  itkGetMacro(CurrentIteration, IterationIdType);
73 
74  itkSetMacro(RMSChangeAccumulator, OutputRealType);
75  itkGetMacro(RMSChangeAccumulator, OutputRealType);
76 
77 protected:
80 
82  ~LevelSetEvolutionStoppingCriterion() override = default;
83 
84  LevelSetContainerPointer m_LevelSetContainer{};
85  OutputRealType m_RMSChangeAccumulator{};
86  IterationIdType m_NumberOfIterations{};
87  IterationIdType m_CurrentIteration{};
88 };
89 } // namespace itk
90 #ifndef ITK_MANUAL_INSTANTIATION
91 # include "itkLevelSetEvolutionStoppingCriterion.hxx"
92 #endif
93 #endif
Pointer
SmartPointer< Self > Pointer
Definition: itkAddImageFilter.h:93
itk::LevelSetEvolutionStoppingCriterion::IterationIdType
IdentifierType IterationIdType
Definition: itkLevelSetEvolutionStoppingCriterion.h:63
itk::LevelSetEvolutionStoppingCriterion::LevelSetIdentifierType
typename LevelSetContainerType::LevelSetIdentifierType LevelSetIdentifierType
Definition: itkLevelSetEvolutionStoppingCriterion.h:49
itk::LevelSetEvolutionStoppingCriterion::LevelSetContainerType
TLevelSetContainer LevelSetContainerType
Definition: itkLevelSetEvolutionStoppingCriterion.h:46
itk::LevelSetEvolutionStoppingCriterion::LevelSetContainerPointer
typename LevelSetContainerType::Pointer LevelSetContainerPointer
Definition: itkLevelSetEvolutionStoppingCriterion.h:47
itk::SmartPointer< Self >
itk::LevelSetEvolutionStoppingCriterion::HeavisidePointer
typename LevelSetContainerType::HeavisideType HeavisidePointer
Definition: itkLevelSetEvolutionStoppingCriterion.h:61
itkStoppingCriterionBase.h
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itk::LevelSetEvolutionStoppingCriterion::LevelSetPointer
typename LevelSetContainerType::LevelSetPointer LevelSetPointer
Definition: itkLevelSetEvolutionStoppingCriterion.h:52
itk::LevelSetEvolutionStoppingCriterion::InputIndexType
typename LevelSetContainerType::InputIndexType InputIndexType
Definition: itkLevelSetEvolutionStoppingCriterion.h:54
itkIntTypes.h
itk::LevelSetEvolutionStoppingCriterion::OutputRealType
typename LevelSetContainerType::OutputRealType OutputRealType
Definition: itkLevelSetEvolutionStoppingCriterion.h:56
itk::LevelSetEvolutionStoppingCriterion::LevelSetType
typename LevelSetContainerType::LevelSetType LevelSetType
Definition: itkLevelSetEvolutionStoppingCriterion.h:51
itk::LevelSetContainer
Container of Level-Sets.
Definition: itkLevelSetContainer.h:39
itk::LevelSetEvolutionStoppingCriterion::HeavisideType
typename LevelSetContainerType::HeavisideType HeavisideType
Definition: itkLevelSetEvolutionStoppingCriterion.h:60
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::LevelSetEvolutionStoppingCriterion::GradientType
typename LevelSetContainerType::GradientType GradientType
Definition: itkLevelSetEvolutionStoppingCriterion.h:57
itk::StoppingCriterionBase
An abstract base class to represent a stopping criterion for an iterative algorithm.
Definition: itkStoppingCriterionBase.h:38
itkNumericTraits.h
itk::LevelSetEvolutionStoppingCriterion::HessianType
typename LevelSetContainerType::HessianType HessianType
Definition: itkLevelSetEvolutionStoppingCriterion.h:58
itk::LevelSetEvolutionStoppingCriterion
Definition: itkLevelSetEvolutionStoppingCriterion.h:33
itk::IdentifierType
SizeValueType IdentifierType
Definition: itkIntTypes.h:90
itk::LevelSetEvolutionStoppingCriterion::OutputType
typename LevelSetContainerType::OutputType OutputType
Definition: itkLevelSetEvolutionStoppingCriterion.h:55