SimpleITK  
sitkSTAPLEImageFilter.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 sitkSTAPLEImageFilter_h
19#define sitkSTAPLEImageFilter_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 sitkMultiInputImageFilterTemplate.h.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
32
33namespace itk::simple {
34
110public:
112
115
119
122
123
124
125
126
133 void
134 SetConfidenceWeight(double ConfidenceWeight )
135 { this->m_ConfidenceWeight = ConfidenceWeight; }
136
142 double
143 GetConfidenceWeight() const { return this->m_ConfidenceWeight; }
144
145
149 void
150 SetForegroundValue(double ForegroundValue )
151 { this->m_ForegroundValue = ForegroundValue; }
152
155 double
156 GetForegroundValue() const { return this->m_ForegroundValue; }
157
158
163 void
164 SetMaximumIterations(unsigned int MaximumIterations )
165 { this->m_MaximumIterations = MaximumIterations; }
166
170 unsigned int
172
173
180 uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; }
181
188 std::vector<double> GetSensitivity() const { return this->m_Sensitivity; }
189
195 std::vector<double> GetSpecificity () const { return this->m_Specificity ; }
196
198 std::string GetName() const { return std::string("STAPLEImageFilter"); }
199
201 std::string ToString() const;
202
204 Image Execute(const std::vector<Image> &images);
205
206 Image Execute(const Image& image1);
207
208 Image Execute(const Image& image1, const Image& image2);
209
210 Image Execute(const Image& image1, const Image& image2, const Image& image3);
211
212 Image Execute(const Image& image1, const Image& image2, const Image& image3, const Image& image4);
213
214 Image Execute(const Image& image1, const Image& image2, const Image& image3, const Image& image4, const Image& image5);
215
216
217
218
219private:
220
222 using MemberFunctionType = Image (Self::*)(const std::vector<Image> &);
223 template <class TImageType> Image ExecuteInternal(const std::vector<Image> &images);
224
225
226
227
230
231
232 double m_ConfidenceWeight{ 1.0 };
233
234 double m_ForegroundValue{ 1.0 };
235
236 unsigned int m_MaximumIterations{ std::numeric_limits<unsigned int>::max() };
237
238
239
240 uint32_t m_ElapsedIterations{ 0 };
241 std::vector<double> m_Sensitivity{ std::vector<double>() };
242 std::vector<double> m_Specificity { std::vector<double>() };
243
244
245
246
247};
248
249
258SITKBasicFilters_EXPORT Image STAPLE(const std::vector<Image> &images, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
259
260SITKBasicFilters_EXPORT Image STAPLE(const Image& image1, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
261
262SITKBasicFilters_EXPORT Image STAPLE(const Image& image1, const Image& image2, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
263
264SITKBasicFilters_EXPORT Image STAPLE(const Image& image1, const Image& image2, const Image& image3, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
265
266SITKBasicFilters_EXPORT Image STAPLE(const Image& image1, const Image& image2, const Image& image3, const Image& image4, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
267
268SITKBasicFilters_EXPORT Image STAPLE(const Image& image1, const Image& image2, const Image& image3, const Image& image4, const Image& image5, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max());
269
271
272}
273#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
void SetForegroundValue(double ForegroundValue)
Image Execute(const Image &image1, const Image &image2, const Image &image3, const Image &image4)
Image Execute(const std::vector< Image > &images)
Image ExecuteInternal(const std::vector< Image > &images)
void SetMaximumIterations(unsigned int MaximumIterations)
Image Execute(const Image &image1, const Image &image2, const Image &image3)
std::string ToString() const
std::vector< double > GetSensitivity() const
void SetConfidenceWeight(double ConfidenceWeight)
Image(Self::*)(const std::vector< Image > &) MemberFunctionType
static const detail::MemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
Image Execute(const Image &image1, const Image &image2)
std::vector< double > GetSpecificity() const
After the filter is updated, this method returns the Specificity (true negative fraction,...
Image Execute(const Image &image1)
Image Execute(const Image &image1, const Image &image2, const Image &image3, const Image &image4, const Image &image5)
A class used to instantiate and generate function object to templated member functions.
Image STAPLE(const std::vector< Image > &images, double confidenceWeight=1.0, double foregroundValue=1.0, unsigned int maximumIterations=std::numeric_limits< unsigned int >::max())
The STAPLE filter implements the Simultaneous Truth and Performance Level Estimation algorithm for ge...
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > > IntegerPixelIDTypeList
#define SITKBasicFilters_EXPORT