SimpleITK  
sitkFastMarchingImageFilter.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 sitkFastMarchingImageFilter_h
19 #define sitkFastMarchingImageFilter_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::simple {
33 
69  public:
71 
73  virtual ~FastMarchingImageFilter();
74 
78 
81 \
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( std::vector< std::vector<unsigned int> > TrialPoints ) { this->m_TrialPoints = std::move(TrialPoints); return *this; }
87 
91  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
93  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point)); return *this;}
95  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
96 \
97 
101  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
102 
106  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }\
107 
111  SITK_RETURN_SELF_TYPE_HEADER SetStoppingValue ( double StoppingValue ) { this->m_StoppingValue = StoppingValue; return *this; }
112 
116  double GetStoppingValue() const { return this->m_StoppingValue; }\
117 
121  SITK_RETURN_SELF_TYPE_HEADER SetInitialTrialValues ( std::vector<double> InitialTrialValues ) { this->m_InitialTrialValues = InitialTrialValues; return *this; }
122 
125  std::vector<double> GetInitialTrialValues() const { return this->m_InitialTrialValues; }
126 
128  std::string GetName() const { return std::string ("FastMarchingImageFilter"); }
129 
131  std::string ToString() const;
132 
133 
136  Image Execute ( const Image& image1 );
137 
138  private:
139 
142  using MemberFunctionType = Image (Self::*)( const Image& image1 );
143  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
144 
145 
147 
148  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
149 
150 
151  std::vector< std::vector<unsigned int> > m_TrialPoints{std::vector< std::vector<unsigned int > >()};
152 
153  double m_NormalizationFactor{1.0};
154 
155  double m_StoppingValue{std::numeric_limits<double>::max()/2.0};
156 
157  std::vector<double> m_InitialTrialValues{std::vector<double>()};
158 
159 
160  };
161 
172  SITKBasicFilters_EXPORT Image FastMarching ( const Image& image1, std::vector< std::vector<unsigned int> > trialPoints = std::vector< std::vector<unsigned int > >(), double normalizationFactor = 1.0, double stoppingValue = std::numeric_limits<double>::max()/2.0, std::vector<double> initialTrialValues = std::vector<double>() );
173 
175 }
176 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::FastMarchingImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingImageFilter.h:80
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::FastMarchingImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingImageFilter.h:91
sitkImageFilter.h
itk::simple::FastMarching
Image FastMarching(const Image &image1, std::vector< std::vector< unsigned int > > trialPoints=std::vector< std::vector< unsigned int > >(), double normalizationFactor=1.0, double stoppingValue=std::numeric_limits< double >::max()/2.0, std::vector< double > initialTrialValues=std::vector< double >())
Solve an Eikonal equation using Fast Marching.
itk::simple::FastMarchingImageFilter
Solve an Eikonal equation using Fast Marching.
Definition: sitkFastMarchingImageFilter.h:68
itk::simple::FastMarchingImageFilter::AddTrialPoint
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Definition: sitkFastMarchingImageFilter.h:93
itk::simple::FastMarchingImageFilter::SetTrialPoints
Self & SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
Definition: sitkFastMarchingImageFilter.h:86
itk::simple::FastMarchingImageFilter::GetInitialTrialValues
std::vector< double > GetInitialTrialValues() const
Definition: sitkFastMarchingImageFilter.h:125
itk::simple::FastMarchingImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFastMarchingImageFilter.h:142
itk::simple::FastMarchingImageFilter::GetStoppingValue
double GetStoppingValue() const
Definition: sitkFastMarchingImageFilter.h:116
itk::point
*par Constraints *The filter requires an image with at least two dimensions and a vector *length of at least The theory supports extension to scalar but *the implementation of the itk vector classes do not **The template parameter TRealType must be floating point(float or double) or *a user-defined "real" numerical type with arithmetic operations defined *sufficient to compute derivatives. **\par Performance *This filter will automatically multithread if run with *SetUsePrincipleComponents
itk::simple::FastMarchingImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingImageFilter.h:128
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FastMarchingImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingImageFilter.h:95
itk::simple::FastMarchingImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingImageFilter.h:148
itk::simple::FastMarchingImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingImageFilter.h:106
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::FastMarchingImageFilter::SetInitialTrialValues
Self & SetInitialTrialValues(std::vector< double > InitialTrialValues)
Set the initial seed values for corresponding trial points.
Definition: sitkFastMarchingImageFilter.h:121
itk::simple::FastMarchingImageFilter::SetStoppingValue
Self & SetStoppingValue(double StoppingValue)
Definition: sitkFastMarchingImageFilter.h:111
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::FastMarchingImageFilter::SetNormalizationFactor
Self & SetNormalizationFactor(double NormalizationFactor)
Definition: sitkFastMarchingImageFilter.h:101