SimpleITK  
sitkFastMarchingUpwindGradientImageFilter.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 sitkFastMarchingUpwindGradientImageFilter_h
19 #define sitkFastMarchingUpwindGradientImageFilter_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 
52  public:
54 
57 
61 
64 \
65 
68  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( std::vector< std::vector<unsigned int> > TrialPoints ) { this->m_TrialPoints = std::move(TrialPoints); return *this; }
69 
72  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
74  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point)); return *this;}
76  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
77 \
78 
81  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfTargets ( unsigned int NumberOfTargets ) { this->m_NumberOfTargets = NumberOfTargets; return *this; }
82 
86  unsigned int GetNumberOfTargets() const { return this->m_NumberOfTargets; }\
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetTargetPoints ( std::vector< std::vector<unsigned int> > TargetPoints ) { this->m_TargetPoints = std::move(TargetPoints); return *this; }
92 
96  std::vector< std::vector< unsigned int > > GetTargetPoints() const { return this->m_TargetPoints; }
98  SITK_RETURN_SELF_TYPE_HEADER AddTargetPoint( std::vector< unsigned int > point ) { this->m_TargetPoints.push_back(std::move(point)); return *this;}
100  SITK_RETURN_SELF_TYPE_HEADER ClearTargetPoints( ) { this->m_TargetPoints.clear(); return *this;}
101 \
102 
106  SITK_RETURN_SELF_TYPE_HEADER SetTargetOffset ( double TargetOffset ) { this->m_TargetOffset = TargetOffset; return *this; }
107 
111  double GetTargetOffset() const { return this->m_TargetOffset; }\
112 
116  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
117 
121  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }\
122 
126  SITK_RETURN_SELF_TYPE_HEADER SetInitialTrialValues ( std::vector<double> InitialTrialValues ) { this->m_InitialTrialValues = InitialTrialValues; return *this; }
127 
130  std::vector<double> GetInitialTrialValues() const { return this->m_InitialTrialValues; }
137  Image GetGradientImage() const { return this->m_GradientImage; };
138 
145  double GetTargetValue() const { return this->m_TargetValue; };
146 
147 
149  std::string GetName() const { return std::string ("FastMarchingUpwindGradientImageFilter"); }
150 
152  std::string ToString() const;
153 
154 
157  Image Execute ( const Image& image1 );
158 
159  private:
160 
163  using MemberFunctionType = Image (Self::*)( const Image& image1 );
164  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
165 
166 
168 
169  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
170 
171 
172  std::vector< std::vector<unsigned int> > m_TrialPoints{std::vector< std::vector<unsigned int > >()};
173 
174  unsigned int m_NumberOfTargets{0u};
175 
176  std::vector< std::vector<unsigned int> > m_TargetPoints{std::vector< std::vector<unsigned int > >()};
177 
178  double m_TargetOffset{1.0};
179 
180  double m_NormalizationFactor{1.0};
181 
182  std::vector<double> m_InitialTrialValues{std::vector<double>()};
183 
184  /* Docs */
185  Image m_GradientImage{Image()};
186  /* Docs */
187  double m_TargetValue{0.0};
188 
189 
190  };
191 
202  SITKBasicFilters_EXPORT Image FastMarchingUpwindGradient ( const Image& image1, std::vector< std::vector<unsigned int> > trialPoints = std::vector< std::vector<unsigned int > >(), unsigned int numberOfTargets = 0u, std::vector< std::vector<unsigned int> > targetPoints = std::vector< std::vector<unsigned int > >(), double targetOffset = 1.0, double normalizationFactor = 1.0, std::vector<double> initialTrialValues = std::vector<double>() );
203 
205 }
206 #endif
itk::simple::FastMarchingUpwindGradientImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:149
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::FastMarchingUpwindGradientImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFastMarchingUpwindGradientImageFilter.h:163
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::FastMarchingUpwindGradientImageFilter::SetInitialTrialValues
Self & SetInitialTrialValues(std::vector< double > InitialTrialValues)
Set the initial seed values for corresponding trial point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:126
itk::simple::FastMarchingUpwindGradientImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:121
itk::simple::FastMarchingUpwindGradientImageFilter::GetInitialTrialValues
std::vector< double > GetInitialTrialValues() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:130
itk::simple::FastMarchingUpwindGradientImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:72
itk::simple::FastMarchingUpwindGradient
Image FastMarchingUpwindGradient(const Image &image1, std::vector< std::vector< unsigned int > > trialPoints=std::vector< std::vector< unsigned int > >(), unsigned int numberOfTargets=0u, std::vector< std::vector< unsigned int > > targetPoints=std::vector< std::vector< unsigned int > >(), double targetOffset=1.0, double normalizationFactor=1.0, std::vector< double > initialTrialValues=std::vector< double >())
Generates the upwind gradient field of fast marching arrival times.
sitkImageFilter.h
itk::simple::FastMarchingUpwindGradientImageFilter::SetNormalizationFactor
Self & SetNormalizationFactor(double NormalizationFactor)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:116
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetOffset
double GetTargetOffset() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:111
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetPoints
std::vector< std::vector< unsigned int > > GetTargetPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:96
itk::simple::FastMarchingUpwindGradientImageFilter::GetNumberOfTargets
unsigned int GetNumberOfTargets() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:86
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetOffset
Self & SetTargetOffset(double TargetOffset)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:106
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::FastMarchingUpwindGradientImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingUpwindGradientImageFilter.h:63
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:76
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FastMarchingUpwindGradientImageFilter::SetTrialPoints
Self & SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:68
itk::simple::FastMarchingUpwindGradientImageFilter::SetNumberOfTargets
Self & SetNumberOfTargets(unsigned int NumberOfTargets)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:81
itk::simple::FastMarchingUpwindGradientImageFilter::AddTargetPoint
Self & AddTargetPoint(std::vector< unsigned int > point)
Add TargetPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:98
itk::simple::FastMarchingUpwindGradientImageFilter
Generates the upwind gradient field of fast marching arrival times.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:51
itk::simple::FastMarchingUpwindGradientImageFilter::GetGradientImage
Image GetGradientImage() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:137
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTargetPoints
Self & ClearTargetPoints()
Remove all TargetPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:100
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::FastMarchingUpwindGradientImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingUpwindGradientImageFilter.h:169
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetPoints
Self & SetTargetPoints(std::vector< std::vector< unsigned int > > TargetPoints)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:91
itk::simple::FastMarchingUpwindGradientImageFilter::AddTrialPoint
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:74
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetValue
double GetTargetValue() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:145