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
|
/*=========================================================================
*
* 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 itkForwardDifferenceOperator_h
#define itkForwardDifferenceOperator_h
#include "itkNeighborhoodOperator.h"
namespace itk
{
/**
* \class ForwardDifferenceOperator
* \brief Operator whose inner product with a neighborhood returns
* a "half" derivative at the center of the neighborhood.
*
* ForwardDifferenceOperator uses forward differences
* i.e. F(x+1) - F(x) to calculate a "half" derivative useful, among
* other things, in solving differential equations. It is a directional
* NeighborhoodOperator that should be applied to a Neighborhood using the
* inner product.
*
* \note ForwardDifferenceOperator does not have any user-declared "special member function",
* following the C++ Rule of Zero: the compiler will generate them if necessary.
*
* \ingroup Operators
* \ingroup ITKCommon
*
* \sphinx
* \sphinxexample{Core/Common/CreateForwardDifferenceKernel,Create Forward Difference Kernel}
* \endsphinx
*/
template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT ForwardDifferenceOperator : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
{
public:
/** Standard class type aliases. */
using Self = ForwardDifferenceOperator;
using Superclass = NeighborhoodOperator<TPixel, VDimension, TAllocator>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ForwardDifferenceOperator);
/** Type alias support for pixel type. */
using PixelType = TPixel;
protected:
/** Type alias support for coefficient vector type.*/
using typename Superclass::CoefficientVector;
/** Calculates operator coefficients. */
CoefficientVector
GenerateCoefficients() override;
/** Arranges coefficients spatially in the memory buffer. */
void
Fill(const CoefficientVector & coeff) override
{
this->FillCenteredDirectional(coeff);
}
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkForwardDifferenceOperator.hxx"
#endif
#endif
|
