ITK  5.2.0
Insight Toolkit
itkNeighborhoodConnectedImageFilter.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 itkNeighborhoodConnectedImageFilter_h
19 #define itkNeighborhoodConnectedImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 
23 namespace itk
24 {
36 template <typename TInputImage, typename TOutputImage>
37 class ITK_TEMPLATE_EXPORT NeighborhoodConnectedImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
38 {
39 public:
40  ITK_DISALLOW_COPY_AND_ASSIGN(NeighborhoodConnectedImageFilter);
41 
47 
49  itkNewMacro(Self);
50 
53 
54  using InputImageType = TInputImage;
55  using InputImagePointer = typename InputImageType::Pointer;
57  using InputImagePixelType = typename InputImageType::PixelType;
60 
61  using OutputImageType = TOutputImage;
62  using OutputImagePointer = typename OutputImageType::Pointer;
64  using OutputImagePixelType = typename OutputImageType::PixelType;
65 
66  void
67  PrintSelf(std::ostream & os, Indent indent) const override;
68 
70  void
71  ClearSeeds();
72 
74  void
75  SetSeed(const IndexType & seed);
76 
78  void
79  AddSeed(const IndexType & seed);
80 
82  itkSetMacro(Lower, InputImagePixelType);
83  itkGetConstMacro(Lower, InputImagePixelType);
85 
88  itkSetMacro(Upper, InputImagePixelType);
89  itkGetConstMacro(Upper, InputImagePixelType);
91 
95  itkSetMacro(ReplaceValue, OutputImagePixelType);
96  itkGetConstMacro(ReplaceValue, OutputImagePixelType);
98 
100  itkSetMacro(Radius, InputImageSizeType);
101 
103  itkGetConstReferenceMacro(Radius, InputImageSizeType);
104 
106  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
107  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
108 
109 #ifdef ITK_USE_CONCEPT_CHECKING
110  // Begin concept checking
111  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<InputImagePixelType>));
112  itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<OutputImagePixelType>));
116  // End concept checking
117 #endif
118 
119 protected:
121  ~NeighborhoodConnectedImageFilter() override = default;
122  std::vector<IndexType> m_Seeds;
123 
126 
128 
130 
131  // Override since the filter needs all the data for the algorithm
132  void
133  GenerateInputRequestedRegion() override;
134 
135  // Override since the filter produces the entire dataset
136  void
137  EnlargeOutputRequestedRegion(DataObject * output) override;
138 
139  void
140  GenerateData() override;
141 };
142 } // end namespace itk
143 
144 #ifndef ITK_MANUAL_INSTANTIATION
145 # include "itkNeighborhoodConnectedImageFilter.hxx"
146 #endif
147 
148 #endif
itk::Concept::OStreamWritable
Definition: itkConceptChecking.h:634
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::NeighborhoodConnectedImageFilter::InputImageSizeType
typename InputImageType::SizeType InputImageSizeType
Definition: itkNeighborhoodConnectedImageFilter.h:59
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::NeighborhoodConnectedImageFilter::m_ReplaceValue
OutputImagePixelType m_ReplaceValue
Definition: itkNeighborhoodConnectedImageFilter.h:127
itk::Concept::SameDimension
Definition: itkConceptChecking.h:692
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
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::NeighborhoodConnectedImageFilter::m_Seeds
std::vector< IndexType > m_Seeds
Definition: itkNeighborhoodConnectedImageFilter.h:122
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::NeighborhoodConnectedImageFilter::m_Radius
InputImageSizeType m_Radius
Definition: itkNeighborhoodConnectedImageFilter.h:129
itk::NeighborhoodConnectedImageFilter
Label pixels that are connected to a seed and lie within a neighborhood.
Definition: itkNeighborhoodConnectedImageFilter.h:37
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
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::NeighborhoodConnectedImageFilter::m_Upper
InputImagePixelType m_Upper
Definition: itkNeighborhoodConnectedImageFilter.h:125
itk::NeighborhoodConnectedImageFilter::m_Lower
InputImagePixelType m_Lower
Definition: itkNeighborhoodConnectedImageFilter.h:124
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::NeighborhoodConnectedImageFilter::IndexType
typename InputImageType::IndexType IndexType
Definition: itkNeighborhoodConnectedImageFilter.h:58
itk::Concept::EqualityComparable
Definition: itkConceptChecking.h:304
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293