pyvista.DataObjectFilters.slice_along_axis

DataObjectFilters.slice_along_axis(

n: int = 5,

axis: Literal['x', 'y', 'z', 0, 1, 2] = 'x',

tolerance: float | None = None,

generate_triangles: bool = False,

contour: bool = False,

bounds=None,

center=None,

progress_bar: bool = False,

)

Create many slices of the input dataset along a specified axis.

Parameters:

nint, default: 5

The number of slices to create.

axisstr | int, default: ‘x’

The axis to generate the slices along. Perpendicular to the slices. Can be string name ('x', 'y', or 'z') or axis index (0, 1, or 2).

tolerancefloat, optional

The tolerance to the edge of the dataset bounds to create the slices. The n slices are placed equidistantly with an absolute padding of tolerance inside each side of the bounds along the specified axis. Defaults to 1% of the bounds along the specified axis.

generate_trianglesbool, default: False

When True, the output will be triangles. Otherwise the output will be the intersection polygons.

contourbool, default: False

If True, apply a contour filter after slicing.

boundssequence[float], optional

A 6-length sequence overriding the bounds of the mesh. The bounds along the specified axis define the extent where slices are taken.

centersequence[float], optional

A 3-length sequence specifying the position of the line along which slices are taken. Defaults to the center of the mesh.

progress_barbool, default: False

Display a progress bar to indicate progress.

Returns:

pyvista.PolyData

Sliced dataset.

See also

slice

slice_implicit

slice_orthogonal

slice_along_line

slice_index()

Examples

Slice the random hills dataset in the X direction.

>>> from pyvista import examples
>>> hills = examples.load_random_hills()
>>> slices = hills.slice_along_axis(n=10)
>>> slices.plot(line_width=5)

Static Scene

Interactive Scene

Slice the random hills dataset in the Z direction.

>>> from pyvista import examples
>>> hills = examples.load_random_hills()
>>> slices = hills.slice_along_axis(n=10, axis='z')
>>> slices.plot(line_width=5)

Static Scene

Interactive Scene

See Slicing for more examples using this filter.