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
32namespace itk::simple {
33
92 public:
94
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
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
168
169 Image Execute ( const Image& image1 );
170
171 private:
172
174
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
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
207
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
Self & SetTopologyCheck(TopologyCheckType TopologyCheck)
Self & SetInitialTrialValues(std::vector< double > InitialTrialValues)
Set the initial seed values for corresponding trial point.
Image ExecuteInternal(const Image &image1)
Self & SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
Image(Self::*)(const Image &image1) MemberFunctionType
Image Execute(const Image &image1)
Self & ClearTrialPoints()
Remove all TrialPoints points.
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Self & SetNormalizationFactor(double NormalizationFactor)
std::vector< std::vector< unsigned int > > GetTrialPoints() const
std::vector< std::vector< unsigned int > > m_TrialPoints
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The Image class for SimpleITK.
Definition sitkImage.h:77
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
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.
*par Constraints *The filter 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
#define SITKBasicFilters_EXPORT