SimpleITK  
sitkFastMarchingBaseImageFilter.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 sitkFastMarchingBaseImageFilter_h
19 #define sitkFastMarchingBaseImageFilter_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 
92  public:
94 
96  virtual ~FastMarchingBaseImageFilter();
97 
101 
104 \
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( std::vector< std::vector<unsigned int> > TrialPoints ) { this->m_TrialPoints = std::move(TrialPoints); return *this; }
110 
114  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
116  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point)); return *this;}
118  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
119 \
120 
124  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
125 
129  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }\
130 
134  SITK_RETURN_SELF_TYPE_HEADER SetStoppingValue ( double StoppingValue ) { this->m_StoppingValue = StoppingValue; return *this; }
135 
139  double GetStoppingValue() const { return this->m_StoppingValue; }
140 
141  typedef enum {Nothing,NoHandles,Strict} TopologyCheckType;\
142 
145  SITK_RETURN_SELF_TYPE_HEADER SetTopologyCheck ( TopologyCheckType TopologyCheck ) { this->m_TopologyCheck = TopologyCheck; return *this; }
146 
149  TopologyCheckType GetTopologyCheck() const { return this->m_TopologyCheck; }\
150 
154  SITK_RETURN_SELF_TYPE_HEADER SetInitialTrialValues ( std::vector<double> InitialTrialValues ) { this->m_InitialTrialValues = InitialTrialValues; return *this; }
155 
158  std::vector<double> GetInitialTrialValues() const { return this->m_InitialTrialValues; }
159 
161  std::string GetName() const { return std::string ("FastMarchingBaseImageFilter"); }
162 
164  std::string ToString() const;
165 
166 
169  Image Execute ( const Image& image1 );
170 
171  private:
172 
175  using MemberFunctionType = Image (Self::*)( const Image& image1 );
176  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
177 
178 
180 
181  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
182 
183 
184  std::vector< std::vector<unsigned int> > m_TrialPoints{std::vector< std::vector<unsigned int > >()};
185 
186  double m_NormalizationFactor{1.0};
187 
188  double m_StoppingValue{std::numeric_limits<float>::max()/2.0};
189 
190  /* */
192 
193  std::vector<double> m_InitialTrialValues{std::vector<double>()};
194 
195 
196  };
197 
208  SITKBasicFilters_EXPORT Image FastMarchingBase ( 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<float>::max()/2.0, FastMarchingBaseImageFilter::TopologyCheckType topologyCheck = itk::simple::FastMarchingBaseImageFilter::Nothing, std::vector<double> initialTrialValues = std::vector<double>() );
209 
211 }
212 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::FastMarchingBaseImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingBaseImageFilter.h:129
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
TopologyCheck
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::FastMarchingBaseImageFilter::GetInitialTrialValues
std::vector< double > GetInitialTrialValues() const
Definition: sitkFastMarchingBaseImageFilter.h:158
itk::simple::FastMarchingBaseImageFilter::SetNormalizationFactor
Self & SetNormalizationFactor(double NormalizationFactor)
Definition: sitkFastMarchingBaseImageFilter.h:124
itk::simple::FastMarchingBaseImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingBaseImageFilter.h:118
itk::simple::FastMarchingBaseImageFilter::TopologyCheckType
TopologyCheckType
Definition: sitkFastMarchingBaseImageFilter.h:141
itk::simple::FastMarchingBaseImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingBaseImageFilter.h:161
sitkImageFilter.h
itk::simple::FastMarchingBaseImageFilter::GetTopologyCheck
TopologyCheckType GetTopologyCheck() const
Definition: sitkFastMarchingBaseImageFilter.h:149
itk::simple::FastMarchingBaseImageFilter
Apply the Fast Marching method to solve an Eikonal equation on an image.
Definition: sitkFastMarchingBaseImageFilter.h:91
itk::simple::FastMarchingBaseImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingBaseImageFilter.h:114
itk::simple::FastMarchingBaseImageFilter::SetStoppingValue
Self & SetStoppingValue(double StoppingValue)
Definition: sitkFastMarchingBaseImageFilter.h:134
itk::simple::FastMarchingBaseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingBaseImageFilter.h:103
itk::simple::FastMarchingBaseImageFilter::SetTopologyCheck
Self & SetTopologyCheck(TopologyCheckType TopologyCheck)
Definition: sitkFastMarchingBaseImageFilter.h:145
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::FastMarchingBaseImageFilter::SetInitialTrialValues
Self & SetInitialTrialValues(std::vector< double > InitialTrialValues)
Set the initial seed values for corresponding trial point.
Definition: sitkFastMarchingBaseImageFilter.h:154
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FastMarchingBaseImageFilter::GetStoppingValue
double GetStoppingValue() const
Definition: sitkFastMarchingBaseImageFilter.h:139
itk::simple::FastMarchingBase
Image FastMarchingBase(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< float >::max()/2.0, FastMarchingBaseImageFilter::TopologyCheckType topologyCheck=itk::simple::FastMarchingBaseImageFilter::Nothing, std::vector< double > initialTrialValues=std::vector< double >())
Apply the Fast Marching method to solve an Eikonal equation on an image.
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::FastMarchingBaseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingBaseImageFilter.h:181
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::FastMarchingBaseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFastMarchingBaseImageFilter.h:175
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::FastMarchingBaseImageFilter::SetTrialPoints
Self & SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
Definition: sitkFastMarchingBaseImageFilter.h:109
itk::simple::FastMarchingBaseImageFilter::AddTrialPoint
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Definition: sitkFastMarchingBaseImageFilter.h:116
itk::simple::FastMarchingBaseImageFilter::Nothing
@ Nothing
Definition: sitkFastMarchingBaseImageFilter.h:141