SimpleITK  
sitkWhiteTopHatImageFilter.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 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 sitkImageFilterTemplate.h.in to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
31
32namespace itk::simple {
33
44 public:
46
49
53
56\
57
61 SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius ( std::vector<unsigned int> KernelRadius ) { this->m_KernelRadius = std::move(KernelRadius); return *this; }
62
64 SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); return *this; }
65
69 std::vector<unsigned int> GetKernelRadius() const { return this->m_KernelRadius; }\
70
74 SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
75
79 KernelEnum GetKernelType() const { return this->m_KernelType; }\
80
84 SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }
85
87 SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
88 SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }
89
93 bool GetSafeBorder() const { return this->m_SafeBorder; }
94
96 std::string GetName() const { return std::string ("WhiteTopHatImageFilter"); }
97
99 std::string ToString() const;
100
101
103
104 Image Execute ( const Image& image1 );
105
106 private:
107
109
110 using MemberFunctionType = Image (Self::*)( const Image& image1 );
111 template <class TImageType> Image ExecuteInternal ( const Image& image1 );
112
113
115
116 std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
117
118
119 /* */
120 std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
121
123
124 /* */
125 bool m_SafeBorder{true};
126
127
128 };
129
139
140 SITKBasicFilters_EXPORT Image WhiteTopHat ( const Image& image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, bool safeBorder = true );
141
143}
144#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
Self & SetKernelType(KernelEnum KernelType)
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Image Execute(const Image &image1)
Image ExecuteInternal(const Image &image1)
std::vector< unsigned int > GetKernelRadius() const
Image(Self::*)(const Image &image1) MemberFunctionType
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Image WhiteTopHat(const Image &image1, std::vector< unsigned int > kernelRadius=std::vector< uint32_t >(3, 1), KernelEnum kernelType=itk::simple::sitkBall, bool safeBorder=true)
White top hat extracts local maxima that are larger than the structuring element.
@ sitkBall
Ball (sphere in 3D, circle in 2D) shaped structuring element.
Definition sitkKernel.h:34
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
#define SITKBasicFilters_EXPORT