SimpleITK  1.3.0.dev466
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
#define SITKBasicFilters_EXPORT
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
White top hat extracts local maxima that are larger than the structuring element. ...
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
Image WhiteTopHat(const Image &, uint32_t radius=1, KernelEnum kernel=sitkBall, bool safeBorder=true)
The base interface for SimpleITK filters that take one input image.