ITK  6.0.0
Insight Toolkit
itkVectorMeanImageFunction.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 itkVectorMeanImageFunction_h
19#define itkVectorMeanImageFunction_h
20
21#include "itkImageFunction.h"
22#include "itkNumericTraits.h"
23
24namespace itk
25{
44template <typename TInputImage, typename TCoordRep = float>
45class ITK_TEMPLATE_EXPORT VectorMeanImageFunction
46 : public ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>
47{
48public:
49 ITK_DISALLOW_COPY_AND_MOVE(VectorMeanImageFunction);
50
53 using Superclass =
55
58
60 itkOverrideGetNameOfClassMacro(VectorMeanImageFunction);
61
63 itkNewMacro(Self);
64
66 using InputImageType = TInputImage;
67
69 using typename Superclass::OutputType;
70
72 using typename Superclass::IndexType;
73
75 using typename Superclass::ContinuousIndexType;
76
78 using typename Superclass::PointType;
79
81 static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
82
85
88 EvaluateAtIndex(const IndexType & index) const override;
89
92 Evaluate(const PointType & point) const override
93 {
94 IndexType index;
95
96 this->ConvertPointToNearestIndex(point, index);
97 return this->EvaluateAtIndex(index);
98 }
99
100 RealType
101 EvaluateAtContinuousIndex(const ContinuousIndexType & cindex) const override
102 {
103 IndexType index;
104
105 this->ConvertContinuousIndexToNearestIndex(cindex, index);
106 return this->EvaluateAtIndex(index);
107 }
108
111 itkSetMacro(NeighborhoodRadius, unsigned int);
112 itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
115protected:
117 ~VectorMeanImageFunction() override = default;
118 void
119 PrintSelf(std::ostream & os, Indent indent) const override;
120
121private:
122 unsigned int m_NeighborhoodRadius{};
123};
124} // end namespace itk
125
126#ifndef ITK_MANUAL_INSTANTIATION
127# include "itkVectorMeanImageFunction.hxx"
128#endif
129
130#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.
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:54
Calculate the mean value in the neighborhood of a pixel in a Vector image.
~VectorMeanImageFunction() override=default
typename NumericTraits< typename TInputImage::PixelType >::RealType RealType
RealType EvaluateAtContinuousIndex(const ContinuousIndexType &cindex) const override
void PrintSelf(std::ostream &os, Indent indent) const override
RealType EvaluateAtIndex(const IndexType &index) const override
RealType Evaluate(const PointType &point) const override
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