pyvista.examples.downloads.download_beach

Contents

pyvista.examples.downloads.download_beach#

download_beach(load=True)[source]#

Download the beach NRRD image.

Parameters:
loadbool, default: True

Load the dataset after downloading it when True. Set this to False and only the filename will be returned.

Returns:
pyvista.ImageData | str

DataSet or filename depending on load.

Examples

>>> from pyvista import examples
>>> dataset = examples.download_beach()
>>> dataset.plot(rgba=True, cpos='xy')
../../../_images/pyvista-examples-downloads-download_beach-1_00_00.png

See also

Beach Dataset

See this dataset in the Dataset Gallery for more info.