ITK  6.0.0
Insight Toolkit
itkBinaryThresholdImageFunction.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 itkBinaryThresholdImageFunction_h
19#define itkBinaryThresholdImageFunction_h
20
21#include "itkImageFunction.h"
22
23namespace itk
24{
43template <typename TInputImage, typename TCoordRep = float>
44class ITK_TEMPLATE_EXPORT BinaryThresholdImageFunction : public ImageFunction<TInputImage, bool, TCoordRep>
45{
46public:
47 ITK_DISALLOW_COPY_AND_MOVE(BinaryThresholdImageFunction);
48
54
56 itkOverrideGetNameOfClassMacro(BinaryThresholdImageFunction);
57
59 itkNewMacro(Self);
60
62 using typename Superclass::InputImageType;
63
65 using PixelType = typename TInputImage::PixelType;
66
68 static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
69
71 using typename Superclass::PointType;
72
74 using typename Superclass::IndexType;
75
77 using typename Superclass::ContinuousIndexType;
78
88 bool
89 Evaluate(const PointType & point) const override
90 {
91 IndexType index;
92
93 this->ConvertPointToNearestIndex(point, index);
94 return (this->EvaluateAtIndex(index));
95 }
96
105 bool
106 EvaluateAtContinuousIndex(const ContinuousIndexType & index) const override
107 {
108 IndexType nindex;
109
110 this->ConvertContinuousIndexToNearestIndex(index, nindex);
111 return this->EvaluateAtIndex(nindex);
112 }
113
122 bool
123 EvaluateAtIndex(const IndexType & index) const override
124 {
125 PixelType value = this->GetInputImage()->GetPixel(index);
126
127 return (m_Lower <= value && value <= m_Upper);
128 }
129
131 itkGetConstReferenceMacro(Lower, PixelType);
132
134 itkGetConstReferenceMacro(Upper, PixelType);
135
137 void
139
141 void
143
145 void
147
148protected:
150 ~BinaryThresholdImageFunction() override = default;
151 void
152 PrintSelf(std::ostream & os, Indent indent) const override;
153
154private:
155 PixelType m_Lower{};
156 PixelType m_Upper{};
157};
158} // end namespace itk
159
160#ifndef ITK_MANUAL_INSTANTIATION
161# include "itkBinaryThresholdImageFunction.hxx"
162#endif
163
164#endif
Returns true is the value of an image lies within a range of thresholds This ImageFunction returns tr...
void ThresholdBetween(PixelType lower, PixelType upper)
~BinaryThresholdImageFunction() override=default
bool EvaluateAtIndex(const IndexType &index) const override
void PrintSelf(std::ostream &os, Indent indent) const override
bool Evaluate(const PointType &point) const override
void ThresholdAbove(PixelType thresh)
bool EvaluateAtContinuousIndex(const ContinuousIndexType &index) const override
void ThresholdBelow(PixelType thresh)
Evaluates a function of an image at specified position.
typename InputImageType::IndexType IndexType
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Light weight base class for most itk classes.
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:54
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
*par Constraints *The filter image with at least two dimensions and a vector *length of at least The theory supports extension to scalar but *the implementation of the itk vector classes do not **The template parameter TRealType must be floating point(float or double) or *a user-defined "real" numerical type with arithmetic operations defined *sufficient to compute derivatives. **\par Performance *This filter will automatically multithread if run with *SetUsePrincipleComponents