ITK  5.1.0
Insight Toolkit
itkWhiteTopHatImageFilter.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 itkWhiteTopHatImageFilter_h
19 #define itkWhiteTopHatImageFilter_h
20 
21 #include "itkKernelImageFilter.h"
22 
23 namespace itk
24 {
37 template <typename TInputImage, typename TOutputImage, typename TKernel>
38 class ITK_TEMPLATE_EXPORT WhiteTopHatImageFilter : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
39 {
40 public:
41  ITK_DISALLOW_COPY_AND_ASSIGN(WhiteTopHatImageFilter);
42 
48 
50  using InputImageType = TInputImage;
51  using OutputImageType = TOutputImage;
52  using InputImagePointer = typename InputImageType::Pointer;
53  using InputImageConstPointer = typename InputImageType::ConstPointer;
55  using InputImagePixelType = typename InputImageType::PixelType;
56  using OutputImagePointer = typename OutputImageType::Pointer;
57  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
59  using OutputImagePixelType = typename OutputImageType::PixelType;
60 
62  using KernelType = TKernel;
63 
65  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
66  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
67 
69  itkNewMacro(Self);
70 
73 
76  itkSetMacro(SafeBorder, bool);
77  itkGetConstReferenceMacro(SafeBorder, bool);
78  itkBooleanMacro(SafeBorder);
80 
83  {
84  BASIC = 0,
85  HISTO = 1,
86  ANCHOR = 2,
87  VHGW = 3
88  };
89 
91  itkSetMacro(Algorithm, int);
92  itkGetConstMacro(Algorithm, int);
94 
95  itkSetMacro(ForceAlgorithm, bool);
96  itkGetConstReferenceMacro(ForceAlgorithm, bool);
97  itkBooleanMacro(ForceAlgorithm);
98 
99 protected:
101  ~WhiteTopHatImageFilter() override = default;
102  void
103  PrintSelf(std::ostream & os, Indent indent) const override;
104 
105  void
106  GenerateData() override;
107 
108 private:
110 
112 
114 }; // end of class
115 } // end namespace itk
116 
117 #ifndef ITK_MANUAL_INSTANTIATION
118 # include "itkWhiteTopHatImageFilter.hxx"
119 #endif
120 
121 #endif
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::WhiteTopHatImageFilter::m_ForceAlgorithm
bool m_ForceAlgorithm
Definition: itkWhiteTopHatImageFilter.h:113
itk::WhiteTopHatImageFilter
White top hat extracts local maxima that are larger than the structuring element.
Definition: itkWhiteTopHatImageFilter.h:38
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itkKernelImageFilter.h
itk::WhiteTopHatImageFilter::m_Algorithm
int m_Algorithm
Definition: itkWhiteTopHatImageFilter.h:111
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::WhiteTopHatImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkWhiteTopHatImageFilter.h:57
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkArray.h:26
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::WhiteTopHatImageFilter::AlgorithmType
AlgorithmType
Definition: itkWhiteTopHatImageFilter.h:82
itk::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::WhiteTopHatImageFilter::m_SafeBorder
bool m_SafeBorder
Definition: itkWhiteTopHatImageFilter.h:109
itk::KernelImageFilter::KernelType
TKernel KernelType
Definition: itkKernelImageFilter.h:71
itk::KernelImageFilter
A base class for all the filters working on an arbitrary shaped neighborhood.
Definition: itkKernelImageFilter.h:41
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90