SimpleITK  1.0.1
sitkInvertDisplacementFieldImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
45  public:
47 
51 
54 
57 
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 
112  std::string GetName() const { return std::string ("InvertDisplacementFieldImageFilter"); }
113 
115  std::string ToString() const;
116 
117 
119  Image Execute ( const Image& image1 );
120 
121 
123  Image Execute ( const Image& image1, uint32_t maximumNumberOfIterations, double maxErrorToleranceThreshold, double meanErrorToleranceThreshold, bool enforceBoundaryCondition );
124 
125 
126  private:
127 
130  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
131  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
132 
133 
134 
135  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
136 
137  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
138 
139 
140  /* Number of iterations to run */
145 
147 
149 
150  };
151 
152 
153 
162  SITKBasicFilters_EXPORT Image InvertDisplacementField ( const Image& image1, uint32_t maximumNumberOfIterations = 10u, double maxErrorToleranceThreshold = 0.1, double meanErrorToleranceThreshold = 0.001, bool enforceBoundaryCondition = true );
163 
164  }
165 }
166 #endif
#define SITKBasicFilters_EXPORT
Self & SetMaxErrorToleranceThreshold(double MaxErrorToleranceThreshold)
Self & SetMaximumNumberOfIterations(uint32_t MaximumNumberOfIterations)
Self & SetMeanErrorToleranceThreshold(double MeanErrorToleranceThreshold)
::uint32_t uint32_t
The main Image class for SimpleITK.
Definition: sitkImage.h:54
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.
Iteratively estimate the inverse field of a displacement field.
typelist::MakeTypeList< VectorPixelID< float >, VectorPixelID< double > >::Type RealVectorPixelIDTypeList
The base interface for SimpleITK filters that take one input image.
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory