scale#

RectilinearGrid.scale(xyz: Union[float, int, number, list, tuple, ndarray], transform_all_input_vectors=False, inplace=False)#

Scale the mesh.

Note

See also the notes at transform() which is used by this filter under the hood.

Parameters:
xyzfloat or list or tuple or np.ndarray

A scalar or length 3 list, tuple or array defining the scale factors along x, y, and z. If a scalar, the same uniform scale is used along all three axes.

transform_all_input_vectorsbool, optional

When True, all input vectors are transformed. Otherwise, only the points, normals and active vectors are transformed.

inplacebool, optional

Updates mesh in-place.

Returns:
pyvista.DataSet

Scaled dataset.

Examples

>>> import pyvista
>>> from pyvista import examples
>>> pl = pyvista.Plotter(shape=(1, 2))
>>> pl.subplot(0, 0)
>>> pl.show_axes()
>>> _ = pl.show_grid()
>>> mesh1 = examples.download_teapot()
>>> _ = pl.add_mesh(mesh1)
>>> pl.subplot(0, 1)
>>> pl.show_axes()
>>> _ = pl.show_grid()
>>> mesh2 = mesh1.scale([10.0, 10.0, 10.0], inplace=False)
>>> _ = pl.add_mesh(mesh2)
>>> pl.show(cpos="xy")
../../../_images/pyvista-RectilinearGrid-scale-1_00_00.png