ITK  5.2.0
Insight Toolkit
itkBinaryShapeKeepNObjectsImageFilter.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 itkBinaryShapeKeepNObjectsImageFilter_h
19 #define itkBinaryShapeKeepNObjectsImageFilter_h
20 
21 #include "itkShapeLabelObject.h"
23 #include "itkShapeLabelMapFilter.h"
26 
27 namespace itk
28 {
46 template <typename TInputImage>
47 class ITK_TEMPLATE_EXPORT BinaryShapeKeepNObjectsImageFilter : public ImageToImageFilter<TInputImage, TInputImage>
48 {
49 public:
50  ITK_DISALLOW_COPY_AND_MOVE(BinaryShapeKeepNObjectsImageFilter);
51 
57 
59  using InputImageType = TInputImage;
60  using OutputImageType = TInputImage;
61  using InputImagePointer = typename InputImageType::Pointer;
62  using InputImageConstPointer = typename InputImageType::ConstPointer;
64  using InputImagePixelType = typename InputImageType::PixelType;
65  using OutputImagePointer = typename OutputImageType::Pointer;
66  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
68  using OutputImagePixelType = typename OutputImageType::PixelType;
69 
71  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
72  static constexpr unsigned int OutputImageDimension = TInputImage::ImageDimension;
73  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
74 
76 
85 
87  itkNewMacro(Self);
88 
91 
98  itkSetMacro(FullyConnected, bool);
99  itkGetConstReferenceMacro(FullyConnected, bool);
100  itkBooleanMacro(FullyConnected);
102 
103 #ifdef ITK_USE_CONCEPT_CHECKING
104  // Begin concept checking
105  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<InputImagePixelType>));
108  // End concept checking
109 #endif
110 
115  itkSetMacro(BackgroundValue, OutputImagePixelType);
116  itkGetConstMacro(BackgroundValue, OutputImagePixelType);
118 
123  itkSetMacro(ForegroundValue, OutputImagePixelType);
124  itkGetConstMacro(ForegroundValue, OutputImagePixelType);
126 
130  itkGetConstMacro(NumberOfObjects, SizeValueType);
131  itkSetMacro(NumberOfObjects, SizeValueType);
133 
139  itkGetConstMacro(ReverseOrdering, bool);
140  itkSetMacro(ReverseOrdering, bool);
141  itkBooleanMacro(ReverseOrdering);
143 
148  itkGetConstMacro(Attribute, AttributeType);
149  itkSetMacro(Attribute, AttributeType);
150  void
151  SetAttribute(const std::string & s)
152  {
153  this->SetAttribute(LabelObjectType::GetAttributeFromName(s));
154  }
156 
157 protected:
159  ~BinaryShapeKeepNObjectsImageFilter() override = default;
160  void
161  PrintSelf(std::ostream & os, Indent indent) const override;
162 
166  void
167  GenerateInputRequestedRegion() override;
168 
170  void
171  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
172 
175  void
176  GenerateData() override;
177 
178 private:
179  bool m_FullyConnected{ false };
182  SizeValueType m_NumberOfObjects{ 0 };
183  bool m_ReverseOrdering{ false };
185 }; // end of class
186 } // end namespace itk
187 
188 #ifndef ITK_MANUAL_INSTANTIATION
189 # include "itkBinaryShapeKeepNObjectsImageFilter.hxx"
190 #endif
191 
192 #endif
itk::BinaryShapeKeepNObjectsImageFilter
keep N objects according to their shape attributes
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:47
itk::BinaryShapeKeepNObjectsImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:66
itk::Concept::OStreamWritable
Definition: itkConceptChecking.h:636
itk::BinaryShapeKeepNObjectsImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:61
itk::LabelMapToBinaryImageFilter
Convert a LabelMap to a binary image.
Definition: itkLabelMapToBinaryImageFilter.h:45
itk::BinaryShapeKeepNObjectsImageFilter::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:68
itk::ShapeKeepNObjectsLabelMapFilter
Keep N objects according to their shape attributes.
Definition: itkShapeKeepNObjectsLabelMapFilter.h:44
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ShapeLabelMapFilter
The valuator class for the ShapeLabelObject.
Definition: itkShapeLabelMapFilter.h:53
itk::BinaryShapeKeepNObjectsImageFilter::m_ForegroundValue
OutputImagePixelType m_ForegroundValue
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:181
itk::BinaryImageToLabelMapFilter
Label the connected components in a binary image and produce a collection of label objects.
Definition: itkBinaryImageToLabelMapFilter.h:55
itk::LabelMap
Templated n-dimensional image to store labeled objects.
Definition: itkLabelMap.h:70
itkShapeLabelMapFilter.h
itk::BinaryShapeKeepNObjectsImageFilter::OutputImageType
TInputImage OutputImageType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:60
itkShapeLabelObject.h
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::BinaryShapeKeepNObjectsImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:62
itkShapeKeepNObjectsLabelMapFilter.h
itkLabelMapToBinaryImageFilter.h
itkBinaryImageToLabelMapFilter.h
itk::BinaryShapeKeepNObjectsImageFilter::SetAttribute
void SetAttribute(const std::string &s)
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:151
itk::BinaryShapeKeepNObjectsImageFilter::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:65
itk::BinaryShapeKeepNObjectsImageFilter::m_BackgroundValue
OutputImagePixelType m_BackgroundValue
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:180
itk::BinaryShapeKeepNObjectsImageFilter::InputImageType
TInputImage InputImageType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:59
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::ShapeLabelObject
A Label object to store the common attributes related to the shape of the object.
Definition: itkShapeLabelObject.h:43
itk::BinaryShapeKeepNObjectsImageFilter::m_Attribute
AttributeType m_Attribute
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:184
itk::Concept::Convertible
Definition: itkConceptChecking.h:216
itk::BinaryShapeKeepNObjectsImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:64
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::ShapeLabelObject::AttributeType
typename Superclass::AttributeType AttributeType
Definition: itkShapeLabelObject.h:74
itk::BinaryShapeKeepNObjectsImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:63
itk::BinaryShapeKeepNObjectsImageFilter::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:67
itk::BinaryShapeKeepNObjectsImageFilter::LabelType
SizeValueType LabelType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:75
itk::Concept::EqualityComparable
Definition: itkConceptChecking.h:306
itk::BinaryShapeKeepNObjectsImageFilter::AttributeType
typename LabelObjectType::AttributeType AttributeType
Definition: itkBinaryShapeKeepNObjectsImageFilter.h:82
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293