pyvista.Spline

Spline(

points: VectorLike[float] | MatrixLike[float],

n_points: int | None = None,

*,

closed: bool = False,

parametrize_by: _ParametrizeByOptions = 'length',

boundary_constraints: _BoundaryConstraintOptions | tuple[_BoundaryConstraintOptions, _BoundaryConstraintOptions] = 'clamped',

boundary_values: float | tuple[float | None, float | None] | None = None,

**kwargs,

) → PolyData

Create a spline from points.

Parameters:

pointsnumpy.ndarray

Array of points to build a spline out of. Array must be 3D and directionally ordered.

n_pointsint, optional

Number of points to interpolate along the points array. Defaults to points.shape[0].

closedbool, default: False

Close the spline if True (both ends are joined). Not closed by default.

parametrize_bystr, default: ‘length’

Parametrize spline by 'length' or by point 'index'.

boundary_constraintsstr | Sequence[str], optional, default: ‘clamped’

Derivative constraint type at both boundaries of the spline. Can be set by a single string or a sequence of length 2 (one for each left/right end). Each value must be one of:

• 'finite_difference': The first derivative at the left(right) most point is determined from the line defined from the first(last) two points.

• 'clamped': Default: the first derivative at the left(right) most point is set to Left(Right) boundary_values. (Default)

• 'second': The second derivative at the left(right) most point is set to Left(Right) boundary_values.

• 'scaled_second': The second derivative at left(right) most points is Left(Right) boundary_values times second derivative at first interior point.

boundary_valuesfloat | Sequence[float | None], optional

Values of derivative at both ends of the spline used by the boundary_constraints type. Can be set a single float, or a sequence of floats or None (one value for each left/right end). If a single value is provided, the same value is used for both ends. Value must be None for each end with boundary constraint type 'finite_difference'.

**kwargsdict, optional

See surface_from_para() for additional keyword arguments.

Returns:

pyvista.PolyData

Line mesh of spline.

See also

Creating a Spline

Label based on Distance on Line

Examples

Construct a spline.

>>> import numpy as np
>>> import pyvista as pv
>>> theta = np.linspace(-4 * np.pi, 4 * np.pi, 100)
>>> z = np.linspace(-2, 2, 100)
>>> r = z**2 + 1
>>> x = r * np.sin(theta)
>>> y = r * np.cos(theta)
>>> points = np.column_stack((x, y, z))
>>> spline = pv.Spline(points, 1000)
>>> spline.plot(
...     render_lines_as_tubes=True,
...     line_width=10,
...     show_scalar_bar=False,
... )

Static Scene

Interactive Scene