SimpleITK  2.0.0rc2.post17
sitkInvertDisplacementFieldImageFilter.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 #ifndef sitkInvertDisplacementFieldImageFilter_h
19 #define sitkInvertDisplacementFieldImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk {
33  namespace simple {
34 
46  public:
48 
51 
55 
58 \
59 
62  SITK_RETURN_SELF_TYPE_HEADER SetMaximumNumberOfIterations ( uint32_t MaximumNumberOfIterations ) { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; return *this; }
63 
66  uint32_t GetMaximumNumberOfIterations() const { return this->m_MaximumNumberOfIterations; }\
67 
70  SITK_RETURN_SELF_TYPE_HEADER SetMaxErrorToleranceThreshold ( double MaxErrorToleranceThreshold ) { this->m_MaxErrorToleranceThreshold = MaxErrorToleranceThreshold; return *this; }
71 
74  double GetMaxErrorToleranceThreshold() const { return this->m_MaxErrorToleranceThreshold; }\
75 
78  SITK_RETURN_SELF_TYPE_HEADER SetMeanErrorToleranceThreshold ( double MeanErrorToleranceThreshold ) { this->m_MeanErrorToleranceThreshold = MeanErrorToleranceThreshold; return *this; }
79 
82  double GetMeanErrorToleranceThreshold() const { return this->m_MeanErrorToleranceThreshold; }\
83 
86  SITK_RETURN_SELF_TYPE_HEADER SetEnforceBoundaryCondition ( bool EnforceBoundaryCondition ) { this->m_EnforceBoundaryCondition = EnforceBoundaryCondition; return *this; }
87 
89  SITK_RETURN_SELF_TYPE_HEADER EnforceBoundaryConditionOn() { return this->SetEnforceBoundaryCondition(true); }
90  SITK_RETURN_SELF_TYPE_HEADER EnforceBoundaryConditionOff() { return this->SetEnforceBoundaryCondition(false); }
91 
94  bool GetEnforceBoundaryCondition() const { return this->m_EnforceBoundaryCondition; }
101  double GetMaxErrorNorm() const { return this->m_MaxErrorNorm; };
102 
109  double GetMeanErrorNorm() const { return this->m_MeanErrorNorm; };
110 
111 
113  std::string GetName() const { return std::string ("InvertDisplacementFieldImageFilter"); }
114 
116  std::string ToString() const;
117 
118 
121  Image Execute ( const Image& image1 );
122 
123  private:
124 
127  using MemberFunctionType = Image (Self::*)( const Image& image1 );
128  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
129 
130 
132 
133  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
134 
135 
136  /* Number of iterations to run */
137  uint32_t m_MaximumNumberOfIterations{10u};
138 
139  double m_MaxErrorToleranceThreshold{0.1};
140 
141  double m_MeanErrorToleranceThreshold{0.001};
142 
143  bool m_EnforceBoundaryCondition{true};
144 
145 
146  double m_MaxErrorNorm{0.0};
147 
148  double m_MeanErrorNorm{0.0};
149 
150 
151  };
152 
163  SITKBasicFilters_EXPORT Image InvertDisplacementField ( const Image& image1, uint32_t maximumNumberOfIterations = 10u, double maxErrorToleranceThreshold = 0.1, double meanErrorToleranceThreshold = 0.001, bool enforceBoundaryCondition = true );
164 
166  }
167 }
168 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::InvertDisplacementFieldImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkInvertDisplacementFieldImageFilter.h:127
sitkBasicFilters.h
itk::simple::InvertDisplacementFieldImageFilter::GetName
std::string GetName() const
Definition: sitkInvertDisplacementFieldImageFilter.h:113
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::InvertDisplacementFieldImageFilter::GetMeanErrorToleranceThreshold
double GetMeanErrorToleranceThreshold() const
Definition: sitkInvertDisplacementFieldImageFilter.h:82
sitkImageFilter.h
itk::simple::InvertDisplacementFieldImageFilter::SetMaximumNumberOfIterations
Self & SetMaximumNumberOfIterations(uint32_t MaximumNumberOfIterations)
Definition: sitkInvertDisplacementFieldImageFilter.h:62
itk::simple::InvertDisplacementFieldImageFilter::EnforceBoundaryConditionOn
Self & EnforceBoundaryConditionOn()
Definition: sitkInvertDisplacementFieldImageFilter.h:89
itk::simple::InvertDisplacementFieldImageFilter::GetEnforceBoundaryCondition
bool GetEnforceBoundaryCondition() const
Definition: sitkInvertDisplacementFieldImageFilter.h:94
itk::simple::InvertDisplacementFieldImageFilter::PixelIDTypeList
RealVectorPixelIDTypeList PixelIDTypeList
Definition: sitkInvertDisplacementFieldImageFilter.h:57
itk::simple::InvertDisplacementField
Image InvertDisplacementField(const Image &image1, uint32_t maximumNumberOfIterations=10u, double maxErrorToleranceThreshold=0.1, double meanErrorToleranceThreshold=0.001, bool enforceBoundaryCondition=true)
Iteratively estimate the inverse field of a displacement field.
itk::simple::InvertDisplacementFieldImageFilter
Iteratively estimate the inverse field of a displacement field.
Definition: sitkInvertDisplacementFieldImageFilter.h:45
itk::simple::InvertDisplacementFieldImageFilter::SetEnforceBoundaryCondition
Self & SetEnforceBoundaryCondition(bool EnforceBoundaryCondition)
Definition: sitkInvertDisplacementFieldImageFilter.h:86
itk::simple::InvertDisplacementFieldImageFilter::GetMaxErrorNorm
double GetMaxErrorNorm() const
Definition: sitkInvertDisplacementFieldImageFilter.h:101
itk::simple::InvertDisplacementFieldImageFilter::GetMeanErrorNorm
double GetMeanErrorNorm() const
Definition: sitkInvertDisplacementFieldImageFilter.h:109
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::InvertDisplacementFieldImageFilter::GetMaxErrorToleranceThreshold
double GetMaxErrorToleranceThreshold() const
Definition: sitkInvertDisplacementFieldImageFilter.h:74
itk::simple::InvertDisplacementFieldImageFilter::SetMaxErrorToleranceThreshold
Self & SetMaxErrorToleranceThreshold(double MaxErrorToleranceThreshold)
Definition: sitkInvertDisplacementFieldImageFilter.h:70
itk
itk::simple::InvertDisplacementFieldImageFilter::SetMeanErrorToleranceThreshold
Self & SetMeanErrorToleranceThreshold(double MeanErrorToleranceThreshold)
Definition: sitkInvertDisplacementFieldImageFilter.h:78
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::InvertDisplacementFieldImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkInvertDisplacementFieldImageFilter.h:133
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::RealVectorPixelIDTypeList
typelist::MakeTypeList< VectorPixelID< float >, VectorPixelID< double > >::Type RealVectorPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:142
itk::simple::InvertDisplacementFieldImageFilter::GetMaximumNumberOfIterations
uint32_t GetMaximumNumberOfIterations() const
Definition: sitkInvertDisplacementFieldImageFilter.h:66
itk::simple::InvertDisplacementFieldImageFilter::EnforceBoundaryConditionOff
Self & EnforceBoundaryConditionOff()
Definition: sitkInvertDisplacementFieldImageFilter.h:90