1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkSpatialFunction_h
#define itkSpatialFunction_h
#include "itkFunctionBase.h"
#include "itkPoint.h"
namespace itk
{
/** \class SpatialFunction
* \brief N-dimensional spatial function class
*
* itk::SpatialFunction provides the ability to define functions that can
* be evaluated at an arbitrary point in space (physical or otherwise). The return
* type is specified by the derived class, and the input to the function
* is an n-dimensional itk::Point.
*
* Although itk::ImageFunction and itk::SpatialFunction are quite similar,
* itk::SpatialFunction derived classes exist without reference to an Image
* type.
*
* SpatialFunction is templated over output type (the data type
* returned by an evaluate() call) and dimensionality.
*
* \ingroup SpatialFunctions
* \ingroup ITKCommon
*/
template <typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
class ITK_TEMPLATE_EXPORT SpatialFunction : public FunctionBase<TInput, TOutput>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SpatialFunction);
/** Standard class type aliases. */
using Self = SpatialFunction;
using Superclass = FunctionBase<TInput, TOutput>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(SpatialFunction);
/** Input type for the function. */
using typename Superclass::InputType;
/** Output type for the function. */
using typename Superclass::OutputType;
/** Spatial dimension. */
static constexpr unsigned int ImageDimension = VImageDimension;
/** Evaluate the function at a given position. Remember, position is
* represented by an n-d itk::Point object with data type double. */
OutputType
Evaluate(const InputType & input) const override = 0;
protected:
SpatialFunction() = default;
~SpatialFunction() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkSpatialFunction.hxx"
#endif
#endif
|
