SimpleITK  2.0.0
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 {
33  namespace simple {
34 
93  public:
95 
97  virtual ~FastMarchingBaseImageFilter();
98 
102 
105 \
106 
110  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( std::vector< std::vector<unsigned int> > TrialPoints ) { this->m_TrialPoints = std::move(TrialPoints); return *this; }
111 
115  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
117  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point)); return *this;}
119  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
120 \
121 
125  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
126 
130  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }\
131 
135  SITK_RETURN_SELF_TYPE_HEADER SetStoppingValue ( double StoppingValue ) { this->m_StoppingValue = StoppingValue; return *this; }
136 
140  double GetStoppingValue() const { return this->m_StoppingValue; }
141 
142  typedef enum {Nothing,NoHandles,Strict} TopologyCheckType;\
143 
146  SITK_RETURN_SELF_TYPE_HEADER SetTopologyCheck ( TopologyCheckType TopologyCheck ) { this->m_TopologyCheck = TopologyCheck; return *this; }
147 
150  TopologyCheckType GetTopologyCheck() const { return this->m_TopologyCheck; }
151 
153  std::string GetName() const { return std::string ("FastMarchingBaseImageFilter"); }
154 
156  std::string ToString() const;
157 
158 
161  Image Execute ( const Image& image1 );
162 
163  private:
164 
167  using MemberFunctionType = Image (Self::*)( const Image& image1 );
168  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
169 
170 
172 
173  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
174 
175 
176  std::vector< std::vector<unsigned int> > m_TrialPoints{std::vector< std::vector<unsigned int > >()};
177 
178  double m_NormalizationFactor{1.0};
179 
180  double m_StoppingValue{std::numeric_limits<float>::max()/2.0};
181 
182  /* */
184 
185 
186  };
187 
198  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 );
199 
201  }
202 }
203 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::FastMarchingBaseImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingBaseImageFilter.h:130
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
TopologyCheck
itk::simple::FastMarchingBaseImageFilter::SetNormalizationFactor
Self & SetNormalizationFactor(double NormalizationFactor)
Definition: sitkFastMarchingBaseImageFilter.h:125
itk::simple::FastMarchingBaseImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingBaseImageFilter.h:119
itk::simple::FastMarchingBaseImageFilter::TopologyCheckType
TopologyCheckType
Definition: sitkFastMarchingBaseImageFilter.h:142
itk::simple::FastMarchingBaseImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingBaseImageFilter.h:153
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::FastMarchingBaseImageFilter::GetTopologyCheck
TopologyCheckType GetTopologyCheck() const
Definition: sitkFastMarchingBaseImageFilter.h:150
itk::simple::FastMarchingBaseImageFilter
Apply the Fast Marching method to solve an Eikonal equation on an image.
Definition: sitkFastMarchingBaseImageFilter.h:92
itk::simple::FastMarchingBaseImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingBaseImageFilter.h:115
itk::simple::FastMarchingBaseImageFilter::SetStoppingValue
Self & SetStoppingValue(double StoppingValue)
Definition: sitkFastMarchingBaseImageFilter.h:135
itk::simple::FastMarchingBaseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingBaseImageFilter.h:104
itk::simple::FastMarchingBaseImageFilter::SetTopologyCheck
Self & SetTopologyCheck(TopologyCheckType TopologyCheck)
Definition: sitkFastMarchingBaseImageFilter.h:146
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)
Apply the Fast Marching method to solve an Eikonal equation on an image.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FastMarchingBaseImageFilter::GetStoppingValue
double GetStoppingValue() const
Definition: sitkFastMarchingBaseImageFilter.h:140
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::FastMarchingBaseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingBaseImageFilter.h:173
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::FastMarchingBaseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFastMarchingBaseImageFilter.h:167
itk::simple::FastMarchingBaseImageFilter::SetTrialPoints
Self & SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
Definition: sitkFastMarchingBaseImageFilter.h:110
itk::simple::FastMarchingBaseImageFilter::AddTrialPoint
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Definition: sitkFastMarchingBaseImageFilter.h:117
itk::simple::FastMarchingBaseImageFilter::Nothing
@ Nothing
Definition: sitkFastMarchingBaseImageFilter.h:142