pyvista.DataObjectFilters.extract_all_edges

pyvista.DataObjectFilters.extract_all_edges#

DataObjectFilters.extract_all_edges(
use_all_points: bool | None = None,
clear_data: bool = False,
progress_bar: bool = False,
)[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

Edges extracted from the dataset.

Examples

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 Extract Cell Centers for more examples using this filter.