DataSet.find_cells_along_line

DataSet.find_cells_along_line(

pointa: VectorLike[float],

pointb: VectorLike[float],

tolerance: float | None = None,

) → NumpyArray[int]

Find the index of cells whose bounds intersect a line.

Line is defined from pointa to pointb.

Warning

This filter internally builds and caches a vtkStaticCellLocator. If the mesh’s geometry is modified, the cache will no longer be valid.

Parameters:

pointaVectorLike

Length 3 coordinate of the start of the line.

pointbVectorLike

Length 3 coordinate of the end of the line.

tolerancefloat, optional

The absolute tolerance to use to find cells along line. The default value is the epsilon (eps) of float32 dtype using numpy.finfo.

Returns:

numpy.ndarray

Index or indices of the cell(s) whose bounds intersect the line.

Warning

This method returns cells whose bounds intersect the line. This means that the line may not intersect the cell itself. To obtain cells that intersect the line, use pyvista.DataSet.find_cells_intersecting_line().

See also

DataSet.find_closest_point

DataSet.find_closest_cell

DataSet.find_containing_cell

DataSet.find_cells_within_bounds

DataSet.find_cells_intersecting_line

DataSet.intersect_with_line

PolyDataFilters.ray_trace

Examples

>>> import pyvista as pv
>>> mesh = pv.Sphere()
>>> cell_ids = mesh.find_cells_along_line([0.0, 0, 0], [1.0, 0, 0])
>>> sorted(cell_ids.tolist())
[86, 87, 1652, 1653]