SimpleITK  
sitkBinaryMedianImageFilter.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 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::simple {
33 
57  public:
59 
61  virtual ~BinaryMedianImageFilter();
62 
66 
69 \
70 
74  SITK_RETURN_SELF_TYPE_HEADER SetRadius ( std::vector<unsigned int> Radius ) { this->m_Radius = std::move(Radius); return *this; }
75 
77  SITK_RETURN_SELF_TYPE_HEADER SetRadius( unsigned int value ) { this->m_Radius = std::vector<unsigned int>(3, value); return *this; }
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; }
103 
105  std::string GetName() const { return std::string ("BinaryMedianImageFilter"); }
106 
108  std::string ToString() const;
109 
110 
113  Image Execute ( const Image& image1 );
114 
115  private:
116 
119  using MemberFunctionType = Image (Self::*)( const Image& image1 );
120  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
121 
122 
124 
125  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
126 
127 
128  /* */
129  std::vector<unsigned int> m_Radius{std::vector<unsigned int>(3, 1)};
130 
131  double m_ForegroundValue{1.0};
132 
133  double m_BackgroundValue{0.0};
134 
135 
136  };
137 
148  SITKBasicFilters_EXPORT Image BinaryMedian ( const Image& image1, std::vector<unsigned int> radius = std::vector<unsigned int>(3, 1), double foregroundValue = 1.0, double backgroundValue = 0.0 );
149 
151 }
152 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::BinaryMedianImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryMedianImageFilter.h:105
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::BinaryMedianImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryMedianImageFilter.h:119
itk::simple::BinaryMedian
Image BinaryMedian(const Image &image1, 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.
itk::simple::BinaryMedianImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryMedianImageFilter.h:125
itk::simple::BinaryMedianImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryMedianImageFilter.h:102
itk::simple::BinaryMedianImageFilter::SetRadius
Self & SetRadius(unsigned int value)
Definition: sitkBinaryMedianImageFilter.h:77
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:56
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::BinaryMedianImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryMedianImageFilter.h:97
itk::simple::BinaryMedianImageFilter::SetRadius
Self & SetRadius(std::vector< unsigned int > Radius)
Definition: sitkBinaryMedianImageFilter.h:74
itk::simple::BinaryMedianImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryMedianImageFilter.h:68
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::BinaryMedianImageFilter::GetRadius
std::vector< unsigned int > GetRadius() const
Definition: sitkBinaryMedianImageFilter.h:82
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::IntegerPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > > IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:75
itk::simple::BinaryMedianImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryMedianImageFilter.h:87
itk::simple
Definition: sitkAdditionalProcedures.h:28