ITK  4.13.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:
56 
58  typedef TInputImage InputImageType;
59  typedef TInputImage OutputImageType;
60  typedef typename InputImageType::Pointer InputImagePointer;
61  typedef typename InputImageType::ConstPointer InputImageConstPointer;
62  typedef typename InputImageType::RegionType InputImageRegionType;
63  typedef typename InputImageType::PixelType InputImagePixelType;
64  typedef typename OutputImageType::Pointer OutputImagePointer;
65  typedef typename OutputImageType::ConstPointer OutputImageConstPointer;
66  typedef typename OutputImageType::RegionType OutputImageRegionType;
67  typedef typename OutputImageType::PixelType OutputImagePixelType;
68 
70  itkStaticConstMacro(InputImageDimension, unsigned int,
71  TInputImage::ImageDimension);
72  itkStaticConstMacro(OutputImageDimension, unsigned int,
73  TInputImage::ImageDimension);
74  itkStaticConstMacro(ImageDimension, unsigned int,
75  TInputImage::ImageDimension);
77 
79 
89 
91  itkNewMacro(Self);
92 
96 
103  itkSetMacro(FullyConnected, bool);
104  itkGetConstReferenceMacro(FullyConnected, bool);
105  itkBooleanMacro(FullyConnected);
107 
108 #ifdef ITK_USE_CONCEPT_CHECKING
109  // Begin concept checking
110  itkConceptMacro( InputEqualityComparableCheck,
112  itkConceptMacro( IntConvertibleToInputCheck,
114  itkConceptMacro( InputOStreamWritableCheck,
116  // End concept checking
117 #endif
118 
123  itkSetMacro(BackgroundValue, OutputImagePixelType);
124  itkGetConstMacro(BackgroundValue, OutputImagePixelType);
126 
131  itkSetMacro(ForegroundValue, OutputImagePixelType);
132  itkGetConstMacro(ForegroundValue, OutputImagePixelType);
134 
138  itkGetConstMacro(NumberOfObjects, SizeValueType);
139  itkSetMacro(NumberOfObjects, SizeValueType);
141 
147  itkGetConstMacro(ReverseOrdering, bool);
148  itkSetMacro(ReverseOrdering, bool);
149  itkBooleanMacro(ReverseOrdering);
151 
156  itkGetConstMacro(Attribute, AttributeType);
157  itkSetMacro(Attribute, AttributeType);
158  void SetAttribute(const std::string & s)
159  {
160  this->SetAttribute( LabelObjectType::GetAttributeFromName(s) );
161  }
163 
164 protected:
167  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
168 
172  void GenerateInputRequestedRegion() ITK_OVERRIDE;
173 
175  void EnlargeOutputRequestedRegion( DataObject *itkNotUsed(output) ) ITK_OVERRIDE;
176 
179  void GenerateData() ITK_OVERRIDE;
180 
181 private:
182  ITK_DISALLOW_COPY_AND_ASSIGN(BinaryShapeKeepNObjectsImageFilter);
183 
184  bool m_FullyConnected;
185  OutputImagePixelType m_BackgroundValue;
186  OutputImagePixelType m_ForegroundValue;
187  SizeValueType m_NumberOfObjects;
188  bool m_ReverseOrdering;
189  AttributeType m_Attribute;
190 }; // end of class
191 } // end namespace itk
192 
193 #ifndef ITK_MANUAL_INSTANTIATION
194 #include "itkBinaryShapeKeepNObjectsImageFilter.hxx"
195 #endif
196 
197 #endif
Light weight base class for most itk classes.
BinaryImageToLabelMapFilter< InputImageType, LabelMapType > LabelizerType
ShapeKeepNObjectsLabelMapFilter< LabelMapType > KeepNObjectsType
ShapeLabelMapFilter< LabelMapType, ShapeLabelFilterOutput > LabelObjectValuatorType
unsigned long SizeValueType
Definition: itkIntTypes.h:143
ImageToImageFilter< TInputImage, TInputImage > Superclass
ShapeLabelObject< LabelType, itkGetStaticConstMacro(ImageDimension) > LabelObjectType
Superclass::AttributeType AttributeType
A Label object to store the common attributes related to the shape of the object. ...
LabelMapToBinaryImageFilter< LabelMapType, OutputImageType > BinarizerType
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.
Base class for all data objects in ITK.
Templated n-dimensional image class.
Definition: itkImage.h:75
Convert a LabelMap to a binary image.
Image< typename OutputImageType::PixelType, itkGetStaticConstMacro(OutputImageDimension) > ShapeLabelFilterOutput