pyvista.DataSetFilters.extract_points#

DataSetFilters.extract_points(ind, adjacent_cells=True, include_cells=True, progress_bar=False)[source]#

Return a subset of the grid (with cells) that contains any of the given point indices.

Parameters:
indsequence[int]

Sequence of point indices to be extracted.

adjacent_cellsbool, default: True

If True, extract the cells that contain at least one of the extracted points. If False, extract the cells that contain exclusively points from the extracted points list.

include_cellsbool, default: True

Specifies if the cells shall be returned or not.

progress_barbool, default: False

Display a progress bar to indicate progress.

Returns:
pyvista.UnstructuredGrid

Subselected grid.

Examples

Extract all the points of a sphere with a Z coordinate greater than 0

>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> extracted = sphere.extract_points(
...     sphere.points[:, 2] > 0, include_cells=False
... )
>>> extracted.clear_data()  # clear for plotting
>>> extracted.plot()
../../../_images/pyvista-DataSetFilters-extract_points-1_00_00.png