ITK  6.0.0
Insight Toolkit
itkLabelStatisticsKeepNObjectsImageFilter.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 * https://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 itkLabelStatisticsKeepNObjectsImageFilter_h
19#define itkLabelStatisticsKeepNObjectsImageFilter_h
20
25
26namespace itk
27{
45template <typename TInputImage, typename TFeatureImage>
46class ITK_TEMPLATE_EXPORT LabelStatisticsKeepNObjectsImageFilter : public ImageToImageFilter<TInputImage, TInputImage>
47{
48public:
49 ITK_DISALLOW_COPY_AND_MOVE(LabelStatisticsKeepNObjectsImageFilter);
50
56
58 using InputImageType = TInputImage;
59 using OutputImageType = TInputImage;
63 using InputImagePixelType = typename InputImageType::PixelType;
67 using OutputImagePixelType = typename OutputImageType::PixelType;
68
69 using FeatureImageType = TFeatureImage;
72 using FeatureImagePixelType = typename FeatureImageType::PixelType;
73
75 static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
76 static constexpr unsigned int OutputImageDimension = TInputImage::ImageDimension;
77 static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
78
86
88 itkNewMacro(Self);
89
91 itkOverrideGetNameOfClassMacro(LabelStatisticsKeepNObjectsImageFilter);
92
93#ifdef ITK_USE_CONCEPT_CHECKING
94 // Begin concept checking
98 // End concept checking
99#endif
100
105 itkSetMacro(BackgroundValue, OutputImagePixelType);
106 itkGetConstMacro(BackgroundValue, OutputImagePixelType);
112 itkGetConstMacro(NumberOfObjects, SizeValueType);
113 itkSetMacro(NumberOfObjects, SizeValueType);
121 itkGetConstMacro(ReverseOrdering, bool);
122 itkSetMacro(ReverseOrdering, bool);
123 itkBooleanMacro(ReverseOrdering);
130 itkGetConstMacro(Attribute, AttributeType);
131 itkSetMacro(Attribute, AttributeType);
132 void
133 SetAttribute(const std::string & s)
134 {
135 this->SetAttribute(LabelObjectType::GetAttributeFromName(s));
136 }
140 void
141 SetFeatureImage(const TFeatureImage * input)
142 {
143 // Process object is not const-correct so the const casting is required.
144 this->SetNthInput(1, const_cast<TFeatureImage *>(input));
145 }
146
148 const FeatureImageType *
150 {
151 return static_cast<const FeatureImageType *>(this->ProcessObject::GetInput(1));
152 }
153
155 void
157 {
158 this->SetInput(input);
159 }
160
162 void
164 {
165 this->SetFeatureImage(input);
166 }
167
168protected:
171 void
172 PrintSelf(std::ostream & os, Indent indent) const override;
173
177 void
179
181 void
182 EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
183
186 void
187 GenerateData() override;
188
189private:
190 OutputImagePixelType m_BackgroundValue{};
191 SizeValueType m_NumberOfObjects{};
192 bool m_ReverseOrdering{};
193 AttributeType m_Attribute{};
194}; // end of class
195} // end namespace itk
196
197#ifndef ITK_MANUAL_INSTANTIATION
198# include "itkLabelStatisticsKeepNObjectsImageFilter.hxx"
199#endif
200
201#endif
Base class for all data objects in ITK.
Base class for filters that take an image as input and produce an image as output.
Control indentation during Print() invocation.
Definition: itkIndent.h:50
convert a labeled image to a label collection image
Converts a LabelMap to a labeled image.
Templated n-dimensional image to store labeled objects.
Definition: itkLabelMap.h:71
unsigned int AttributeType
keep N objects according to their statistics attributes
void PrintSelf(std::ostream &os, Indent indent) const override
void EnlargeOutputRequestedRegion(DataObject *) override
~LabelStatisticsKeepNObjectsImageFilter() override=default
Light weight base class for most itk classes.
DataObject * GetInput(const DataObjectIdentifierType &key)
Return an input.
keep N objects according to their statistics attributes
The valuator class for the StatisticsLabelObject.
A Label object to store the common attributes related to the statistics of the object.
SmartPointer< const Self > ConstPointer
SmartPointer< Self > Pointer
#define itkConceptMacro(name, concept)
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
unsigned long SizeValueType
Definition: itkIntTypes.h:86