ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkBinaryShapeKeepNObjectsImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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:
48  public ImageToImageFilter< TInputImage, TInputImage >
49 {
50 public:
51  ITK_DISALLOW_COPY_AND_ASSIGN(BinaryShapeKeepNObjectsImageFilter);
52 
58 
60  using InputImageType = TInputImage;
61  using OutputImageType = TInputImage;
62  using InputImagePointer = typename InputImageType::Pointer;
63  using InputImageConstPointer = typename InputImageType::ConstPointer;
65  using InputImagePixelType = typename InputImageType::PixelType;
66  using OutputImagePointer = typename OutputImageType::Pointer;
67  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
69  using OutputImagePixelType = typename OutputImageType::PixelType;
70 
72  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
73  static constexpr unsigned int OutputImageDimension = TInputImage::ImageDimension;
74  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
75 
77 
87 
89  itkNewMacro(Self);
90 
94 
101  itkSetMacro(FullyConnected, bool);
102  itkGetConstReferenceMacro(FullyConnected, bool);
103  itkBooleanMacro(FullyConnected);
105 
106 #ifdef ITK_USE_CONCEPT_CHECKING
107  // Begin concept checking
108  itkConceptMacro( InputEqualityComparableCheck,
110  itkConceptMacro( IntConvertibleToInputCheck,
112  itkConceptMacro( InputOStreamWritableCheck,
114  // End concept checking
115 #endif
116 
121  itkSetMacro(BackgroundValue, OutputImagePixelType);
122  itkGetConstMacro(BackgroundValue, OutputImagePixelType);
124 
129  itkSetMacro(ForegroundValue, OutputImagePixelType);
130  itkGetConstMacro(ForegroundValue, OutputImagePixelType);
132 
136  itkGetConstMacro(NumberOfObjects, SizeValueType);
137  itkSetMacro(NumberOfObjects, SizeValueType);
139 
145  itkGetConstMacro(ReverseOrdering, bool);
146  itkSetMacro(ReverseOrdering, bool);
147  itkBooleanMacro(ReverseOrdering);
149 
154  itkGetConstMacro(Attribute, AttributeType);
155  itkSetMacro(Attribute, AttributeType);
156  void SetAttribute(const std::string & s)
157  {
158  this->SetAttribute( LabelObjectType::GetAttributeFromName(s) );
159  }
161 
162 protected:
164  ~BinaryShapeKeepNObjectsImageFilter() override = default;
165  void PrintSelf(std::ostream & os, Indent indent) const override;
166 
170  void GenerateInputRequestedRegion() override;
171 
173  void EnlargeOutputRequestedRegion( DataObject *itkNotUsed(output) ) override;
174 
177  void GenerateData() override;
178 
179 private:
180  bool m_FullyConnected{false};
183  SizeValueType m_NumberOfObjects{0};
184  bool m_ReverseOrdering{false};
186 }; // end of class
187 } // end namespace itk
188 
189 #ifndef ITK_MANUAL_INSTANTIATION
190 #include "itkBinaryShapeKeepNObjectsImageFilter.hxx"
191 #endif
192 
193 #endif
Light weight base class for most itk classes.
typename LabelObjectType::AttributeType AttributeType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
typename InputImageType::ConstPointer InputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
A Label object to store the common attributes related to the shape of the object. ...
Keep N objects according to their shape attributes.
Label the connected components in a binary image and produce a collection of label objects...
Base class for filters that take an image as input and produce an image as output.
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Templated n-dimensional image to store labeled objects.
Definition: itkLabelMap.h:70
#define itkConceptMacro(name, concept)
keep N objects according to their shape attributes
The valuator class for the ShapeLabelObject.
typename Superclass::AttributeType AttributeType
Base class for all data objects in ITK.
Templated n-dimensional image class.
Definition: itkImage.h:75
typename OutputImageType::RegionType OutputImageRegionType
Convert a LabelMap to a binary image.