DataInterpolations.AkimaInterpolation
— TypeAkimaInterpolation(u, t; extrapolate = false, cache_parameters = false)
It is a spline interpolation built from cubic polynomials. It forms a continuously differentiable function. For more details, refer: https://en.wikipedia.org/wiki/Akima_spline. Extrapolation extends the last cubic polynomial on each side.
Arguments
u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.BSplineApprox
— TypeBSplineApprox(u, t, d, h, pVecType, knotVecType; extrapolate = false)
It is a regression based B-spline. The argument choices are the same as the BSplineInterpolation
, with the additional parameter h < length(t)
which is the number of control points to use, with smaller h
indicating more smoothing. For more information, refer http://www.cad.zju.edu.cn/home/zhx/GM/009/00-bsia.pdf. Extrapolation is a constant polynomial of the end points on each side.
Arguments
u
: data points.t
: time points.d
: degree of the piecewise polynomial.h
: number of control points to use.pVecType
: symbol to parameters vector,:Uniform
for uniform spaced parameters and:ArcLen
for parameters generated by chord length method.knotVecType
: symbol to knot vector,:Uniform
for uniform knot vector,:Average
for average spaced knot vector.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.BSplineInterpolation
— TypeBSplineInterpolation(u, t, d, pVecType, knotVecType; extrapolate = false, safetycopy = true)
It is a curve defined by the linear combination of n
basis functions of degree d
where n
is the number of data points. For more information, refer https://pages.mtu.edu/~shene/COURSES/cs3621/NOTES/spline/B-spline/bspline-curve.html. Extrapolation is a constant polynomial of the end points on each side.
Arguments
u
: data points.t
: time points.d
: degree of the piecewise polynomial.pVecType
: symbol to parameters vector,:Uniform
for uniform spaced parameters and:ArcLen
for parameters generated by chord length method.knotVecType
: symbol to knot vector,:Uniform
for uniform knot vector,:Average
for average spaced knot vector.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.ConstantInterpolation
— TypeConstantInterpolation(u, t; dir = :left, extrapolate = false, cache_parameters = false)
It is the method of interpolating using a constant polynomial. For any point, two adjacent data points are found on either side (left and right). The value at that point depends on dir
. If it is :left
, then the value at the left point is chosen and if it is :right
, the value at the right point is chosen. Extrapolation extends the last constant polynomial at the end points on each side.
Arguments
u
: data points.t
: time points.
Keyword Arguments
dir
: indicates which value should be used for interpolation (:left
or:right
).extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.ConstantInterpolationIntInv
— TypeConstantInterpolationIntInv(u, t, A)
It is the interpolation of the inverse of the integral of a ConstantInterpolation
. Can be easily constructed with invert_integral(A::ConstantInterpolation{<:AbstractVector{<:Number}})
Arguments
u
: Given byA.t
t
: Given byA.I
(the cumulative integral ofA
)A
: TheConstantInterpolation
object
DataInterpolations.CubicHermiteSpline
— TypeCubicHermiteSpline(du, u, t; extrapolate = false, cache_parameters = false)
It is a Cubic Hermite interpolation, which is a piece-wise third degree polynomial such that the value and the first derivative are equal to given values in the data points.
Arguments
du
: the derivative at the data points.u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.CubicSpline
— TypeCubicSpline(u, t; extrapolate = false, cache_parameters = false)
It is a spline interpolation using piecewise cubic polynomials between each pair of data points. Its first and second derivative is also continuous. Second derivative on both ends are zero, which are also called "natural" boundary conditions. Extrapolation extends the last cubic polynomial on each side.
Arguments
u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.LagrangeInterpolation
— TypeLagrangeInterpolation(u, t, n = length(t) - 1; extrapolate = false, safetycopy = true)
It is the method of interpolation using Lagrange polynomials of (k-1)th order passing through all the data points where k is the number of data points.
Arguments
u
: data points.t
: time points.n
: order of the polynomial. Currently only (k-1)th order where k is the number of data points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.
DataInterpolations.LinearInterpolation
— TypeLinearInterpolation(u, t; extrapolate = false, cache_parameters = false)
It is the method of interpolating between the data points using a linear polynomial. For any point, two data points one each side are chosen and connected with a line. Extrapolation extends the last linear polynomial on each side.
Arguments
u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.LinearInterpolationIntInv
— TypeLinearInterpolationIntInv(u, t, A)
It is the interpolation of the inverse of the integral of a LinearInterpolation
. Can be easily constructed with invert_integral(A::LinearInterpolation{<:AbstractVector{<:Number}})
Arguments
u
: Given byA.t
t
: Given byA.I
(the cumulative integral ofA
)A
: TheLinearInterpolation
object
DataInterpolations.QuadraticInterpolation
— TypeQuadraticInterpolation(u, t, mode = :Forward; extrapolate = false, cache_parameters = false)
It is the method of interpolating between the data points using quadratic polynomials. For any point, three data points nearby are taken to fit a quadratic polynomial. Extrapolation extends the last quadratic polynomial on each side.
Arguments
u
: data points.t
: time points.mode
::Forward
or:Backward
. If:Forward
, two data points ahead of the point and one data point behind is taken for interpolation. If:Backward
, two data points behind and one ahead is taken for interpolation.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.QuadraticSpline
— TypeQuadraticSpline(u, t; extrapolate = false, cache_parameters = false)
It is a spline interpolation using piecewise quadratic polynomials between each pair of data points. Its first derivative is also continuous. Extrapolation extends the last quadratic polynomial on each side.
Arguments
u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.QuinticHermiteSpline
— TypeQuinticHermiteSpline(ddu, du, u, t; extrapolate = false, safetycopy = true)
It is a Quintic Hermite interpolation, which is a piece-wise fifth degree polynomial such that the value and the first and second derivative are equal to given values in the data points.
Arguments
ddu
: the second derivative at the data points.du
: the derivative at the data points.u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.PCHIPInterpolation
— MethodPCHIPInterpolation(u, t; extrapolate = false, safetycopy = true)
It is a PCHIP Interpolation, which is a type of CubicHermiteSpline
where the derivative values du
are derived from the input data in such a way that the interpolation never overshoots the data. See here, section 3.4 for more details.
Arguments
u
: data points.t
: time points.
Keyword Arguments
extrapolate
: boolean value to allow extrapolation. Defaults tofalse
.cache_parameters
: precompute parameters at initialization for faster interpolation computations. Note: if activated,u
andt
should not be modified. Defaults tofalse
.assume_linear_t
: boolean value to specify a faster index lookup behaviour for evenly-distributed abscissae. Alternatively, a numerical threshold may be specified for a test based on the normalized standard deviation of the difference with respect to the straight line (seelooks_linear
). Defaults to 1e-2.
DataInterpolations.invert_integral
— Methodinvert_integral(A::AbstractInterpolation)::AbstractIntegralInverseInterpolation
Creates the inverted integral interpolation object from the given interpolation. Conditions:
- The range of
A
must be strictly positive A.u
must be a number type (on which an ordering is defined)- This is currently only supported for
ConstantInterpolation
andLinearInterpolation
Arguments
A
: interpolation object satisfying the above requirements
DataInterpolations.looks_linear
— Methodlooks_linear(t; threshold = 1e-2)
Determine if the abscissae t
are regularly distributed, taking the standard deviation of the difference between the array of abscissae with respect to the straight line linking its first and last elements, normalized by the range of t
. If this standard deviation is below the given threshold
, the vector looks linear (return true). Internal function - interface may change.