DataObjectFilters.extract_all_edges

DataObjectFilters.extract_all_edges#

DataObjectFilters.extract_all_edges(
*,
use_all_points: bool | None = None,
clear_data: bool = False,
progress_bar: bool = False,
) → PolyData | MultiBlock[source]#

Extract all the internal/external edges of the dataset as PolyData.

This produces a full wireframe representation of the input dataset.

Parameters:
use_all_pointsbool, optional

Deprecated since version 0.44.0: Parameter use_all_points is deprecated since VTK < 9.2 is no longer supported. This parameter has no effect and is always True.

clear_databool, default: False

Clear any point, cell, or field data. This is useful if wanting to strictly extract the edges.

progress_barbool, default: False

Display a progress bar to indicate progress.

Returns:
pyvista.PolyData | pyvista.MultiBlock

Edges extracted from the dataset. Every dataset gives a PolyData, and a MultiBlock gives a MultiBlock of PolyData blocks, nested blocks included.

Examples#

Download Python source code | Download Jupyter notebook

Extract the edges of a sample unstructured grid and plot the edges. Note how it plots interior edges.

>>> import pyvista as pv
>>> from pyvista import examples
>>> hex_beam = pv.read(examples.hexbeamfile)
>>> edges = hex_beam.extract_all_edges()
>>> edges.plot(line_width=5, color='k')
../../../_images/pyvista-DataObjectFilters-extract_all_edges-4472dbeb9efbf2e4_00_00.png

See Also#

pyvista.PolyDataFilters.dash_lines

Split the line cells into dashes.

pyvista.PolyDataFilters.tube

Generate a tube around each line.

pyvista.Actor.line_style

Dash the lines while rendering them.