DataSetFilters.shrink

DataSetFilters.shrink(

shrink_factor: float = 1.0,

*,

progress_bar: bool = False,

) → PolyData | UnstructuredGrid

Shrink the individual faces of a mesh.

This filter shrinks the individual faces of a mesh rather than scaling the entire mesh.

Parameters:

shrink_factorfloat, default: 1.0

Fraction of shrink for each cell. Default does not modify the faces.

progress_barbool, default: False

Display a progress bar to indicate progress.

Returns:

pyvista.PolyData | pyvista.UnstructuredGrid

Dataset with shrunk faces. A PolyData gives a PolyData; every other dataset gives an UnstructuredGrid.

Examples

Download Python source code | Download Jupyter notebook

First, plot the original cube.

>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> mesh.plot(show_edges=True, line_width=5)

Static Scene

Interactive Scene

Now, plot the mesh with shrunk faces.

>>> shrunk = mesh.shrink(0.5)
>>> shrunk.clear_data()  # cleans up plot
>>> shrunk.plot(show_edges=True, line_width=5)

Static Scene

Interactive Scene

Used In

API Examples

• CubeFacesSource.shrink_factor (1 use)
• Global Configuration (1 use)
• download_quadratic_pyramid (1 use)
• download_tetrahedron (1 use)