ITK  6.0.0
Insight Toolkit
itkInterpolateImageFunction.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 itkInterpolateImageFunction_h
19#define itkInterpolateImageFunction_h
20
21#include "itkImageFunction.h"
22
23namespace itk
24{
44template <typename TInputImage, typename TCoordRep = double>
45class ITK_TEMPLATE_EXPORT InterpolateImageFunction
46 : public ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>
47{
48public:
49 ITK_DISALLOW_COPY_AND_MOVE(InterpolateImageFunction);
50
53 using Superclass =
55
58
60 itkOverrideGetNameOfClassMacro(InterpolateImageFunction);
61
63 using typename Superclass::OutputType;
64
66 using typename Superclass::InputImageType;
67
69 static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
70
72 using typename Superclass::PointType;
73
75 using typename Superclass::IndexType;
76 using typename Superclass::IndexValueType;
77
80
82 using typename Superclass::ContinuousIndexType;
83
86
96 Evaluate(const PointType & point) const override
97 {
98 const ContinuousIndexType index =
99 this->GetInputImage()->template TransformPhysicalPointToContinuousIndex<TCoordRep>(point);
100 return (this->EvaluateAtContinuousIndex(index));
101 }
114 OutputType
115 EvaluateAtContinuousIndex(const ContinuousIndexType & index) const override = 0;
116
126 EvaluateAtIndex(const IndexType & index) const override
127 {
128 return (static_cast<RealType>(this->GetInputImage()->GetPixel(index)));
129 }
130
136 virtual SizeType
137 GetRadius() const = 0;
138
139protected:
141 ~InterpolateImageFunction() override = default;
142 void
143 PrintSelf(std::ostream & os, Indent indent) const override
144 {
145 Superclass::PrintSelf(os, indent);
146 }
147};
148} // end namespace itk
149
150#endif
Evaluates a function of an image at specified position.
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Base class for all image interpolators.
OutputType EvaluateAtContinuousIndex(const ContinuousIndexType &index) const override=0
typename InputImageType::SizeType SizeType
virtual SizeType GetRadius() const =0
~InterpolateImageFunction() override=default
OutputType EvaluateAtIndex(const IndexType &index) const override
void PrintSelf(std::ostream &os, Indent indent) const override
typename NumericTraits< typename TInputImage::PixelType >::RealType RealType
OutputType Evaluate(const PointType &point) const override
Light weight base class for most itk classes.
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
long IndexValueType
Definition: itkIntTypes.h:93