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.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
32
33namespace itk::simple {
34
47public:
49
52
56
59
60
61
62
66 void
67 SetKernelRadius(std::vector<unsigned int> KernelRadius )
68 { this->m_KernelRadius = std::move(KernelRadius); }
69
71 void
72 SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); }
76 std::vector<unsigned int>
77 GetKernelRadius() const { return this->m_KernelRadius; }
78
79
83 void
85 { this->m_KernelType = KernelType; }
86
90 GetKernelType() const { return this->m_KernelType; }
91
92
96 void
97 SetSafeBorder(bool SafeBorder )
98 { this->m_SafeBorder = SafeBorder; }
99
101 void
102 SafeBorderOn() { return this->SetSafeBorder(true); }
103 void
104 SafeBorderOff() { return this->SetSafeBorder(false); }
108 bool
109 GetSafeBorder() const { return this->m_SafeBorder; }
110
111
113 std::string GetName() const { return std::string("WhiteTopHatImageFilter"); }
114
116 std::string ToString() const;
117
118
120 Image Execute(const Image &image1);
121
122
123private:
125 using MemberFunctionType = Image (Self::*)(const Image &image1);
126 template <class TImageType> Image ExecuteInternal(const Image &image1);
129
130
131 std::vector<unsigned int> m_KernelRadius{ std::vector<uint32_t>(3, 1) };
132
134
135 bool m_SafeBorder{ true };
136
137
138
139
140
141
142
143};
144
145
155 const Image &image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, bool safeBorder = true
156);
157
159
160}
161#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
Image Execute(const Image &image1)
void SetKernelRadius(std::vector< unsigned int > KernelRadius)
Image ExecuteInternal(const Image &image1)
std::vector< unsigned int > GetKernelRadius() const
static const detail::MemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
Image(Self::*)(const Image &image1) MemberFunctionType
A class used to instantiate and generate function object to templated member functions.
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