"""Downloadable datasets of 3D Celestial Bodies."""
from __future__ import annotations
import numpy as np
import pyvista
from pyvista._deprecate_positional_args import _deprecate_positional_args
from pyvista.examples._dataset_loader import _download_dataset
from pyvista.examples._dataset_loader import _SingleFileDownloadableDatasetLoader
def _download_dataset_texture(
loader: _SingleFileDownloadableDatasetLoader, *, load: bool, texture: bool
):
dataset = _download_dataset(loader, load=load)
if texture:
from pyvista.plotting.texture import Texture # noqa: PLC0415
return Texture(dataset) # type: ignore[abstract]
return dataset
def _sphere_with_texture_map(radius=1.0, lat_resolution=50, lon_resolution=100):
"""Sphere with texture coordinates.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 100
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Sphere mesh with texture coordinates.
"""
# https://github.com/pyvista/pyvista/pull/2994#issuecomment-1200520035
theta, phi = np.mgrid[0 : np.pi : lat_resolution * 1j, 0 : 2 * np.pi : lon_resolution * 1j] # type: ignore[misc]
x = radius * np.sin(theta) * np.cos(phi)
y = radius * np.sin(theta) * np.sin(phi)
z = radius * np.cos(theta)
sphere = pyvista.StructuredGrid(x, y, z)
texture_coords = np.empty((sphere.n_points, 2))
texture_coords[:, 0] = phi.ravel('F') / phi.max()
texture_coords[:, 1] = theta[::-1, :].ravel('F') / theta.max()
sphere.active_texture_coordinates = texture_coords
return sphere.extract_surface(pass_pointid=False, pass_cellid=False)
@_deprecate_positional_args
def load_sun(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the Sun as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Sun dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_sun()
>>> texture = examples.planets.download_sun_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_sun_surface`
Download the surface of the Sun.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_moon(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the Moon as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Moon dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_moon()
>>> texture = examples.planets.download_moon_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_moon_surface`
Download the surface of the Moon.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_mercury(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Mercury as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Mercury dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_mercury()
>>> texture = examples.planets.download_mercury_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_mercury_surface`
Download the surface of Mercury.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_venus(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Venus as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Venus dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_venus()
>>> texture = examples.planets.download_venus_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_venus_surface`
Download the surface of the Venus.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_earth(radius=1.0, lat_resolution=50, lon_resolution=100):
"""Load the planet Earth as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Earth dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_earth()
>>> texture = examples.load_globe_texture()
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.examples.load_globe_texture`
Download the surface of the Earth.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_mars(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Mars as a textured Sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Mars dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_mars()
>>> texture = examples.planets.download_mars_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_mars_surface`
Download the surface of Mars.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_jupiter(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Jupiter as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Jupiter dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_jupiter()
>>> texture = examples.planets.download_jupiter_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_jupiter_surface`
Download the surface of Jupiter.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_saturn(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Saturn as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Saturn dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_saturn()
>>> texture = examples.planets.download_saturn_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_saturn_surface`
Download the surface of Saturn.
:func:`~pyvista.examples.planets.load_saturn_rings`
Load Saturn's rings as a textured disc.
:func:`~pyvista.examples.planets.download_saturn_rings`
Download the texture of Saturn's rings.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_saturn_rings(inner=0.25, outer=0.5, c_res=6): # pragma: no cover
"""Load the planet Saturn's rings.
Arguments are passed on to :func:`pyvista.Disc`.
Parameters
----------
inner : float, optional
The inner radius.
outer : float, optional
The outer radius.
c_res : int, optional
The number of points in the circumferential direction.
Returns
-------
pyvista.PolyData
Dataset with texture for Saturn's rings.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_saturn_rings()
>>> texture = examples.planets.download_saturn_rings(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_saturn_rings`
Download the texture of Saturn's rings.
:func:`~pyvista.examples.planets.load_saturn`
Load the planet Saturn as a textured sphere.
:func:`~pyvista.examples.planets.download_saturn_surface`
Download the surface of Saturn.
:ref:`planets_example`
Example plot of the solar system.
"""
disc = pyvista.Disc(inner=inner, outer=outer, c_res=c_res)
texture_coordinates = np.zeros((disc.points.shape[0], 2))
radius = np.sqrt(disc.points[:, 0] ** 2 + disc.points[:, 1] ** 2)
texture_coordinates[:, 0] = (radius - inner) / (outer - inner)
texture_coordinates[:, 1] = 0.0
disc.active_texture_coordinates = texture_coordinates
return disc
@_deprecate_positional_args
def load_uranus(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Uranus as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Uranus dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_uranus()
>>> texture = examples.planets.download_uranus_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_uranus_surface`
Download the surface of Uranus.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_neptune(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the planet Neptune as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Neptune dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_neptune()
>>> texture = examples.planets.download_neptune_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_neptune_surface`
Download the surface of Neptune.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def load_pluto(radius=1.0, lat_resolution=50, lon_resolution=100): # pragma: no cover
"""Load the dwarf planet Pluto as a textured sphere.
Parameters
----------
radius : float, default: 1.0
Sphere radius.
lat_resolution : int, default: 50
Set the number of points in the latitude direction.
lon_resolution : int, default: 100
Set the number of points in the longitude direction.
Returns
-------
pyvista.PolyData
Pluto dataset.
Examples
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> mesh = examples.planets.load_pluto()
>>> texture = examples.planets.download_pluto_surface(texture=True)
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> mesh.plot(texture=texture, background=image_path)
.. seealso::
:func:`~pyvista.examples.planets.download_pluto_surface`
Download the surface of Pluto.
:ref:`planets_example`
Example plot of the solar system.
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
@_deprecate_positional_args
def download_sun_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of the Sun.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_sun_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Sun Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_sun`
Load the Sun as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_sun_surface, load=load, texture=texture)
_dataset_sun_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/sun.jpg',
)
@_deprecate_positional_args
def download_moon_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of the Earth's Moon.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_moon_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Moon Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_moon`
Load the Moon as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_moon_surface, load=load, texture=texture)
_dataset_moon_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/moon.jpg',
)
@_deprecate_positional_args
def download_mercury_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of planet Mercury.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_mercury_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Mercury Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_mercury`
Load Mercury as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_mercury_surface, load=load, texture=texture)
_dataset_mercury_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/mercury.jpg',
)
@_deprecate_positional_args
def download_venus_surface(
atmosphere=True, # noqa: FBT002
texture=False, # noqa: FBT002
load=True, # noqa: FBT002
): # pragma: no cover
"""Download the surface or atmosphere of Planet Venus.
Textures obtained from `Solar Textures
`_.
Parameters
----------
atmosphere : bool, optional
Load the atmosphere texture when ``True``.
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_venus_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Venus Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_venus`
Load Venus as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
if atmosphere:
return _download_dataset_texture(_dataset_venus_surface, load=load, texture=texture)
return _download_dataset_texture(
__dataset_venus_surface_no_atmosphere, load=load, texture=texture
)
_dataset_venus_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/venus_atmosphere.jpg',
)
__dataset_venus_surface_no_atmosphere = _SingleFileDownloadableDatasetLoader(
'solar_textures/venus_surface.jpg',
)
@_deprecate_positional_args
def download_mars_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of the planet Mars.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_mars_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Mars Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_mars`
Load Mars as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_mars_surface, load=load, texture=texture)
_dataset_mars_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/mars.jpg',
)
@_deprecate_positional_args
def download_jupiter_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of the planet Jupiter.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_jupiter_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Jupiter Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_jupiter`
Load Jupiter as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_jupiter_surface, load=load, texture=texture)
_dataset_jupiter_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/jupiter.jpg',
)
@_deprecate_positional_args
def download_saturn_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the surface of the planet Saturn.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_saturn_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Saturn Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_saturn`
Load the planet Saturn as a textured sphere.
:func:`~pyvista.examples.planets.load_saturn_rings`
Load Saturn's rings as a textured disc.
:func:`~pyvista.examples.planets.download_saturn_rings`
Download the texture of Saturn's rings.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_saturn_surface, load=load, texture=texture)
_dataset_saturn_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/saturn.jpg',
)
@_deprecate_positional_args
def download_saturn_rings(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the texture of Saturn's rings.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.ImageData | pyvista.Texture | str
Dataset, texture, or filename of the Saturn's rings.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_saturn_rings(texture=True)
>>> texture.plot(cpos='xy')
.. seealso::
:ref:`Saturn Rings Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_saturn_rings`
Load Saturn's rings as a textured disc.
:func:`~pyvista.examples.planets.load_saturn`
Load the planet Saturn as a textured sphere.
:func:`~pyvista.examples.planets.download_saturn_surface`
Download the surface of Saturn.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_saturn_rings, load=load, texture=texture)
_dataset_saturn_rings = _SingleFileDownloadableDatasetLoader(
'solar_textures/saturn_ring_alpha.png',
)
@_deprecate_positional_args
def download_uranus_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download and the texture of the surface of planet Uranus.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_uranus_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Uranus Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_uranus`
Load Uranus as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_uranus_surface, load=load, texture=texture)
_dataset_uranus_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/uranus.jpg',
)
@_deprecate_positional_args
def download_neptune_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the texture of the surface of planet Neptune.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_neptune_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Neptune Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_neptune`
Load Neptune as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_neptune_surface, load=load, texture=texture)
_dataset_neptune_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/neptune.jpg',
)
@_deprecate_positional_args
def download_pluto_surface(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the texture of the surface of the dwarf planet Pluto.
Textures obtained from `Solar Textures
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
>>> from pyvista import examples
>>> texture = examples.planets.download_pluto_surface(texture=True)
>>> texture.plot(zoom='tight', show_axes=False)
.. seealso::
:ref:`Pluto Surface Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_pluto`
Load Pluto as a textured sphere.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_pluto_surface, load=load, texture=texture)
_dataset_pluto_surface = _SingleFileDownloadableDatasetLoader(
'solar_textures/pluto.jpg',
)
@_deprecate_positional_args
def download_stars_sky_background(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the night sky stars texture.
Textures obtained from `tamaskis/planet3D-MATLAB
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
Load the night sky image as a background image.
>>> from pyvista import examples
>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(load=False)
>>> pl.add_background_image(image_path)
>>> pl.show()
.. seealso::
:ref:`Stars Sky Background Dataset `
See this dataset in the Dataset Gallery for more info.
:func:`~pyvista.examples.planets.load_mars`
Load Mars as a textured sphere.
:ref:`Milkyway Sky Background Dataset `
Sky texture of the Milky Way galaxy.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_stars_sky_background, load=load, texture=texture)
_dataset_stars_sky_background = _SingleFileDownloadableDatasetLoader(
'planet3d-matlab/stars.jpg',
)
@_deprecate_positional_args
def download_milkyway_sky_background(texture=False, load=True): # pragma: no cover # noqa: FBT002
"""Download the sky texture of the Milky Way galaxy.
Textures obtained from `tamaskis/planet3D-MATLAB
`_.
Parameters
----------
texture : bool, default: False
Set to ``True`` when loading the surface as a texture.
load : bool, default: True
Load the dataset. When ``False``, return the path to the file.
Returns
-------
pyvista.DataSet | pyvista.Texture | str
Texture, Dataset, or path to the file depending on the ``load`` and
``texture`` parameters.
Examples
--------
Load the Milky Way sky image as a background image.
>>> from pyvista import examples
>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_milkyway_sky_background(load=False)
>>> pl.add_background_image(image_path)
>>> pl.show()
.. seealso::
:ref:`Milkyway Sky Background Dataset `
See this dataset in the Dataset Gallery for more info.
:ref:`Stars Sky Background Dataset `
Night sky stars texture.
:ref:`planets_example`
Example plot of the solar system.
"""
return _download_dataset_texture(_dataset_milkyway_sky_background, load=load, texture=texture)
_dataset_milkyway_sky_background = _SingleFileDownloadableDatasetLoader(
'planet3d-matlab/milkyway.jpg',
)