ITK  5.2.0
Insight Toolkit
itkRegionalMaximaImageFilter.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 itkRegionalMaximaImageFilter_h
19 #define itkRegionalMaximaImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 
23 namespace itk
24 {
53 template <typename TInputImage, typename TOutputImage>
54 class ITK_TEMPLATE_EXPORT RegionalMaximaImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
55 {
56 public:
57  ITK_DISALLOW_COPY_AND_MOVE(RegionalMaximaImageFilter);
58 
64 
66  using InputImageType = TInputImage;
67  using OutputImageType = TOutputImage;
68  using InputImagePointer = typename InputImageType::Pointer;
69  using InputImageConstPointer = typename InputImageType::ConstPointer;
71  using InputImagePixelType = typename InputImageType::PixelType;
72  using OutputImagePointer = typename OutputImageType::Pointer;
73  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
75  using OutputImagePixelType = typename OutputImageType::PixelType;
76 
78  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
79  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
80 
82  itkNewMacro(Self);
83 
86 
93  itkSetMacro(FullyConnected, bool);
94  itkGetConstMacro(FullyConnected, bool);
95  itkBooleanMacro(FullyConnected);
97 
102  itkSetMacro(ForegroundValue, OutputImagePixelType);
103  itkGetConstMacro(ForegroundValue, OutputImagePixelType);
105 
110  itkSetMacro(BackgroundValue, OutputImagePixelType);
111  itkGetConstMacro(BackgroundValue, OutputImagePixelType);
113 
118  itkSetMacro(FlatIsMaxima, bool);
119  itkGetConstMacro(FlatIsMaxima, bool);
120  itkBooleanMacro(FlatIsMaxima);
122 
123 #ifdef ITK_USE_CONCEPT_CHECKING
124  // Begin concept checking
127  // End concept checking
128 #endif
129 
130 protected:
132  ~RegionalMaximaImageFilter() override = default;
133  void
134  PrintSelf(std::ostream & os, Indent indent) const override;
135 
139  void
140  GenerateInputRequestedRegion() override;
141 
143  void
144  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
145 
148  void
149  GenerateData() override;
150 
151 private:
152  bool m_FullyConnected{ false };
153  bool m_FlatIsMaxima{ true };
156 }; // end of class
157 } // end namespace itk
158 
159 #ifndef ITK_MANUAL_INSTANTIATION
160 # include "itkRegionalMaximaImageFilter.hxx"
161 #endif
162 
163 #endif
itk::RegionalMaximaImageFilter::m_BackgroundValue
OutputImagePixelType m_BackgroundValue
Definition: itkRegionalMaximaImageFilter.h:155
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:714
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::RegionalMaximaImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkRegionalMaximaImageFilter.h:73
itk::RegionalMaximaImageFilter
Produce a binary image where foreground is the regional maxima of the input image.
Definition: itkRegionalMaximaImageFilter.h:54
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::RegionalMaximaImageFilter::m_ForegroundValue
OutputImagePixelType m_ForegroundValue
Definition: itkRegionalMaximaImageFilter.h:154
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
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
itkImageToImageFilter.h
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:65
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::Concept::HasPixelTraits
Definition: itkConceptChecking.h:751
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
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293