SimpleITK  
sitkBlackTopHatImageFilter.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 sitkBlackTopHatImageFilter_h
19 #define sitkBlackTopHatImageFilter_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 
46  public:
48 
50  virtual ~BlackTopHatImageFilter();
51 
55 
58 \
59 
63  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius ( std::vector<unsigned int> KernelRadius ) { this->m_KernelRadius = std::move(KernelRadius); return *this; }
64 
66  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); return *this; }
67 
71  std::vector<unsigned int> GetKernelRadius() const { return this->m_KernelRadius; }\
72 
76  SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
77 
81  KernelEnum GetKernelType() const { return this->m_KernelType; }\
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }
87 
89  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
90  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }
91 
95  bool GetSafeBorder() const { return this->m_SafeBorder; }
96 
98  std::string GetName() const { return std::string ("BlackTopHatImageFilter"); }
99 
101  std::string ToString() const;
102 
103 
106  Image Execute ( const Image& image1 );
107 
108  private:
109 
112  using MemberFunctionType = Image (Self::*)( const Image& image1 );
113  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
114 
115 
117 
118  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
119 
120 
121  /* */
122  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
123 
125 
126  /* */
127  bool m_SafeBorder{true};
128 
129 
130  };
131 
142  SITKBasicFilters_EXPORT Image BlackTopHat ( const Image& image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, bool safeBorder = true );
143 
145 }
146 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::BlackTopHatImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBlackTopHatImageFilter.h:76
itk::simple::BlackTopHatImageFilter::SafeBorderOn
Self & SafeBorderOn()
Definition: sitkBlackTopHatImageFilter.h:89
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::BlackTopHatImageFilter::GetName
std::string GetName() const
Definition: sitkBlackTopHatImageFilter.h:98
itk::simple::BlackTopHatImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBlackTopHatImageFilter.h:81
sitkImageFilter.h
itk::simple::sitkBall
@ sitkBall
Ball (sphere in 3D, circle in 2D) shaped structuring element.
Definition: sitkKernel.h:34
itk::simple::BlackTopHatImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBlackTopHatImageFilter.h:63
itk::simple::BlackTopHatImageFilter
Black top hat extracts local minima that are smaller than the structuring element.
Definition: sitkBlackTopHatImageFilter.h:45
itk::simple::BlackTopHatImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBlackTopHatImageFilter.h:71
itk::simple::BlackTopHatImageFilter::GetSafeBorder
bool GetSafeBorder() const
Definition: sitkBlackTopHatImageFilter.h:95
itk::simple::BlackTopHatImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkBlackTopHatImageFilter.h:57
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:27
itk::simple::BlackTopHatImageFilter::SafeBorderOff
Self & SafeBorderOff()
Definition: sitkBlackTopHatImageFilter.h:90
itk::simple::BlackTopHatImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBlackTopHatImageFilter.h:118
itk::simple::BlackTopHat
Image BlackTopHat(const Image &image1, std::vector< unsigned int > kernelRadius=std::vector< uint32_t >(3, 1), KernelEnum kernelType=itk::simple::sitkBall, bool safeBorder=true)
Black top hat extracts local minima that are smaller than the structuring element.
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::BlackTopHatImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBlackTopHatImageFilter.h:112
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::BlackTopHatImageFilter::SetSafeBorder
Self & SetSafeBorder(bool SafeBorder)
Definition: sitkBlackTopHatImageFilter.h:86
itk::simple::BlackTopHatImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBlackTopHatImageFilter.h:66