SimpleITK  2.0.0
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 {
33  namespace simple {
34 
53  public:
55 
58 
62 
65 \
66 
69  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( std::vector< std::vector<unsigned int> > TrialPoints ) { this->m_TrialPoints = std::move(TrialPoints); return *this; }
70 
73  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
75  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point)); return *this;}
77  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
78 \
79 
82  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfTargets ( unsigned int NumberOfTargets ) { this->m_NumberOfTargets = NumberOfTargets; return *this; }
83 
87  unsigned int GetNumberOfTargets() const { return this->m_NumberOfTargets; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetTargetPoints ( std::vector< std::vector<unsigned int> > TargetPoints ) { this->m_TargetPoints = std::move(TargetPoints); return *this; }
93 
97  std::vector< std::vector< unsigned int > > GetTargetPoints() const { return this->m_TargetPoints; }
99  SITK_RETURN_SELF_TYPE_HEADER AddTargetPoint( std::vector< unsigned int > point ) { this->m_TargetPoints.push_back(std::move(point)); return *this;}
101  SITK_RETURN_SELF_TYPE_HEADER ClearTargetPoints( ) { this->m_TargetPoints.clear(); return *this;}
102 \
103 
107  SITK_RETURN_SELF_TYPE_HEADER SetTargetOffset ( double TargetOffset ) { this->m_TargetOffset = TargetOffset; return *this; }
108 
112  double GetTargetOffset() const { return this->m_TargetOffset; }\
113 
117  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
118 
122  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }
129  Image GetGradientImage() const { return this->m_GradientImage; };
130 
137  double GetTargetValue() const { return this->m_TargetValue; };
138 
139 
141  std::string GetName() const { return std::string ("FastMarchingUpwindGradientImageFilter"); }
142 
144  std::string ToString() const;
145 
146 
149  Image Execute ( const Image& image1 );
150 
151  private:
152 
155  using MemberFunctionType = Image (Self::*)( const Image& image1 );
156  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
157 
158 
160 
161  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
162 
163 
164  std::vector< std::vector<unsigned int> > m_TrialPoints{std::vector< std::vector<unsigned int > >()};
165 
166  unsigned int m_NumberOfTargets{0u};
167 
168  std::vector< std::vector<unsigned int> > m_TargetPoints{std::vector< std::vector<unsigned int > >()};
169 
170  double m_TargetOffset{1.0};
171 
172  double m_NormalizationFactor{1.0};
173 
174  /* Docs */
175  Image m_GradientImage{Image()};
176  /* Docs */
177  double m_TargetValue{0.0};
178 
179 
180  };
181 
192  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 );
193 
195  }
196 }
197 #endif
itk::simple::FastMarchingUpwindGradientImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:141
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::FastMarchingUpwindGradientImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFastMarchingUpwindGradientImageFilter.h:155
itk::simple::FastMarchingUpwindGradientImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:122
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)
Generates the upwind gradient field of fast marching arrival times.
itk::simple::FastMarchingUpwindGradientImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:73
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::FastMarchingUpwindGradientImageFilter::SetNormalizationFactor
Self & SetNormalizationFactor(double NormalizationFactor)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:117
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetOffset
double GetTargetOffset() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:112
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetPoints
std::vector< std::vector< unsigned int > > GetTargetPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:97
itk::simple::FastMarchingUpwindGradientImageFilter::GetNumberOfTargets
unsigned int GetNumberOfTargets() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:87
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetOffset
Self & SetTargetOffset(double TargetOffset)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:107
itk::simple::FastMarchingUpwindGradientImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingUpwindGradientImageFilter.h:64
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:77
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:69
itk::simple::FastMarchingUpwindGradientImageFilter::SetNumberOfTargets
Self & SetNumberOfTargets(unsigned int NumberOfTargets)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:82
itk::simple::FastMarchingUpwindGradientImageFilter::AddTargetPoint
Self & AddTargetPoint(std::vector< unsigned int > point)
Add TargetPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:99
itk::simple::FastMarchingUpwindGradientImageFilter
Generates the upwind gradient field of fast marching arrival times.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:52
itk::simple::FastMarchingUpwindGradientImageFilter::GetGradientImage
Image GetGradientImage() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:129
itk
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTargetPoints
Self & ClearTargetPoints()
Remove all TargetPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:101
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::FastMarchingUpwindGradientImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingUpwindGradientImageFilter.h:161
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetPoints
Self & SetTargetPoints(std::vector< std::vector< unsigned int > > TargetPoints)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:92
itk::simple::FastMarchingUpwindGradientImageFilter::AddTrialPoint
Self & AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:75
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetValue
double GetTargetValue() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:137