SimpleITK  1.1.0
sitkBinaryMedianImageFilter.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 sitkBinaryMedianImageFilter_h
19 #define sitkBinaryMedianImageFilter_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 
55  public:
57 
59  virtual ~BinaryMedianImageFilter();
60 
64 
67 
68 
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetRadius ( const std::vector<unsigned int> & Radius ) { this->m_Radius = Radius; return *this; }
74 
76  SITK_RETURN_SELF_TYPE_HEADER SetRadius( unsigned int value ) { this->m_Radius = std::vector<unsigned int>(3, value); return *this; }
77 
78 
82  std::vector<unsigned int> GetRadius() const { return this->m_Radius; }
83 
87  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
88 
92  double GetForegroundValue() const { return this->m_ForegroundValue; }
93 
97  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
98 
102  double GetBackgroundValue() const { return this->m_BackgroundValue; }
104  std::string GetName() const { return std::string ("BinaryMedianImageFilter"); }
105 
107  std::string ToString() const;
108 
109 
111  Image Execute ( const Image& image1 );
112 
113 
115  Image Execute ( const Image& image1, const std::vector<unsigned int> & radius, double foregroundValue, double backgroundValue );
116 
117  private:
118 
121  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
122  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
123 
124 
125  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
126 
127  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
128 
129 
130  /* */
131  std::vector<unsigned int> m_Radius;
134  };
135 
136 
145  SITKBasicFilters_EXPORT Image BinaryMedian ( const Image& image1, const std::vector<unsigned int> & radius = std::vector<unsigned int>(3, 1), double foregroundValue = 1.0, double backgroundValue = 0.0 );
146 
147  }
148 }
149 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::BinaryMedianImageFilter::SetRadius
Self & SetRadius(const std::vector< unsigned int > &Radius)
Definition: sitkBinaryMedianImageFilter.h:73
itk::simple::BinaryMedianImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryMedianImageFilter.h:104
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::BinaryMedianImageFilter::Self
BinaryMedianImageFilter Self
Definition: sitkBinaryMedianImageFilter.h:56
itk::simple::BinaryMedianImageFilter::m_Radius
std::vector< unsigned int > m_Radius
Definition: sitkBinaryMedianImageFilter.h:131
itk::simple::BinaryMedianImageFilter::m_BackgroundValue
double m_BackgroundValue
Definition: sitkBinaryMedianImageFilter.h:133
itk::simple::BinaryMedianImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryMedianImageFilter.h:102
itk::simple::BinaryMedianImageFilter::SetRadius
Self & SetRadius(unsigned int value)
Definition: sitkBinaryMedianImageFilter.h:76
itk::simple::BinaryMedianImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryMedianImageFilter.h:92
sitkImageFilter.h
itk::simple::BinaryMedianImageFilter
Applies a version of the median filter optimized for binary images.
Definition: sitkBinaryMedianImageFilter.h:54
itk::simple::BinaryMedianImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryMedianImageFilter.h:66
itk::simple::BinaryMedian
Image BinaryMedian(const Image &image1, const std::vector< unsigned int > &radius=std::vector< unsigned int >(3, 1), double foregroundValue=1.0, double backgroundValue=0.0)
Applies a version of the median filter optimized for binary images.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::BinaryMedianImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryMedianImageFilter.h:97
itk::simple::BinaryMedianImageFilter::m_ForegroundValue
double m_ForegroundValue
Definition: sitkBinaryMedianImageFilter.h:132
itk::simple::BinaryMedianImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryMedianImageFilter.h:127
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::BinaryMedianImageFilter::GetRadius
std::vector< unsigned int > GetRadius() const
Definition: sitkBinaryMedianImageFilter.h:82
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::BinaryMedianImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryMedianImageFilter.h:87
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