ITK  6.0.0
Insight Toolkit
itkCovarianceImageFunction.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 itkCovarianceImageFunction_h
19#define itkCovarianceImageFunction_h
20
21#include "itkImageFunction.h"
22#include "itkNumericTraits.h"
23
24namespace itk
25{
44template <typename TInputImage, typename TCoordRep = float>
45class ITK_TEMPLATE_EXPORT CovarianceImageFunction
46 : public ImageFunction<TInputImage,
47 vnl_matrix<typename NumericTraits<typename TInputImage::PixelType::ValueType>::RealType>,
48 TCoordRep>
49{
50public:
51 ITK_DISALLOW_COPY_AND_MOVE(CovarianceImageFunction);
52
55 using Superclass =
56 ImageFunction<TInputImage,
57 vnl_matrix<typename NumericTraits<typename TInputImage::PixelType::ValueType>::RealType>,
58 TCoordRep>;
59
62
64 itkOverrideGetNameOfClassMacro(CovarianceImageFunction);
65
67 itkNewMacro(Self);
68
70 using InputImageType = TInputImage;
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
85 static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
86
88 using RealType = vnl_matrix<typename NumericTraits<typename InputImageType::PixelType::ValueType>::RealType>;
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 RealType
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 itkSetMacro(NeighborhoodRadius, unsigned int);
116 itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
119protected:
121 ~CovarianceImageFunction() override = default;
122 void
123 PrintSelf(std::ostream & os, Indent indent) const override;
124
125private:
126 unsigned int m_NeighborhoodRadius{ 1 };
127};
128} // end namespace itk
129
130#ifndef ITK_MANUAL_INSTANTIATION
131# include "itkCovarianceImageFunction.hxx"
132#endif
133
134#endif
Calculate the covariance matrix in the neighborhood of a pixel in a Vector image.
~CovarianceImageFunction() override=default
void PrintSelf(std::ostream &os, Indent indent) const override
RealType EvaluateAtContinuousIndex(const ContinuousIndexType &cindex) const override
RealType Evaluate(const PointType &point) const override
RealType EvaluateAtIndex(const IndexType &index) const override
vnl_matrix< typename NumericTraits< typename InputImageType::PixelType::ValueType >::RealType > RealType
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
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