plot_wave

plot_wave(

*,

fps: int = 30,

frequency: float = 1,

wavetime: float = 3,

notebook: bool | None = None,

) → NDArray[np.floating]

Plot a 3D moving wave in a render window.

Parameters:

fpsint, default: 30

Maximum frames per second to display.

frequencyfloat, default: 1.0

Wave cycles per second (Hz).

wavetimefloat, default: 3.0

The desired total display time in seconds.

notebookbool, optional

When True, the resulting plot is placed inline a jupyter notebook. Assumes a jupyter console is active.

Returns:

numpy.ndarray

Position of points at last frame.

Examples

Download Python source code | Download Jupyter notebook

>>> from pyvista import demos
>>> out = demos.plot_wave()

Static Scene

Interactive Scene