SimpleITK  2.0.0rc2.post23
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.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 
78  : public ImageFilter
79  {
80  public:
82 
84  virtual ~STAPLEImageFilter();
85 
86 
90 
93 
94 
95 \
96 
100  SITK_RETURN_SELF_TYPE_HEADER SetConfidenceWeight ( double ConfidenceWeight ) { this->m_ConfidenceWeight = ConfidenceWeight; return *this; }
101 
105  double GetConfidenceWeight() const { return this->m_ConfidenceWeight; }\
106 
110  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
111 
115  double GetForegroundValue() const { return this->m_ForegroundValue; }\
116 
120  SITK_RETURN_SELF_TYPE_HEADER SetMaximumIterations ( unsigned int MaximumIterations ) { this->m_MaximumIterations = MaximumIterations; return *this; }
121 
125  unsigned int GetMaximumIterations() const { return this->m_MaximumIterations; }
132  uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; };
133 
140  std::vector<double> GetSensitivity() const { return this->m_Sensitivity; };
141 
148  std::vector<double> GetSpecificity () const { return this->m_Specificity ; };
149 
150 
152  std::string GetName() const { return std::string ("STAPLEImageFilter"); }
153 
155  std::string ToString() const;
156 
158  Image Execute ( const std::vector<Image> &images);
159  Image Execute ( const Image& image1 );
160  Image Execute ( const Image& image1, const Image& image2 );
161  Image Execute ( const Image& image1, const Image& image2, const Image& image3 );
162  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4 );
163  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4, const Image& image5 );
164 
165 
166 
167 
168  private:
169 
172  using MemberFunctionType = Image (Self::*)( const std::vector<Image> & );
173  template <class TImageType> Image ExecuteInternal ( const std::vector<Image> &images );
174 
175 
176 
178 
179  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
180 
181 
182  double m_ConfidenceWeight{1.0};
183 
184  double m_ForegroundValue{1.0};
185 
186  unsigned int m_MaximumIterations{std::numeric_limits<unsigned int>::max()};
187 
188 
189  uint32_t m_ElapsedIterations{0};
190 
191  std::vector<double> m_Sensitivity{std::vector<double>()};
192 
193  std::vector<double> m_Specificity {std::vector<double>()};
194 
195 
196  };
197 
198 
208  SITKBasicFilters_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() );
209 
210  SITKBasicFilters_EXPORT Image STAPLE ( const Image& image1, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max() );
211  SITKBasicFilters_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() );
212  SITKBasicFilters_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() );
213  SITKBasicFilters_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() );
214  SITKBasicFilters_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() );
215 
218 }
219 }
220 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::STAPLEImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSTAPLEImageFilter.h:179
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::STAPLEImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkSTAPLEImageFilter.h:115
itk::simple::STAPLEImageFilter::MemberFunctionType
Image(Self::*)(const std::vector< Image > &) MemberFunctionType
Definition: sitkSTAPLEImageFilter.h:172
sitkImageFilter.h
itk::simple::STAPLEImageFilter::GetMaximumIterations
unsigned int GetMaximumIterations() const
Definition: sitkSTAPLEImageFilter.h:125
itk::simple::STAPLEImageFilter::GetName
std::string GetName() const
Definition: sitkSTAPLEImageFilter.h:152
itk::simple::STAPLE
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...
itk::simple::STAPLEImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkSTAPLEImageFilter.h:92
itk::simple::STAPLEImageFilter::GetConfidenceWeight
double GetConfidenceWeight() const
Definition: sitkSTAPLEImageFilter.h:105
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::STAPLEImageFilter::GetSensitivity
std::vector< double > GetSensitivity() const
Definition: sitkSTAPLEImageFilter.h:140
itk
itk::simple::STAPLEImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkSTAPLEImageFilter.h:110
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::STAPLEImageFilter::GetSpecificity
std::vector< double > GetSpecificity() const
After the filter is updated, this method returns the Specificity (true negative fraction,...
Definition: sitkSTAPLEImageFilter.h:148
itk::simple::STAPLEImageFilter::SetConfidenceWeight
Self & SetConfidenceWeight(double ConfidenceWeight)
Definition: sitkSTAPLEImageFilter.h:100
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::STAPLEImageFilter::GetElapsedIterations
uint32_t GetElapsedIterations() const
Definition: sitkSTAPLEImageFilter.h:132
itk::simple::STAPLEImageFilter::SetMaximumIterations
Self & SetMaximumIterations(unsigned int MaximumIterations)
Definition: sitkSTAPLEImageFilter.h:120
itk::simple::STAPLEImageFilter
The STAPLE filter implements the Simultaneous Truth and Performance Level Estimation algorithm for ge...
Definition: sitkSTAPLEImageFilter.h:77
itk::simple::IntegerPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > >::Type IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:76