SimpleITK  1.3.0.dev466
sitkSTAPLEImageFilter.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 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 
74  : public ImageFilter<3>
75  {
76  public:
78 
80  virtual ~STAPLEImageFilter();
81 
82 
86 
89 
90 
91 
92 
96  SITK_RETURN_SELF_TYPE_HEADER SetConfidenceWeight ( double ConfidenceWeight ) { this->m_ConfidenceWeight = ConfidenceWeight; return *this; }
97 
101  double GetConfidenceWeight() const { return this->m_ConfidenceWeight; }
102 
106  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
107 
111  double GetForegroundValue() const { return this->m_ForegroundValue; }
112 
116  SITK_RETURN_SELF_TYPE_HEADER SetMaximumIterations ( unsigned int MaximumIterations ) { this->m_MaximumIterations = MaximumIterations; return *this; }
117 
121  unsigned int GetMaximumIterations() const { return this->m_MaximumIterations; }
128  uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; };
129 
136  std::vector<double> GetSensitivity() const { return this->m_Sensitivity; };
137 
144  std::vector<double> GetSpecificity () const { return this->m_Specificity ; };
145 
147  std::string GetName() const { return std::string ("STAPLEImageFilter"); }
148 
150  std::string ToString() const;
151 
153  Image Execute ( const std::vector<Image> &images);
154  Image Execute ( const Image& image1 );
155  Image Execute ( const Image& image1, const Image& image2 );
156  Image Execute ( const Image& image1, const Image& image2, const Image& image3 );
157  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4 );
158  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4, const Image& image5 );
159 
160 
161 
163  Image Execute ( const std::vector<Image> &images, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
164  Image Execute ( const Image& image1, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
165  Image Execute ( const Image& image1, const Image& image2, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
166  Image Execute ( const Image& image1, const Image& image2, const Image& image3, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
167  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
168  Image Execute ( const Image& image1, const Image& image2, const Image& image3, const Image& image4, const Image& image5, double confidenceWeight, double foregroundValue, unsigned int maximumIterations );
169 
170 
171 
172 
173  private:
174 
177  typedef Image (Self::*MemberFunctionType)( const std::vector<Image> & );
178  template <class TImageType> Image ExecuteInternal ( const std::vector<Image> &images );
179 
180 
181 
182  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
183 
184  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
185 
186 
189  unsigned int m_MaximumIterations;
190 
192 
193  std::vector<double> m_Sensitivity;
194 
195  std::vector<double> m_Specificity ;
196 
197  };
198 
199 
209  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() );
210 
211  SITKBasicFilters_EXPORT Image STAPLE ( const Image& image1, 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, 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, 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, double confidenceWeight = 1.0, double foregroundValue = 1.0, unsigned int maximumIterations = std::numeric_limits<unsigned int>::max() );
215  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() );
216 
219 }
220 }
221 #endif
Self & SetForegroundValue(double ForegroundValue)
Self & SetMaximumIterations(unsigned int MaximumIterations)
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > >::Type IntegerPixelIDTypeList
#define SITKBasicFilters_EXPORT
unsigned int GetMaximumIterations() const
std::vector< double > GetSensitivity() const
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...
Self & SetConfidenceWeight(double ConfidenceWeight)
::uint32_t uint32_t
std::vector< double > GetSpecificity() const
After the filter is updated, this method returns the Specificity (true negative fraction, q) value for the i-th expert input volume.
The Image class for SimpleITK.
Definition: sitkImage.h:78
The STAPLE filter implements the Simultaneous Truth and Performance Level Estimation algorithm for ge...
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The base interface for SimpleITK filters that take one input image.
IntegerPixelIDTypeList PixelIDTypeList