SimpleITK  
sitkRankImageFilter.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 sitkRankImageFilter_h
19 #define sitkRankImageFilter_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 
55  public:
57 
59  virtual ~RankImageFilter();
60 
64 
67 \
68 
71  SITK_RETURN_SELF_TYPE_HEADER SetRank ( double Rank ) { this->m_Rank = Rank; return *this; }
72 
75  double GetRank() const { return this->m_Rank; }\
76 
79  SITK_RETURN_SELF_TYPE_HEADER SetRadius ( std::vector<unsigned int> Radius ) { this->m_Radius = std::move(Radius); return *this; }
80 
83  std::vector<unsigned int> GetRadius() const { return this->m_Radius; }\
84 
88  SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
89 
93  KernelEnum GetKernelType() const { return this->m_KernelType; }
94 
96  std::string GetName() const { return std::string ("RankImageFilter"); }
97 
99  std::string ToString() const;
100 
101 
104  Image Execute ( const Image& image1 );
105 
106  private:
107 
110  using MemberFunctionType = Image (Self::*)( const Image& image1 );
111  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
113  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
114 
117  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
118 
119 
120  /* */
121  double m_Rank{0.5};
122 
123  /* */
124  std::vector<unsigned int> m_Radius{std::vector<unsigned int>(3, 1)};
125 
127 
128 
129  };
130 
141  SITKBasicFilters_EXPORT Image Rank ( const Image& image1, double rank = 0.5, std::vector<unsigned int> radius = std::vector<unsigned int>(3, 1), KernelEnum kernelType = itk::simple::sitkBox );
142 
144 }
145 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:62
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::sitkBox
@ sitkBox
Box shaped structuring element.
Definition: sitkKernel.h:36
itk::simple::RankImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkRankImageFilter.h:66
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::RankImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRankImageFilter.h:110
itk::simple::RankImageFilter
Rank filter of a greyscale image.
Definition: sitkRankImageFilter.h:54
sitkImageFilter.h
itk::simple::RankImageFilter::GetName
std::string GetName() const
Definition: sitkRankImageFilter.h:96
itk::simple::Rank
Image Rank(const Image &image1, double rank=0.5, std::vector< unsigned int > radius=std::vector< unsigned int >(3, 1), KernelEnum kernelType=itk::simple::sitkBox)
Rank filter of a greyscale image.
itk::simple::RankImageFilter::SetRank
Self & SetRank(double Rank)
Definition: sitkRankImageFilter.h:71
itk::simple::RankImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkRankImageFilter.h:93
itk::simple::RankImageFilter::GetRank
double GetRank() const
Definition: sitkRankImageFilter.h:75
itk::simple::RankImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkRankImageFilter.h:88
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:27
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::RankImageFilter::GetRadius
std::vector< unsigned int > GetRadius() const
Definition: sitkRankImageFilter.h:83
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::RankImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRankImageFilter.h:117
itk::simple::RankImageFilter::SetRadius
Self & SetRadius(std::vector< unsigned int > Radius)
Definition: sitkRankImageFilter.h:79
itk::simple
Definition: sitkAdditionalProcedures.h:28