1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
|
"""Downloadable datasets of 3D Celestial Bodies."""
from __future__ import annotations
import numpy as np
import pyvista
from .downloads import _download_and_read
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]
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)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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()
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
disc = pyvista.Disc(inner=inner, outer=outer, c_res=c_res)
disc.active_texture_coordinates = np.zeros((disc.points.shape[0], 2))
radius = np.sqrt(disc.points[:, 0] ** 2 + disc.points[:, 1] ** 2)
disc.active_texture_coordinates[:, 0] = radius / np.max(radius)
disc.active_texture_coordinates[:, 1] = 0.0
return disc
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
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)
>>> pl = pv.Plotter()
>>> image_path = examples.planets.download_stars_sky_background(
... load=False
... )
>>> pl.add_background_image(image_path)
>>> _ = pl.add_mesh(mesh, texture=texture)
>>> pl.show()
"""
return _sphere_with_texture_map(
radius=radius,
lat_resolution=lat_resolution,
lon_resolution=lon_resolution,
)
def download_sun_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of the Sun.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/sun.jpg', texture=texture, load=load)
def download_moon_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of the Earth's Moon.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/moon.jpg', texture=texture, load=load)
def download_mercury_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of planet Mercury.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/mercury.jpg', texture=texture, load=load)
def download_venus_surface(atmosphere=True, texture=False, load=True): # pragma: no cover
"""Download the surface or atmosphere of Planet Venus.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
if atmosphere:
return _download_and_read('solar_textures/venus_atmosphere.jpg', load=load, texture=texture)
else:
return _download_and_read('solar_textures/venus_surface.jpg', load=load, texture=texture)
def download_mars_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of the planet Mars.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/mars.jpg', load=load, texture=texture)
def download_jupiter_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of the planet Jupiter.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/jupiter.jpg', texture=texture, load=load)
def download_saturn_surface(texture=False, load=True): # pragma: no cover
"""Download the surface of the planet Saturn.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/saturn.jpg', texture=texture, load=load)
def download_saturn_rings(texture=False, load=True): # pragma: no cover
"""Download the texture of Saturn's rings.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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')
"""
return _download_and_read('solar_textures/saturn_ring_alpha.png', texture=texture, load=load)
def download_uranus_surface(texture=False, load=True): # pragma: no cover
"""Download and the texture of the surface of planet Uranus.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/uranus.jpg', texture=texture, load=load)
def download_neptune_surface(texture=False, load=True): # pragma: no cover
"""Download the texture of the surface of planet Neptune.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/neptune.jpg', texture=texture, load=load)
def download_pluto_surface(texture=False, load=True): # pragma: no cover
"""Download the texture of the surface of the dwarf planet Pluto.
Textures obtained from `Solar Textures
<https://www.solarsystemscope.com/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, or 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)
"""
return _download_and_read('solar_textures/pluto.jpg', texture=texture, load=load)
def download_stars_sky_background(texture=False, load=True): # pragma: no cover
"""Download the night sky stars texture.
Textures obtained from `tamaskis/planet3D-MATLAB
<https://github.com/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, or 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()
See :func:`load_mars` for another example using this dataset.
"""
return _download_and_read('planet3d-matlab/stars.jpg', texture=texture, load=load)
def download_milkyway_sky_background(texture=False, load=True): # pragma: no cover
"""Download the sky texture of the Milky Way galaxy.
Textures obtained from `tamaskis/planet3D-MATLAB
<https://github.com/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, or 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()
"""
return _download_and_read('planet3d-matlab/milkyway.jpg', texture=texture, load=load)
|