shrink

UniformGridFilters.shrink(shrink_factor=1.0, progress_bar=False)

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, optional

Fraction of shrink for each cell. Defaults to 1.0, which does not modify the faces.

progress_barbool, optional

Display a progress bar to indicate progress.

Returns
pyvista.DataSet

Dataset with shrunk faces. Return type matches input.

Examples

First, plot the original cube.

>>> import pyvista
>>> mesh = pyvista.Cube()
>>> mesh.plot(show_edges=True, line_width=5)
../../../_images/pyvista-UniformGridFilters-shrink-1_00_00.png

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)
../../../_images/pyvista-UniformGridFilters-shrink-1_01_00.png