ITK  6.0.0
Insight Toolkit
itkMedianImageFunction.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 itkMedianImageFunction_h
19#define itkMedianImageFunction_h
20
21#include "itkImageFunction.h"
23#include "itkNumericTraits.h"
24#include "itkOffset.h"
25
26namespace itk
27{
48template <typename TInputImage, typename TCoordRep = float>
49class ITK_TEMPLATE_EXPORT MedianImageFunction
50 : public ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordRep>
51{
52public:
53 ITK_DISALLOW_COPY_AND_MOVE(MedianImageFunction);
54
58
61
63 itkOverrideGetNameOfClassMacro(MedianImageFunction);
64
66 itkNewMacro(Self);
67
69 using InputImageType = TInputImage;
70 using typename Superclass::InputPixelType;
71
73 using typename Superclass::OutputType;
74
76 using typename Superclass::IndexType;
77
79 using typename Superclass::ContinuousIndexType;
80
82 using typename Superclass::PointType;
83
86
88 static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
89
92 EvaluateAtIndex(const IndexType & index) const override;
93
96 Evaluate(const PointType & point) const override
97 {
98 IndexType index;
99
100 this->ConvertPointToNearestIndex(point, index);
101 return this->EvaluateAtIndex(index);
102 }
103
104 OutputType
105 EvaluateAtContinuousIndex(const ContinuousIndexType & cindex) const override
106 {
107 IndexType index;
108
109 this->ConvertContinuousIndexToNearestIndex(cindex, index);
110 return this->EvaluateAtIndex(index);
111 }
112
115 void
117 itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
120protected:
122 ~MedianImageFunction() override = default;
123 void
124 PrintSelf(std::ostream & os, Indent indent) const override;
125
126private:
127 unsigned int m_NeighborhoodRadius{ 1 };
128
129 std::vector<Offset<ImageDimension>> m_NeighborhoodOffsets{ GenerateRectangularImageNeighborhoodOffsets(
130 ImageSizeType::Filled(1)) };
131};
132} // end namespace itk
133
134#ifndef ITK_MANUAL_INSTANTIATION
135# include "itkMedianImageFunction.hxx"
136#endif
137
138#endif
Evaluates a function of an image at specified position.
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Light weight base class for most itk classes.
Calculate the median value in the neighborhood of a pixel.
~MedianImageFunction() override=default
OutputType EvaluateAtContinuousIndex(const ContinuousIndexType &cindex) const override
OutputType EvaluateAtIndex(const IndexType &index) const override
typename InputImageType::SizeType ImageSizeType
void SetNeighborhoodRadius(unsigned int)
OutputType Evaluate(const PointType &point) const override
void PrintSelf(std::ostream &os, Indent indent) const override
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....
std::vector< Offset< VImageDimension > > GenerateRectangularImageNeighborhoodOffsets(const Size< VImageDimension > &radius)
*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