SimpleITK  1.1.0
sitkFastMarchingUpwindGradientImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
67 
70  SITK_RETURN_SELF_TYPE_HEADER SetTrialPoints ( const std::vector< std::vector<unsigned int> >& TrialPoints ) { this->m_TrialPoints = TrialPoints; return *this; }
71 
74  std::vector< std::vector< unsigned int > > GetTrialPoints() const { return this->m_TrialPoints; }
76  SITK_RETURN_SELF_TYPE_HEADER AddTrialPoint( const std::vector< unsigned int > &point ) { this->m_TrialPoints.push_back(point); return *this;}
78  SITK_RETURN_SELF_TYPE_HEADER ClearTrialPoints( ) { this->m_TrialPoints.clear(); return *this;}
79 
80 
83  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfTargets ( unsigned int NumberOfTargets ) { this->m_NumberOfTargets = NumberOfTargets; return *this; }
84 
88  unsigned int GetNumberOfTargets() const { return this->m_NumberOfTargets; }
89 
93  SITK_RETURN_SELF_TYPE_HEADER SetTargetPoints ( const std::vector< std::vector<unsigned int> >& TargetPoints ) { this->m_TargetPoints = TargetPoints; return *this; }
94 
98  std::vector< std::vector< unsigned int > > GetTargetPoints() const { return this->m_TargetPoints; }
100  SITK_RETURN_SELF_TYPE_HEADER AddTargetPoint( const std::vector< unsigned int > &point ) { this->m_TargetPoints.push_back(point); return *this;}
102  SITK_RETURN_SELF_TYPE_HEADER ClearTargetPoints( ) { this->m_TargetPoints.clear(); return *this;}
103 
104 
108  SITK_RETURN_SELF_TYPE_HEADER SetTargetOffset ( double TargetOffset ) { this->m_TargetOffset = TargetOffset; return *this; }
109 
113  double GetTargetOffset() const { return this->m_TargetOffset; }
114 
118  SITK_RETURN_SELF_TYPE_HEADER SetNormalizationFactor ( double NormalizationFactor ) { this->m_NormalizationFactor = NormalizationFactor; return *this; }
119 
123  double GetNormalizationFactor() const { return this->m_NormalizationFactor; }
130  Image GetGradientImage() const { return this->m_GradientImage; };
131 
138  double GetTargetValue() const { return this->m_TargetValue; };
139 
141  std::string GetName() const { return std::string ("FastMarchingUpwindGradientImageFilter"); }
142 
144  std::string ToString() const;
145 
146 
148  Image Execute ( const Image& image1 );
149 
150 
152  Image Execute ( const Image& image1, const std::vector< std::vector<unsigned int> > & trialPoints, unsigned int numberOfTargets, const std::vector< std::vector<unsigned int> > & targetPoints, double targetOffset, double normalizationFactor );
153 
154  private:
155 
158  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
159  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
160 
161 
162  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
163 
164  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
165 
166 
167  std::vector< std::vector<unsigned int> > m_TrialPoints;
168  unsigned int m_NumberOfTargets;
169  std::vector< std::vector<unsigned int> > m_TargetPoints;
172  /* Docs */
174  /* Docs */
176 
177  };
178 
179 
188  SITKBasicFilters_EXPORT Image FastMarchingUpwindGradient ( const Image& image1, const std::vector< std::vector<unsigned int> > & trialPoints = std::vector< std::vector<unsigned int > >(), unsigned int numberOfTargets = 0u, const std::vector< std::vector<unsigned int> > & targetPoints = std::vector< std::vector<unsigned int > >(), double targetOffset = 1, double normalizationFactor = 1.0 );
189 
190  }
191 }
192 #endif
itk::simple::FastMarchingUpwindGradientImageFilter::GetName
std::string GetName() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:141
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetPoints
std::vector< std::vector< unsigned int > > m_TargetPoints
Definition: sitkFastMarchingUpwindGradientImageFilter.h:169
itk::simple::FastMarchingUpwindGradientImageFilter::m_NumberOfTargets
unsigned int m_NumberOfTargets
Definition: sitkFastMarchingUpwindGradientImageFilter.h:168
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::FastMarchingUpwindGradientImageFilter::AddTargetPoint
Self & AddTargetPoint(const std::vector< unsigned int > &point)
Add TargetPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:100
itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetValue
double m_TargetValue
Definition: sitkFastMarchingUpwindGradientImageFilter.h:175
itk::simple::FastMarchingUpwindGradient
Image FastMarchingUpwindGradient(const Image &image1, const std::vector< std::vector< unsigned int > > &trialPoints=std::vector< std::vector< unsigned int > >(), unsigned int numberOfTargets=0u, const std::vector< std::vector< unsigned int > > &targetPoints=std::vector< std::vector< unsigned int > >(), double targetOffset=1, double normalizationFactor=1.0)
Generates the upwind gradient field of fast marching arrival times.
itk::simple::FastMarchingUpwindGradientImageFilter::GetNormalizationFactor
double GetNormalizationFactor() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:123
itk::simple::FastMarchingUpwindGradientImageFilter::m_GradientImage
Image m_GradientImage
Definition: sitkFastMarchingUpwindGradientImageFilter.h:173
itk::simple::FastMarchingUpwindGradientImageFilter::GetTrialPoints
std::vector< std::vector< unsigned int > > GetTrialPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:74
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:118
itk::simple::FastMarchingUpwindGradientImageFilter::AddTrialPoint
Self & AddTrialPoint(const std::vector< unsigned int > &point)
Add TrialPoints point.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:76
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetOffset
double GetTargetOffset() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:113
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetPoints
std::vector< std::vector< unsigned int > > GetTargetPoints() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:98
itk::simple::FastMarchingUpwindGradientImageFilter::GetNumberOfTargets
unsigned int GetNumberOfTargets() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:88
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetOffset
Self & SetTargetOffset(double TargetOffset)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:108
itk::simple::FastMarchingUpwindGradientImageFilter::SetTrialPoints
Self & SetTrialPoints(const std::vector< std::vector< unsigned int > > &TrialPoints)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:70
itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetOffset
double m_TargetOffset
Definition: sitkFastMarchingUpwindGradientImageFilter.h:170
itk::simple::FastMarchingUpwindGradientImageFilter::m_NormalizationFactor
double m_NormalizationFactor
Definition: sitkFastMarchingUpwindGradientImageFilter.h:171
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTrialPoints
Self & ClearTrialPoints()
Remove all TrialPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:78
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::FastMarchingUpwindGradientImageFilter::SetNumberOfTargets
Self & SetNumberOfTargets(unsigned int NumberOfTargets)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:83
itk::simple::FastMarchingUpwindGradientImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFastMarchingUpwindGradientImageFilter.h:164
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:130
itk::simple::FastMarchingUpwindGradientImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFastMarchingUpwindGradientImageFilter.h:64
itk
itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetPoints
Self & SetTargetPoints(const std::vector< std::vector< unsigned int > > &TargetPoints)
Definition: sitkFastMarchingUpwindGradientImageFilter.h:93
itk::simple::FastMarchingUpwindGradientImageFilter::ClearTargetPoints
Self & ClearTargetPoints()
Remove all TargetPoints points.
Definition: sitkFastMarchingUpwindGradientImageFilter.h:102
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::FastMarchingUpwindGradientImageFilter::m_TrialPoints
std::vector< std::vector< unsigned int > > m_TrialPoints
Definition: sitkFastMarchingUpwindGradientImageFilter.h:167
itk::simple::FastMarchingUpwindGradientImageFilter::Self
FastMarchingUpwindGradientImageFilter Self
Definition: sitkFastMarchingUpwindGradientImageFilter.h:54
itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetValue
double GetTargetValue() const
Definition: sitkFastMarchingUpwindGradientImageFilter.h:138