bundles / scipy latest / scipy / interpolate / _fitpack_repro / make_splprep

function

`scipy.interpolate._fitpack_repro:make_splprep`

source: /scipy/interpolate/_fitpack_repro.py :1168

Signature

   def     make_splprep (    x    ,  * ,     w    =  None   ,    u    =  None   ,    ub    =  None   ,    ue    =  None   ,    k    =  3   ,    s    =  0   ,    t    =  None   ,    nest    =  None   ,    bc_type    =  None     )

Summary

Create a smoothing parametric B-spline curve with bounded error, minimizing derivative jumps.

Extended Summary

Given a list of N 1D arrays, x, which represent a curve in N-dimensional space parametrized by u, find a smooth approximating spline curve g(u).

Parameters

x : array_like, shape (ndim, m)

Sampled data points representing the curve in ndim dimensions. The typical use is a list of 1D arrays, each of length m.

w : array_like, shape(m,), optional

Strictly positive 1D array of weights. The weights are used in computing the weighted least-squares spline fit. If the errors in the x values have standard deviation given by the vector d, then w should be 1/d. Default is np.ones(m).

u : array_like, optional

An array of parameter values for the curve in the parametric form. If not given, these values are calculated automatically, according to

v[0] = 0
v[i] = v[i-1] + distance(x[i], x[i-1])
u[i] = v[i] / v[-1]

ub, ue : float, optional

The end-points of the parameters interval. Default to u[0] and u[-1].

k : int, optional

Degree of the spline. Cubic splines, k=3, are recommended. Even values of k should be avoided especially with a small s value. Default is k=3

s : float, optional

A smoothing condition. The amount of smoothness is determined by satisfying the conditions

sum((w * (g(u) - x))**2) <= s,

where g(u) is the smoothed approximation to x. The user can use s to control the trade-off between closeness and smoothness of fit. Larger s means more smoothing while smaller values of s indicate less smoothing. Recommended values of s depend on the weights, w. If the weights represent the inverse of the standard deviation of x, then a good s value should be found in the range (m - sqrt(2*m), m + sqrt(2*m)), where m is the number of data points in x and w.

t : array_like, optional

The spline knots. If None (default), the knots will be constructed automatically. There must be at least 2*k + 2 and at most m + k + 1 knots.

nest : int, optional

The target length of the knot vector. Should be between 2*(k + 1) (the minimum number of knots for a degree-k spline), and m + k + 1 (the number of knots of the interpolating spline). The actual number of knots returned by this routine may be slightly larger than nest. Default is None (no limit, add up to m + k + 1 knots).

bc_type : str, optional

Boundary conditions. Default is "not-a-knot". The following boundary conditions are recognized:

"not-a-knot" (default): The first and second segments are the same polynomial. This is equivalent to having bc_type=None.
"periodic": The values and the first k-1 derivatives at the ends are equivalent.

Returns

spl : a `BSpline` instance: For s=0, spl(u) == x. For non-zero values of s, spl represents the smoothed approximation to x, generally with fewer knots.
u : ndarray: The values of the parameters

Notes

Given a set of $m$ data points in $D$ dimensions, $x_{j}$ , with $j = 1, ..., m$ and $x_{j} = (x_{j; 1}, ..., x_{j; D})$ , this routine constructs the parametric spline curve $g_{a} (u)$ with $a = 1, ..., D$ , to minimize the sum of jumps, $D_{i; a}$ , of the k-th derivative at the internal knots ( $u_{b} < t_{i} < u_{e}$ ), where

D_{i; a} = g_{a}^{(k)} (t_{i} + 0) - g_{a}^{(k)} (t_{i} - 0)

Specifically, the routine constructs the spline function $g (u)$ which minimizes

i \sum a = 1 \sum D ∣ D_{i; a} ∣^{2} \to min

provided that

j = 1 \sum m a = 1 \sum D (w_{j} \times (g_{a} (u_{j}) - x_{j; a}))^{2} ⩽ s

where $u_{j}$ is the value of the parameter corresponding to the data point $(x_{j; 1}, ..., x_{j; D})$ , and $s > 0$ is the input parameter.

In other words, we balance maximizing the smoothness (measured as the jumps of the derivative, the first criterion), and the deviation of $g (u_{j})$ from the data $x_{j}$ (the second criterion).

Note that the summation in the second criterion is over all data points, and in the first criterion it is over the internal spline knots (i.e. those with ub < t[i] < ue). The spline knots are in general a subset of data, see generate_knots for details.

Array API Standard Support

make_splprep has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable SCIPY_ARRAY_API=1 and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

====================  ====================  ====================
Library               CPU                   GPU
====================  ====================  ====================
NumPy                 ✅                     n/a                 
CuPy                  n/a                   ⛔                   
PyTorch               ✅                     ⛔                   
JAX                   ⚠️ no JIT             ⛔                   
Dask                  ⚠️ computes graph     n/a                 
====================  ====================  ====================

See dev-arrayapi for more information.

Aliases

scipy.interpolate.make_splprep