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.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
32
33namespace itk::simple {
34
64public:
66
69
73
76
77
78
79
82 void
83 SetTrialPoints(std::vector< std::vector<unsigned int> > TrialPoints )
84 { this->m_TrialPoints = std::move(TrialPoints); }
85
87 std::vector< std::vector< unsigned int > >
88 GetTrialPoints() const { return this->m_TrialPoints; }
90 void
91 AddTrialPoint( std::vector< unsigned int > point ) { this->m_TrialPoints.push_back(std::move(point));}
93 void
94 ClearTrialPoints( ) { this->m_TrialPoints.clear();}
95
96
99 void
100 SetNumberOfTargets(unsigned int NumberOfTargets )
101 { this->m_NumberOfTargets = NumberOfTargets; }
102
105 unsigned int
106 GetNumberOfTargets() const { return this->m_NumberOfTargets; }
107
108
113 void
114 SetTargetPoints(std::vector< std::vector<unsigned int> > TargetPoints )
115 { this->m_TargetPoints = std::move(TargetPoints); }
116
119 std::vector< std::vector< unsigned int > >
120 GetTargetPoints() const { return this->m_TargetPoints; }
122 void
123 AddTargetPoint( std::vector< unsigned int > point ) { this->m_TargetPoints.push_back(std::move(point));}
125 void
127
128
133 void
134 SetTargetOffset(double TargetOffset )
135 { this->m_TargetOffset = TargetOffset; }
136
139 double
140 GetTargetOffset() const { return this->m_TargetOffset; }
141
142
147 void
148 SetNormalizationFactor(double NormalizationFactor )
149 { this->m_NormalizationFactor = NormalizationFactor; }
150
154 double
156
157
161 void
162 SetInitialTrialValues(std::vector<double> InitialTrialValues )
163 { this->m_InitialTrialValues = InitialTrialValues; }
164
166 std::vector<double>
168
169
176 Image GetGradientImage() const { return this->m_GradientImage; }
177
184 double GetTargetValue() const { return this->m_TargetValue; }
185
187 std::string GetName() const { return std::string("FastMarchingUpwindGradientImageFilter"); }
188
190 std::string ToString() const;
191
192
194 Image Execute(const Image &image1);
195
196
197private:
199 using MemberFunctionType = Image (Self::*)(const Image &image1);
200 template <class TImageType> Image ExecuteInternal(const Image &image1);
203
204
205 std::vector< std::vector<unsigned int> > m_TrialPoints{ std::vector< std::vector<unsigned int > >() };
206
207 unsigned int m_NumberOfTargets{ 0u };
208
209 std::vector< std::vector<unsigned int> > m_TargetPoints{ std::vector< std::vector<unsigned int > >() };
210
211 double m_TargetOffset{ 1.0 };
212
214
215 std::vector<double> m_InitialTrialValues{ std::vector<double>() };
216
217
218
220 double m_TargetValue{ 0.0 };
221
222
223
224
225};
226
227
237 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>()
238);
239
241
242}
243#endif
void AddTrialPoint(std::vector< unsigned int > point)
Add TrialPoints point.
std::vector< std::vector< unsigned int > > GetTrialPoints() const
void AddTargetPoint(std::vector< unsigned int > point)
Add TargetPoints point.
std::vector< std::vector< unsigned int > > GetTargetPoints() const
void SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints)
void SetTargetPoints(std::vector< std::vector< unsigned int > > TargetPoints)
void SetInitialTrialValues(std::vector< double > InitialTrialValues)
Set the initial seed values for corresponding trial point.
static const detail::MemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
The Image class for SimpleITK.
Definition sitkImage.h:77
A class used to instantiate and generate function object to templated member functions.
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.
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
#define SITKBasicFilters_EXPORT