ITK  5.2.0
Insight Toolkit
itkBinaryShapeOpeningImageFilter.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 itkBinaryShapeOpeningImageFilter_h
19 #define itkBinaryShapeOpeningImageFilter_h
20 
21 #include "itkShapeLabelObject.h"
23 #include "itkShapeLabelMapFilter.h"
26 
27 namespace itk
28 {
47 template <typename TInputImage>
48 class ITK_TEMPLATE_EXPORT BinaryShapeOpeningImageFilter : public ImageToImageFilter<TInputImage, TInputImage>
49 {
50 public:
51  ITK_DISALLOW_COPY_AND_ASSIGN(BinaryShapeOpeningImageFilter);
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 
86 
88  itkNewMacro(Self);
89 
92 
99  itkSetMacro(FullyConnected, bool);
100  itkGetConstReferenceMacro(FullyConnected, bool);
101  itkBooleanMacro(FullyConnected);
103 
104 #ifdef ITK_USE_CONCEPT_CHECKING
105  // Begin concept checking
106  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<InputImagePixelType>));
109  // End concept checking
110 #endif
111 
116  itkSetMacro(BackgroundValue, OutputImagePixelType);
117  itkGetConstMacro(BackgroundValue, OutputImagePixelType);
119 
124  itkSetMacro(ForegroundValue, OutputImagePixelType);
125  itkGetConstMacro(ForegroundValue, OutputImagePixelType);
127 
131  itkGetConstMacro(Lambda, double);
132  itkSetMacro(Lambda, double);
134 
141  itkGetConstMacro(ReverseOrdering, bool);
142  itkSetMacro(ReverseOrdering, bool);
143  itkBooleanMacro(ReverseOrdering);
145 
150  itkGetConstMacro(Attribute, AttributeType);
151  itkSetMacro(Attribute, AttributeType);
152  void
153  SetAttribute(const std::string & s)
154  {
155  this->SetAttribute(LabelObjectType::GetAttributeFromName(s));
156  }
158 
159 protected:
161  ~BinaryShapeOpeningImageFilter() override = default;
162  void
163  PrintSelf(std::ostream & os, Indent indent) const override;
164 
167  void
168  GenerateInputRequestedRegion() override;
169 
171  void
172  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
173 
176  void
177  GenerateData() override;
178 
179 private:
183  double m_Lambda;
186 }; // end of class
187 } // end namespace itk
188 
189 #ifndef ITK_MANUAL_INSTANTIATION
190 # include "itkBinaryShapeOpeningImageFilter.hxx"
191 #endif
192 
193 #endif
itk::Concept::OStreamWritable
Definition: itkConceptChecking.h:634
itk::BinaryShapeOpeningImageFilter::InputImageType
TInputImage InputImageType
Definition: itkBinaryShapeOpeningImageFilter.h:60
itk::LabelMapToBinaryImageFilter
Convert a LabelMap to a binary image.
Definition: itkLabelMapToBinaryImageFilter.h:46
itk::BinaryShapeOpeningImageFilter::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkBinaryShapeOpeningImageFilter.h:69
itk::BinaryShapeOpeningImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkBinaryShapeOpeningImageFilter.h:63
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:54
itk::BinaryShapeOpeningImageFilter::SetAttribute
void SetAttribute(const std::string &s)
Definition: itkBinaryShapeOpeningImageFilter.h:153
itk::BinaryShapeOpeningImageFilter::m_ReverseOrdering
bool m_ReverseOrdering
Definition: itkBinaryShapeOpeningImageFilter.h:184
itkShapeOpeningLabelMapFilter.h
itk::BinaryShapeOpeningImageFilter::LabelType
SizeValueType LabelType
Definition: itkBinaryShapeOpeningImageFilter.h:76
itk::BinaryImageToLabelMapFilter
Label the connected components in a binary image and produce a collection of label objects.
Definition: itkBinaryImageToLabelMapFilter.h:56
itk::LabelMap
Templated n-dimensional image to store labeled objects.
Definition: itkLabelMap.h:71
itkShapeLabelMapFilter.h
itk::BinaryShapeOpeningImageFilter::m_Attribute
AttributeType m_Attribute
Definition: itkBinaryShapeOpeningImageFilter.h:185
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::BinaryShapeOpeningImageFilter::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkBinaryShapeOpeningImageFilter.h:68
itk::BinaryShapeOpeningImageFilter::m_FullyConnected
bool m_FullyConnected
Definition: itkBinaryShapeOpeningImageFilter.h:180
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::BinaryShapeOpeningImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkBinaryShapeOpeningImageFilter.h:67
itk::BinaryShapeOpeningImageFilter::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkBinaryShapeOpeningImageFilter.h:66
itk::BinaryShapeOpeningImageFilter::AttributeType
typename LabelObjectType::AttributeType AttributeType
Definition: itkBinaryShapeOpeningImageFilter.h:83
itk::BinaryShapeOpeningImageFilter
Remove objects based on the value of their shape attribute.
Definition: itkBinaryShapeOpeningImageFilter.h:48
itk::BinaryShapeOpeningImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkBinaryShapeOpeningImageFilter.h:64
itk::BinaryShapeOpeningImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkBinaryShapeOpeningImageFilter.h:65
itkLabelMapToBinaryImageFilter.h
itk::ShapeOpeningLabelMapFilter
Remove objects according to the value of their shape attribute.
Definition: itkShapeOpeningLabelMapFilter.h:50
itkBinaryImageToLabelMapFilter.h
itk::BinaryShapeOpeningImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkBinaryShapeOpeningImageFilter.h:62
itk::BinaryShapeOpeningImageFilter::m_BackgroundValue
OutputImagePixelType m_BackgroundValue
Definition: itkBinaryShapeOpeningImageFilter.h:181
itk::BinaryShapeOpeningImageFilter::m_ForegroundValue
OutputImagePixelType m_ForegroundValue
Definition: itkBinaryShapeOpeningImageFilter.h:182
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::BinaryShapeOpeningImageFilter::OutputImageType
TInputImage OutputImageType
Definition: itkBinaryShapeOpeningImageFilter.h:61
itk::BinaryShapeOpeningImageFilter::m_Lambda
double m_Lambda
Definition: itkBinaryShapeOpeningImageFilter.h:183
itk::ShapeLabelObject
A Label object to store the common attributes related to the shape of the object.
Definition: itkShapeLabelObject.h:44
itk::Concept::Convertible
Definition: itkConceptChecking.h:214
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::ShapeLabelObject::AttributeType
typename Superclass::AttributeType AttributeType
Definition: itkShapeLabelObject.h:75
itk::Concept::EqualityComparable
Definition: itkConceptChecking.h:304
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293