SimpleITK  1.1.0
sitkWhiteTopHatImageFilter.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 sitkWhiteTopHatImageFilter_h
19 #define sitkWhiteTopHatImageFilter_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 sitkKernelImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkImageFilter.h"
30 #include "sitkBasicFilters.h"
31 #include "sitkKernel.h"
32 
33 namespace itk {
34  namespace simple {
35 
46  public:
48 
50  virtual ~WhiteTopHatImageFilter();
51 
55 
58 
60  typedef enum{Annulus=sitkAnnulus, Ball=sitkBall, Box=sitkBox, Cross=sitkCross} KernelType;
61 
62 
63 
67  SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }
68 
70  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
71  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }
72 
76  bool GetSafeBorder() const { return this->m_SafeBorder; }
78  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(uint32_t r);
79 
87  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(const std::vector<uint32_t> &r );
88  std::vector<uint32_t> GetKernelRadius() const;
89 
92  SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelEnum t);
93 #ifndef SWIG
94  SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelType t);
95 #endif
96  KernelEnum GetKernelType() const;
97 
99  std::string GetName() const { return std::string ("WhiteTopHatImageFilter"); }
100 
102  std::string ToString() const;
103 
104 
106  Image Execute ( const Image& image1 );
107 
108 
110  Image Execute ( const Image& image1, bool safeBorder );
111 
112 
113  private:
114 
117  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
118  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
119 
120 
121  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
122 
123  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
124 
125 
126  /* */
128 
129  /* Kernel Radius as a vector */
130  std::vector<uint32_t> m_KernelRadius;
131 
134  };
135 
136 
144  uint32_t radius = 1, KernelEnum kernel = sitkBall
145  , bool safeBorder = true );
146 
147 
155  const std::vector<uint32_t> vectorRadius, KernelEnum kernel = sitkBall
156  , bool safeBorder = true );
157  }
158 }
159 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::WhiteTopHatImageFilter::m_KernelRadius
std::vector< uint32_t > m_KernelRadius
Definition: sitkWhiteTopHatImageFilter.h:130
sitkBasicFilters.h
itk::simple::WhiteTopHatImageFilter::Self
WhiteTopHatImageFilter Self
Definition: sitkWhiteTopHatImageFilter.h:47
itk::simple::WhiteTopHatImageFilter::m_KernelType
KernelEnum m_KernelType
Definition: sitkWhiteTopHatImageFilter.h:133
itk::simple::WhiteTopHatImageFilter
White top hat extracts local maxima that are larger than the structuring element.
Definition: sitkWhiteTopHatImageFilter.h:45
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::WhiteTopHatImageFilter::SafeBorderOn
Self & SafeBorderOn()
Definition: sitkWhiteTopHatImageFilter.h:70
itk::simple::WhiteTopHatImageFilter::SafeBorderOff
Self & SafeBorderOff()
Definition: sitkWhiteTopHatImageFilter.h:71
itk::simple::sitkBox
@ sitkBox
Definition: sitkKernel.h:32
itk::simple::WhiteTopHatImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkWhiteTopHatImageFilter.h:57
itk::simple::WhiteTopHatImageFilter::m_SafeBorder
bool m_SafeBorder
Definition: sitkWhiteTopHatImageFilter.h:127
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::WhiteTopHatImageFilter::GetName
std::string GetName() const
Definition: sitkWhiteTopHatImageFilter.h:99
itk::simple::sitkBall
@ sitkBall
Definition: sitkKernel.h:31
itk::simple::sitkAnnulus
@ sitkAnnulus
Definition: sitkKernel.h:30
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:29
itk::simple::sitkCross
@ sitkCross
Definition: sitkKernel.h:33
Cross
itk
sitkKernel.h
itk::simple::WhiteTopHatImageFilter::GetSafeBorder
bool GetSafeBorder() const
Definition: sitkWhiteTopHatImageFilter.h:76
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::WhiteTopHat
Image WhiteTopHat(const Image &, uint32_t radius=1, KernelEnum kernel=sitkBall, bool safeBorder=true)
itk::simple::WhiteTopHatImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkWhiteTopHatImageFilter.h:123
itk::uint32_t
::uint32_t uint32_t
itk::simple::WhiteTopHatImageFilter::SetSafeBorder
Self & SetSafeBorder(bool SafeBorder)
Definition: sitkWhiteTopHatImageFilter.h:67