"""This test module tests any functionality that requires plotting. See the image regression notes in doc/extras/developer_notes.rst """ from __future__ import annotations import inspect import importlib import io import os import pathlib from pathlib import Path import re import time from types import FunctionType from types import ModuleType from typing import TYPE_CHECKING from typing import Any from typing import TypeVar import numpy as np from PIL import Image import pytest import vtk import pyvista as pv from pyvista import demos from pyvista import examples from pyvista.core.errors import DeprecationError from pyvista.core.errors import PyVistaDeprecationWarning from pyvista.plotting import BackgroundPlotter from pyvista.plotting import QtDeprecationError from pyvista.plotting import QtInteractor from pyvista.plotting import check_math_text_support from pyvista.plotting.colors import matplotlib_default_colors from pyvista.plotting.errors import InvalidCameraError from pyvista.plotting.errors import RenderWindowUnavailable from pyvista.plotting.plotter import SUPPORTED_FORMATS import pyvista.plotting.text from pyvista.plotting.texture import numpy_to_texture from pyvista.plotting.utilities import algorithms from tests.core.test_imagedata_filters import labeled_image # noqa: F401 if TYPE_CHECKING: from collections.abc import Callable from collections.abc import ItemsView from pytest_mock import MockerFixture # charts fail if paraview is used to provide vtkmodules # since it does not provide vtkPythonContext2D xfail_charts = pytest.mark.xfail(importlib.util.find_spec("paraview"), reason="paraview provides vtk without vtkPythonContext2D required for charts") # skip all tests if unable to render pytestmark = pytest.mark.skip_plotting HAS_IMAGEIO = True try: import imageio except ModuleNotFoundError: HAS_IMAGEIO = False try: import imageio_ffmpeg imageio_ffmpeg.get_ffmpeg_exe() except ImportError: if HAS_IMAGEIO: imageio.plugins.ffmpeg.download() else: raise THIS_PATH = pathlib.Path(__file__).parent.absolute() def using_mesa(): """Determine if using mesa.""" pl = pv.Plotter(notebook=False, off_screen=True) pl.show(auto_close=False) gpu_info = pl.render_window.ReportCapabilities() pl.close() regex = re.compile('OpenGL version string:(.+)\n') return 'Mesa' in regex.findall(gpu_info)[0] # always set on Windows CI # These tests fail with mesa opengl on windows skip_mesa = pytest.mark.skipif(using_mesa(), reason='Does not display correctly within OSMesa') skip_windows_mesa = skip_mesa and pytest.mark.skip_windows( 'Does not display correctly within OSMesa on Windows' ) skip_9_1_0 = pytest.mark.needs_vtk_version(9, 1, 0) skip_9_0_X = pytest.mark.needs_vtk_version(9, 1, 0, reason='Flaky on 9.0.X') # noqa: N816 skip_lesser_9_0_X = pytest.mark.needs_vtk_version( # noqa: N816 9, 1, reason='Functions not implemented before 9.0.X' ) skip_lesser_9_3_X = pytest.mark.needs_vtk_version( # noqa: N816 9, 3, reason='Functions not implemented before 9.3.X' ) skip_lesser_9_4_X = pytest.mark.needs_vtk_version( # noqa: N816 9, 4, reason='Functions not implemented before 9.4.X or invalid results prior' ) CI_WINDOWS = os.environ.get('CI_WINDOWS', 'false').lower() == 'true' @pytest.fixture(autouse=True) def verify_image_cache_wrapper(verify_image_cache): return verify_image_cache @pytest.fixture def no_images_to_verify(verify_image_cache_wrapper): pass @pytest.fixture def multicomp_poly(): """Create a dataset with vector values on points and cells.""" data = pv.Plane(direction=(0, 0, -1)) vector_values_points = np.empty((data.n_points, 3)) vector_values_points[:, 0] = np.arange(data.n_points) vector_values_points[:, 1] = np.arange(data.n_points)[::-1] vector_values_points[:, 2] = 0 vector_values_cells = np.empty((data.n_cells, 3)) vector_values_cells[:, 0] = np.arange(data.n_cells) vector_values_cells[:, 1] = np.arange(data.n_cells)[::-1] vector_values_cells[:, 2] = 0 data['vector_values_points'] = vector_values_points data['vector_values_cells'] = vector_values_cells return data @pytest.mark.usefixtures('no_images_to_verify') def test_pyvista_qt_raises(): match = re.escape(QtDeprecationError.message.format(*[BackgroundPlotter.__name__] * 4)) with pytest.raises(QtDeprecationError, match=match): BackgroundPlotter() match = re.escape(QtDeprecationError.message.format(*[QtInteractor.__name__] * 4)) with pytest.raises(QtDeprecationError, match=match): QtInteractor() @pytest.mark.usefixtures('no_images_to_verify') def test_plotting_module_raises(mocker: MockerFixture): from pyvista.plotting import plotting m = mocker.patch.object(plotting, 'inspect') m.getattr_static.side_effect = AttributeError match = re.escape( 'Module `pyvista.plotting.plotting` has been deprecated and we could not automatically ' 'find `foo`' ) with pytest.raises(AttributeError, match=match): plotting.foo # noqa: B018 def test_import_gltf(verify_image_cache): # image cache created with 9.0.20210612.dev0 verify_image_cache.high_variance_test = True filename = str(Path(THIS_PATH) / '..' / 'example_files' / 'Box.glb') pl = pv.Plotter() with pytest.raises(FileNotFoundError): pl.import_gltf('not a file') pl.import_gltf(filename) assert np.allclose(pl.bounds, (-0.5, 0.5, -0.5, 0.5, -0.5, 0.5)) pl.show() def test_export_gltf(tmpdir, sphere, airplane, hexbeam, verify_image_cache): # image cache created with 9.0.20210612.dev0 verify_image_cache.high_variance_test = True filename = str(tmpdir.mkdir('tmpdir').join('tmp.gltf')) pl = pv.Plotter() pl.add_mesh(sphere, smooth_shading=True) pl.add_mesh(airplane) pl.add_mesh(hexbeam) # to check warning with pytest.warns(UserWarning, match='Plotter contains non-PolyData datasets'): pl.export_gltf(filename) pl_import = pv.Plotter() pl_import.import_gltf(filename) pl_import.show() with pytest.raises(RuntimeError, match='This plotter has been closed'): pl_import.export_gltf(filename) def test_import_vrml(): filename = str(Path(THIS_PATH) / '..' / 'example_files' / 'Box.wrl') match = ( 'VRML files must be imported directly into a Plotter. ' 'See `pyvista.Plotter.import_vrml` for details.' ) with pytest.raises(ValueError, match=match): pv.read(filename) pl = pv.Plotter() with pytest.raises(FileNotFoundError): pl.import_vrml('not a file') pl.import_vrml(filename) assert np.allclose(pl.bounds, (-0.5, 0.5, -0.5, 0.5, -0.5, 0.5)) pl.show() def test_export_vrml(tmpdir, sphere): filename = str(tmpdir.mkdir('tmpdir').join('tmp.wrl')) pl = pv.Plotter() pl.add_mesh(sphere, smooth_shading=True) pl.export_vrml(filename) pl_import = pv.Plotter() pl_import.import_vrml(filename) pl_import.show() with pytest.raises(RuntimeError, match='This plotter has been closed'): pl_import.export_vrml(filename) def test_import_3ds(): filename = examples.download_3ds.download_iflamigm() pl = pv.Plotter() with pytest.raises(FileNotFoundError, match='Unable to locate'): pl.import_3ds('not a file') pl.import_3ds(filename) assert np.allclose( pl.bounds, ( -5.379246234893799, 5.364696979522705, -1.9769330024719238, 2.731842041015625, -7.883847236633301, 5.437096118927002, ), ) pl.show() @skip_9_0_X def test_import_obj(): download_obj_file = examples.download_room_surface_mesh(load=False) pl = pv.Plotter() with pytest.raises(FileNotFoundError, match='Unable to locate'): pl.import_obj('not a file') pl.import_obj(download_obj_file) assert np.allclose(pl.bounds, (-10.0, 10.0, 0.0, 4.5, -10.0, 10.0)) pl.show() @skip_9_0_X def test_import_obj_with_texture(): filename = examples.download_doorman(load=False) pl = pv.Plotter() pl.import_obj(filename) pl.show(cpos='xy') @pytest.mark.skip_windows @pytest.mark.skipif(CI_WINDOWS, reason='Windows CI testing segfaults on pbr') def test_pbr(sphere, verify_image_cache): """Test PBR rendering""" verify_image_cache.high_variance_test = True texture = examples.load_globe_texture() pl = pv.Plotter(lighting=None) pl.set_environment_texture(texture) pl.add_light(pv.Light()) pl.add_mesh( sphere, color='w', pbr=True, metallic=0.8, roughness=0.2, smooth_shading=True, diffuse=1, ) pl.add_mesh( pv.Sphere(center=(0, 0, 1)), color='w', pbr=True, metallic=0.0, roughness=1.0, smooth_shading=True, diffuse=1, ) pl.show() @pytest.mark.parametrize('resample', [True, 0.5]) @pytest.mark.needs_vtk_version(9, 2) def test_set_environment_texture_cubemap(resample, verify_image_cache): """Test set_environment_texture with a cubemap.""" # Skip due to large variance verify_image_cache.windows_skip_image_cache = True verify_image_cache.macos_skip_image_cache = True pl = pv.Plotter(lighting=None) texture = examples.download_cubemap_park() pl.set_environment_texture(texture, is_srgb=True, resample=resample) pl.camera_position = 'xy' pl.camera.zoom(0.7) _ = pl.add_mesh(pv.Sphere(), pbr=True, roughness=0.1, metallic=0.5) pl.show() @pytest.mark.skip_windows @pytest.mark.skip_mac('MacOS CI fails when downloading examples') def test_remove_environment_texture_cubemap(sphere): """Test remove_environment_texture with a cubemap.""" texture = examples.download_sky_box_cube_map() pl = pv.Plotter() pl.set_environment_texture(texture) pl.add_mesh(sphere, color='w', pbr=True, metallic=0.8, roughness=0.2) pl.remove_environment_texture() pl.show() def test_plot_pyvista_ndarray(sphere): # verify we can plot pyvista_ndarray pv.plot(sphere.points) plotter = pv.Plotter() plotter.add_points(sphere.points) plotter.add_points(sphere.points + 1) plotter.show() def test_plot_increment_point_size(): points = np.array([[0, 0, 0], [1, 0, 0], [1, 0, 0], [1, 1, 0]], dtype=np.float32) pl = pv.Plotter() pl.add_points(points + 1) pl.add_lines(points) pl.increment_point_size_and_line_width(5) pl.show() def test_plot_update(sphere): pl = pv.Plotter() pl.add_mesh(sphere) pl.show(auto_close=False) pl.update() time.sleep(0.1) pl.update() pl.update(force_redraw=True) pl.close() @pytest.mark.parametrize('anti_aliasing', [True, 'msaa', False]) def test_plot(sphere, tmpdir, verify_image_cache, anti_aliasing): verify_image_cache.high_variance_test = True verify_image_cache.macos_skip_image_cache = True verify_image_cache.windows_skip_image_cache = True # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True tmp_dir = tmpdir.mkdir('tmpdir2') filename = str(tmp_dir.join('tmp.png')) scalars = np.arange(sphere.n_points) cpos, img = pv.plot( sphere, full_screen=True, text='this is a sphere', show_bounds=True, color='r', style='surface', line_width=2, scalars=scalars, flip_scalars=True, cmap='bwr', interpolate_before_map=True, screenshot=filename, return_img=True, return_cpos=True, anti_aliasing=anti_aliasing, ) assert isinstance(cpos, pv.CameraPosition) assert isinstance(img, np.ndarray) assert Path(filename).is_file() verify_image_cache.skip = True filename = pathlib.Path(str(tmp_dir.join('tmp2.png'))) pv.plot(sphere, screenshot=filename) # Ensure it added a PNG extension by default assert filename.with_suffix('.png').is_file() # test invalid extension filename = pathlib.Path(str(tmp_dir.join('tmp3.foo'))) with pytest.raises(ValueError): # noqa: PT011 pv.plot(sphere, screenshot=filename) def test_plot_helper_volume(uniform, verify_image_cache): verify_image_cache.windows_skip_image_cache = True # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True uniform.plot( volume=True, parallel_projection=True, show_scalar_bar=False, show_grid=True, ) def test_plot_helper_two_datasets(sphere, airplane): pv.plot([sphere, airplane]) def test_plot_helper_two_volumes(uniform, verify_image_cache): verify_image_cache.windows_skip_image_cache = True grid = uniform.copy() grid.origin = (0, 0, 10) pv.plot( [uniform, grid], volume=True, show_scalar_bar=False, ) def test_plot_volume_ugrid(verify_image_cache): verify_image_cache.windows_skip_image_cache = True # Handle UnsutructuredGrid directly grid = examples.load_hexbeam() pl = pv.Plotter() pl.add_volume(grid, scalars='sample_point_scalars') pl.show() # Handle 3D structured grid grid = examples.load_uniform().cast_to_structured_grid() pl = pv.Plotter() pl.add_volume(grid, scalars='Spatial Point Data') pl.show() # Make sure PolyData fails mesh = pv.Sphere() mesh['scalars'] = mesh.points[:, 1] pl = pv.Plotter() with pytest.raises(TypeError): pl.add_volume(mesh, scalars='scalars') pl.close() # Make sure 2D StructuredGrid fails mesh = examples.load_structured() # wavy surface mesh['scalars'] = mesh.points[:, 1] pl = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 pl.add_volume(mesh, scalars='scalars') pl.close() def test_plot_return_cpos(sphere): cpos = sphere.plot(return_cpos=True) assert isinstance(cpos, pv.CameraPosition) assert sphere.plot(return_cpos=False) is None def test_add_title(verify_image_cache): verify_image_cache.high_variance_test = True plotter = pv.Plotter() plotter.add_title('Plot Title') plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_plot_invalid_style(sphere): with pytest.raises(ValueError): # noqa: PT011 pv.plot(sphere, style='not a style') @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize( ('interaction', 'kwargs'), [ ('trackball', {}), ('trackball_actor', {}), ('image', {}), ('joystick', {}), ('joystick_actor', {}), ('zoom', {}), ('terrain', {}), ('terrain', {'mouse_wheel_zooms': True, 'shift_pans': True}), ('rubber_band', {}), ('rubber_band_2d', {}), ], ) def test_interactor_style(sphere, interaction, kwargs): plotter = pv.Plotter() plotter.add_mesh(sphere) getattr(plotter, f'enable_{interaction}_style')(**kwargs) assert plotter.iren._style_class is not None plotter.close() @pytest.mark.usefixtures('no_images_to_verify') def test_lighting_disable_3_lights(): with pytest.raises(DeprecationError): pv.Plotter().disable_3_lights() def test_lighting_enable_three_lights(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.enable_3_lights() lights = plotter.renderer.lights assert len(lights) == 3 for light in lights: assert light.on assert lights[0].intensity == 1.0 assert lights[1].intensity == 0.6 assert lights[2].intensity == 0.5 plotter.show() def test_lighting_add_manual_light(sphere): plotter = pv.Plotter(lighting=None) plotter.add_mesh(sphere) # test manual light addition light = pv.Light() plotter.add_light(light) assert plotter.renderer.lights == [light] # failing case with pytest.raises(TypeError): plotter.add_light('invalid') plotter.show() def test_lighting_remove_manual_light(sphere): plotter = pv.Plotter(lighting=None) plotter.add_mesh(sphere) plotter.add_light(pv.Light()) # test light removal plotter.remove_all_lights() assert not plotter.renderer.lights plotter.show() def test_lighting_subplots(sphere): plotter = pv.Plotter(shape='1|1') plotter.add_mesh(sphere) renderers = plotter.renderers light = pv.Light() plotter.remove_all_lights() for renderer in renderers: assert not renderer.lights plotter.subplot(0) plotter.add_light(light, only_active=True) assert renderers[0].lights assert not renderers[1].lights plotter.add_light(light, only_active=False) assert renderers[0].lights assert renderers[1].lights plotter.subplot(1) plotter.add_mesh(pv.Sphere()) plotter.remove_all_lights(only_active=True) assert renderers[0].lights assert not renderers[1].lights plotter.show() def test_lighting_init_light_kit(sphere): plotter = pv.Plotter(lighting='light kit') plotter.add_mesh(sphere) lights = plotter.renderer.lights assert len(lights) == 5 assert lights[0].light_type == pv.Light.HEADLIGHT for light in lights[1:]: assert light.light_type == light.CAMERA_LIGHT plotter.show() def test_lighting_init_three_lights(sphere): plotter = pv.Plotter(lighting='three lights') plotter.add_mesh(sphere) lights = plotter.renderer.lights assert len(lights) == 3 for light in lights: assert light.light_type == light.CAMERA_LIGHT plotter.show() def test_lighting_init_none(sphere): # ``None`` already tested above plotter = pv.Plotter(lighting='none') plotter.add_mesh(sphere) lights = plotter.renderer.lights assert not lights plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_lighting_init_invalid(): with pytest.raises(ValueError): # noqa: PT011 pv.Plotter(lighting='invalid') @pytest.mark.usefixtures('no_images_to_verify') def test_plotter_shape_invalid(): # wrong size with pytest.raises(ValueError): # noqa: PT011 pv.Plotter(shape=(1,)) # not positive with pytest.raises(ValueError): # noqa: PT011 pv.Plotter(shape=(1, 0)) with pytest.raises(ValueError): # noqa: PT011 pv.Plotter(shape=(0, 2)) # not a sequence with pytest.raises(TypeError): pv.Plotter(shape={1, 2}) def test_plot_bounds_axes_with_no_data(verify_image_cache): # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True plotter = pv.Plotter() plotter.show_bounds() plotter.show() def test_plot_show_grid(sphere, verify_image_cache): # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True plotter = pv.Plotter() with pytest.raises(ValueError, match='Value of location'): plotter.show_grid(location='foo') with pytest.raises(TypeError, match='location must be a string'): plotter.show_grid(location=10) with pytest.raises(ValueError, match='Value of tick'): plotter.show_grid(ticks='foo') with pytest.raises(TypeError, match='must be a string'): plotter.show_grid(ticks=10) plotter.show_grid() # Add mesh after to make sure bounds update plotter.add_mesh(sphere) plotter.show() @skip_mesa def test_plot_show_grid_with_mesh(hexbeam, plane, verify_image_cache): """Show the grid bounds for a specific mesh.""" verify_image_cache.macos_skip_image_cache = True hexbeam.clear_data() plotter = pv.Plotter() plotter.add_mesh(hexbeam, style='wireframe') plotter.add_mesh(plane) plotter.show_grid(mesh=plane, show_zlabels=False, show_zaxis=False) plotter.show() cpos_param = [ [(2.0, 5.0, 13.0), (0.0, 0.0, 0.0), (-0.7, -0.5, 0.3)], [-1, 2, -5], # trigger view vector [1.0, 2.0, 3.0], ] cpos_param.extend(pv.plotting.renderer.Renderer.CAMERA_STR_ATTR_MAP) @pytest.mark.parametrize('cpos', cpos_param) def test_set_camera_position(cpos, sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.camera_position = cpos plotter.show() @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize( 'cpos', [ [(2.0, 5.0), (0.0, 0.0, 0.0), (-0.7, -0.5, 0.3)], [-1, 2], [(1, 2, 3)], 'notvalid', ], ) def test_set_camera_position_invalid(cpos, sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) with pytest.raises(InvalidCameraError): plotter.camera_position = cpos @pytest.mark.usefixtures('no_images_to_verify') def test_parallel_projection(): plotter = pv.Plotter() assert isinstance(plotter.parallel_projection, bool) @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize('state', [True, False]) def test_set_parallel_projection(state): plotter = pv.Plotter() plotter.parallel_projection = state assert plotter.parallel_projection == state @pytest.mark.usefixtures('no_images_to_verify') def test_parallel_scale(): plotter = pv.Plotter() assert isinstance(plotter.parallel_scale, float) @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize('value', [1, 1.5, 0.3, 10]) def test_set_parallel_scale(value): plotter = pv.Plotter() plotter.parallel_scale = value assert plotter.parallel_scale == value @pytest.mark.usefixtures('no_images_to_verify') def test_set_parallel_scale_invalid(): plotter = pv.Plotter() with pytest.raises(TypeError): plotter.parallel_scale = 'invalid' @pytest.mark.usefixtures('no_images_to_verify') def test_plot_no_active_scalars(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) def _test_update_scalars_with_invalid_array(): plotter.update_scalars(np.arange(5)) if pv._version.version_info[:2] > (0, 46): msg = 'Convert error this method' raise RuntimeError(msg) if pv._version.version_info[:2] > (0, 47): msg = 'Remove this method' raise RuntimeError(msg) def _test_update_scalars_with_valid_array(): plotter.update_scalars(np.arange(sphere.n_faces_strict)) if pv._version.version_info[:2] > (0, 46): msg = 'Convert error this method' raise RuntimeError(msg) if pv._version.version_info[:2] > (0, 47): msg = 'Remove this method' raise RuntimeError(msg) with ( pytest.raises(ValueError, match='Number of scalars'), pytest.warns( PyVistaDeprecationWarning, match='This method is deprecated and will be removed in a future version', ), ): _test_update_scalars_with_invalid_array() with ( pytest.raises(ValueError, match='No active scalars'), pytest.warns( PyVistaDeprecationWarning, match='This method is deprecated and will be removed in a future version', ), ): _test_update_scalars_with_valid_array() def test_plot_show_bounds(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.show_bounds( show_xaxis=False, show_yaxis=False, show_zaxis=False, show_xlabels=False, show_ylabels=False, show_zlabels=False, use_2d=True, ) plotter.show() def test_plot_label_fmt(sphere, verify_image_cache): # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.show_bounds(xtitle='My X', fmt=r'%.3f') plotter.show() @pytest.mark.parametrize('grid', [True, 'both', 'front', 'back']) @pytest.mark.parametrize('location', ['all', 'origin', 'outer', 'front', 'back']) @pytest.mark.usefixtures('verify_image_cache') def test_plot_show_bounds_params(grid, location, verify_image_cache): # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially with VTK 9.6 verify_image_cache.skip = True plotter = pv.Plotter() plotter.add_mesh(pv.Cone()) plotter.show_bounds(grid=grid, ticks='inside', location=location) plotter.show_bounds(grid=grid, ticks='outside', location=location) plotter.show_bounds(grid=grid, ticks='both', location=location) plotter.show() def test_plot_silhouette_non_poly(hexbeam): plotter = pv.Plotter() plotter.add_mesh(hexbeam, show_scalar_bar=False) plotter.add_silhouette(hexbeam, line_width=10) plotter.show() def test_plot_no_silhouette(tri_cylinder): # silhouette=False plotter = pv.Plotter() plotter.add_mesh(tri_cylinder) assert len(list(plotter.renderer.GetActors())) == 1 # only cylinder plotter.show() def test_plot_silhouette(tri_cylinder): # silhouette=True and default properties plotter = pv.Plotter() plotter.add_mesh(tri_cylinder, silhouette=True) actors = list(plotter.renderer.GetActors()) assert len(actors) == 2 # cylinder + silhouette actor = actors[0] # get silhouette actor props = actor.GetProperty() assert props.GetColor() == pv.global_theme.silhouette.color assert props.GetOpacity() == pv.global_theme.silhouette.opacity assert props.GetLineWidth() == pv.global_theme.silhouette.line_width plotter.show() def test_plot_silhouette_method(tri_cylinder): plotter = pv.Plotter() plotter.add_mesh(tri_cylinder) assert len(plotter.renderer.actors) == 1 # cylinder actor = plotter.add_silhouette(tri_cylinder) assert isinstance(actor, pv.Actor) assert len(plotter.renderer.actors) == 2 # cylinder + silhouette props = actor.prop assert props.color == pv.global_theme.silhouette.color assert props.opacity == pv.global_theme.silhouette.opacity assert props.line_width == pv.global_theme.silhouette.line_width plotter.show() def test_plot_silhouette_options(tri_cylinder): # cover other properties plotter = pv.Plotter() plotter.add_mesh(tri_cylinder, silhouette=dict(decimate=0.5, feature_angle=20)) plotter.show() def test_plotter_scale(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.set_scale(10, 10, 15) assert plotter.scale == [10, 10, 15] plotter.show() plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.set_scale(5.0) plotter.set_scale(yscale=6.0) plotter.set_scale(zscale=9.0) assert plotter.scale == [5.0, 6.0, 9.0] plotter.show() plotter = pv.Plotter() plotter.scale = [1.0, 4.0, 2.0] assert plotter.scale == [1.0, 4.0, 2.0] plotter.add_mesh(sphere) plotter.show() def test_plot_add_scalar_bar(sphere, verify_image_cache): verify_image_cache.windows_skip_image_cache = True sphere['test_scalars'] = sphere.points[:, 2] plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.add_scalar_bar( label_font_size=10, title_font_size=20, title='woa', interactive=True, vertical=True, ) plotter.add_scalar_bar(background_color='white', n_colors=256) assert isinstance(plotter.scalar_bar, vtk.vtkScalarBarActor) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_plot_invalid_add_scalar_bar(): plotter = pv.Plotter() with pytest.raises(AttributeError): plotter.add_scalar_bar() @pytest.mark.usefixtures('no_images_to_verify') def test_add_scalar_bar_with_unconstrained_font_size(sphere): sphere['test_scalars'] = sphere.points[:, 2] plotter = pv.Plotter() plotter.add_mesh(sphere) actor = plotter.add_scalar_bar(unconstrained_font_size=True) assert actor.GetUnconstrainedFontSize() def test_plot_list(): sphere_a = pv.Sphere(center=(0, 0, 0), radius=0.75) sphere_b = pv.Sphere(center=(1, 0, 0), radius=0.5) sphere_c = pv.Sphere(center=(2, 0, 0), radius=0.25) pv.plot([sphere_a, sphere_b, sphere_c], color='tan') @pytest.mark.usefixtures('no_images_to_verify') def test_add_lines_invalid(): plotter = pv.Plotter() with pytest.raises(TypeError): plotter.add_lines(range(10)) @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.skipif(not HAS_IMAGEIO, reason='Requires imageio') def test_open_gif_invalid(): plotter = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 plotter.open_gif('file.abs') @pytest.mark.skipif(not HAS_IMAGEIO, reason='Requires imageio') def test_make_movie(sphere, tmpdir, verify_image_cache): verify_image_cache.skip = True # Make temporary file filename = str(tmpdir.join('tmp.mp4')) movie_sphere = sphere.copy() movie_sphere['scalars'] = np.random.default_rng().random(movie_sphere.n_faces_strict) plotter = pv.Plotter() plotter.open_movie(filename) actor = plotter.add_axes_at_origin() plotter.remove_actor(actor, reset_camera=False, render=True) plotter.add_mesh(movie_sphere, scalars='scalars') plotter.show(auto_close=False, window_size=[304, 304]) plotter.set_focus([0, 0, 0]) for _ in range(3): # limiting number of frames to write for speed plotter.write_frame() random_points = np.random.default_rng().random(movie_sphere.points.shape) movie_sphere.points[:] = random_points * 0.01 + movie_sphere.points * 0.99 movie_sphere.points[:] -= movie_sphere.points.mean(0) scalars = np.random.default_rng().random(movie_sphere.n_faces_strict) movie_sphere['scalars'] = scalars # remove file plotter.close() Path(filename).unlink() # verifies that the plotter has closed def test_add_legend(sphere): plotter = pv.Plotter() with pytest.raises(TypeError): plotter.add_mesh(sphere, label=2) plotter.add_mesh(sphere) with pytest.raises(ValueError): # noqa: PT011 plotter.add_legend() legend_labels = [['sphere', 'r']] plotter.add_legend(labels=legend_labels, border=True, bcolor=None, size=[0.1, 0.1]) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_legend_invalid_face(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) legend_labels = [['sphere', 'r']] face = 'invalid_face' with pytest.raises(ValueError): # noqa: PT011 plotter.add_legend( labels=legend_labels, border=True, bcolor=None, size=[0.1, 0.1], face=face, ) def test_legend_subplots(sphere, cube): plotter = pv.Plotter(shape=(1, 2)) plotter.add_mesh(sphere, color='blue', smooth_shading=True, label='Sphere') assert plotter.legend is None plotter.add_legend(bcolor='w') assert isinstance(plotter.legend, vtk.vtkActor2D) plotter.subplot(0, 1) plotter.add_mesh(cube, color='r', label='Cube') assert plotter.legend is None plotter.add_legend(bcolor='w') assert isinstance(plotter.legend, vtk.vtkActor2D) plotter.show() def test_add_axes_twice(): plotter = pv.Plotter() plotter.add_axes() plotter.add_axes(interactive=True) plotter.show() def test_hide_axes(): plotter = pv.Plotter() plotter.add_axes() plotter.hide_axes() plotter.show() def test_add_axes_parameters(): plotter = pv.Plotter() plotter.add_axes() plotter.add_axes( line_width=5, cone_radius=0.6, shaft_length=0.7, tip_length=0.3, ambient=0.5, label_size=(0.4, 0.16), viewport=(0, 0, 0.4, 0.4), ) plotter.show() def test_show_axes_all(): plotter = pv.Plotter() plotter.show_axes_all() plotter.show() def test_hide_axes_all(): plotter = pv.Plotter() plotter.hide_axes_all() plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_isometric_view_interactive(sphere): plotter_iso = pv.Plotter() plotter_iso.add_mesh(sphere) plotter_iso.camera_position = 'xy' cpos_old = plotter_iso.camera_position plotter_iso.isometric_view_interactive() assert plotter_iso.camera_position != cpos_old def test_add_point_labels(): plotter = pv.Plotter() # cannot use random points with image regression points = np.array([[0, 0, 0], [1, 0, 0], [0, 1, 0], [1, 1, 0], [0.5, 0.5, 0.5], [1, 1, 1]]) n = points.shape[0] with pytest.raises(ValueError): # noqa: PT011 plotter.add_point_labels(points, range(n - 1)) plotter.add_point_labels(points, range(n), show_points=True, point_color='r', point_size=10) plotter.add_point_labels( points - 1, range(n), show_points=False, point_color='r', point_size=10, ) plotter.show() @pytest.mark.parametrize('always_visible', [False, True]) def test_add_point_labels_always_visible(always_visible): # just make sure it runs without exception plotter = pv.Plotter() plotter.add_point_labels( np.array([[0.0, 0.0, 0.0]]), ['hello world'], always_visible=always_visible, ) plotter.show() @pytest.mark.parametrize('shape', [None, 'rect', 'rounded_rect']) @pytest.mark.usefixtures('verify_image_cache') def test_add_point_labels_shape(shape): plotter = pv.Plotter() plotter.add_point_labels(np.array([[0.0, 0.0, 0.0]]), ['hello world'], shape=shape) plotter.show() @pytest.mark.parametrize('justification_horizontal', ['left', 'center', 'right']) @pytest.mark.parametrize('justification_vertical', ['bottom', 'center', 'top']) def test_add_point_labels_justification(justification_horizontal, justification_vertical): plotter = pv.Plotter() plotter.add_point_labels( np.array([[0.0, 0.0, 0.0]]), ['hello world'], justification_horizontal=justification_horizontal, justification_vertical=justification_vertical, shape_opacity=0.0, background_color='grey', background_opacity=1.0, ) plotter.show() def test_set_background(): plotter = pv.Plotter() plotter.set_background('k') plotter.background_color = 'yellow' plotter.set_background([0, 0, 0], top=[1, 1, 1]) # Gradient _ = plotter.background_color plotter.show() plotter = pv.Plotter(shape=(1, 2)) plotter.set_background('orange') for renderer in plotter.renderers: assert renderer.GetBackground() == pv.Color('orange') plotter.show() plotter = pv.Plotter(shape=(1, 2)) plotter.subplot(0, 1) plotter.set_background('orange', all_renderers=False) assert plotter.renderers[0].GetBackground() != pv.Color('orange') assert plotter.renderers[1].GetBackground() == pv.Color('orange') plotter.show() def test_add_points(): plotter = pv.Plotter() points = np.array([[0, 0, 0], [1, 0, 0], [0, 1, 0], [1, 1, 0], [0.5, 0.5, 0.5], [1, 1, 1]]) n = points.shape[0] plotter.add_points( points, scalars=np.arange(n), cmap=None, flip_scalars=True, show_scalar_bar=False, ) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_key_press_event(): plotter = pv.Plotter() plotter.key_press_event(None, None) plotter.close() @pytest.mark.usefixtures('no_images_to_verify') def test_enable_picking_gc(): plotter = pv.Plotter() sphere = pv.Sphere() plotter.add_mesh(sphere) plotter.enable_cell_picking() plotter.close() @pytest.mark.usefixtures('no_images_to_verify') def test_left_button_down(): plotter = pv.Plotter() attr = ( 'GetOffScreenFramebuffer' if pyvista.vtk_version_info < (9, 1) else 'GetRenderFramebuffer' ) if hasattr(renwin := plotter.render_window, attr): if not getattr(renwin, attr)().GetFBOIndex(): # This only fails for VTK<9.2.3 with pytest.raises(ValueError, match='Invoking helper with no framebuffer'): plotter.left_button_down(None, None) else: plotter.left_button_down(None, None) plotter.close() def test_show_axes(): plotter = pv.Plotter() plotter.show_axes() plotter.show() def test_plot_cell_data(sphere, verify_image_cache): verify_image_cache.windows_skip_image_cache = True plotter = pv.Plotter() scalars = np.arange(sphere.n_faces_strict) plotter.add_mesh( sphere, interpolate_before_map=True, scalars=scalars, n_colors=10, rng=sphere.n_faces_strict, show_scalar_bar=False, ) plotter.show() def test_plot_clim(sphere): plotter = pv.Plotter() scalars = np.arange(sphere.n_faces_strict) plotter.add_mesh( sphere, interpolate_before_map=True, scalars=scalars, n_colors=5, clim=10, show_scalar_bar=False, ) assert plotter.mapper.GetScalarRange() == (-10, 10) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_invalid_n_arrays(sphere): plotter = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 plotter.add_mesh(sphere, scalars=np.arange(10)) def test_plot_arrow(): cent = np.array([0, 0, 0]) direction = np.array([1, 0, 0]) pv.plot_arrows(cent, direction) def test_plot_arrows(): cent = np.array([[0, 0, 0], [1, 0, 0]]) direction = np.array([[1, 1, 1], [-1, -1, -1]]) pv.plot_arrows(cent, direction) def test_add_arrows(): vector = np.array([1, 0, 0]) center = np.array([0, 0, 0]) plotter = pv.Plotter() plotter.add_arrows(cent=center, direction=vector, mag=2.2, color='#009900') plotter.show() def test_axes(): plotter = pv.Plotter() plotter.add_orientation_widget(pv.Cube(), color='b') plotter.add_mesh(pv.Cube()) plotter.show() def test_box_axes(verify_image_cache): verify_image_cache.high_variance_test = True plotter = pv.Plotter() def _test_add_axes_box(): plotter.add_axes(box=True) if pv._version.version_info[:2] > (0, 47): msg = 'Convert error this function' raise RuntimeError(msg) if pv._version.version_info[:2] > (0, 48): msg = 'Remove this function' raise RuntimeError(msg) with pytest.warns( pv.PyVistaDeprecationWarning, match='`box` is deprecated. Use `add_box_axes` or `add_color_box_axes` method instead.', ): _test_add_axes_box() plotter.add_mesh(pv.Sphere()) plotter.show() def test_box_axes_color_box(): plotter = pv.Plotter() def _test_add_axes_color_box(): plotter.add_axes(box=True, box_args={'color_box': True}) if pv._version.version_info[:2] > (0, 47): msg = 'Convert error this function' raise RuntimeError(msg) if pv._version.version_info[:2] > (0, 48): msg = 'Remove this function' raise RuntimeError(msg) with pytest.warns( pv.PyVistaDeprecationWarning, match='`box` is deprecated. Use `add_box_axes` or `add_color_box_axes` method instead.', ): _test_add_axes_color_box() plotter.add_mesh(pv.Sphere()) plotter.show() def test_add_box_axes(): plotter = pv.Plotter() plotter.add_orientation_widget(pv.Sphere(), color='b') plotter.add_box_axes() plotter.add_mesh(pv.Sphere()) plotter.show() def test_add_north_arrow(): plotter = pv.Plotter() plotter.add_north_arrow_widget(viewport=(0, 0, 0.5, 0.5)) plotter.add_mesh(pv.Arrow(direction=(0, 1, 0))) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_screenshot(tmpdir): plotter = pv.Plotter() plotter.add_mesh(pv.Sphere()) img = plotter.screenshot(transparent_background=False) assert np.any(img) img_again = plotter.screenshot() assert np.any(img_again) filename = str(tmpdir.mkdir('tmpdir').join('export-graphic.svg')) plotter.save_graphic(filename) # test window and array size w, h = 20, 10 img = plotter.screenshot(transparent_background=False, window_size=(w, h)) assert img.shape == (h, w, 3) img = plotter.screenshot(transparent_background=True, window_size=(w, h)) assert img.shape == (h, w, 4) # check error before first render plotter = pv.Plotter(off_screen=False) plotter.add_mesh(pv.Sphere()) with pytest.raises(RuntimeError): plotter.screenshot() @pytest.mark.usefixtures('no_images_to_verify') def test_screenshot_scaled(): # FYI: no regression tests because show() is not called factor = 2 plotter = pv.Plotter(image_scale=factor) width, height = plotter.window_size plotter.add_mesh(pv.Sphere()) img = plotter.screenshot(transparent_background=False) assert np.any(img) assert img.shape == (width * factor, height * factor, 3) img_again = plotter.screenshot(scale=3) assert np.any(img_again) assert img_again.shape == (width * 3, height * 3, 3) assert plotter.image_scale == factor, 'image_scale leaked from screenshot context' img = plotter.image assert img.shape == (width * factor, height * factor, 3) w, h = 20, 10 factor = 4 plotter.image_scale = factor img = plotter.screenshot(transparent_background=False, window_size=(w, h)) assert img.shape == (h * factor, w * factor, 3) img = plotter.screenshot(transparent_background=True, window_size=(w, h), scale=5) assert img.shape == (h * 5, w * 5, 4) assert plotter.image_scale == factor, 'image_scale leaked from screenshot context' with pytest.raises(ValueError): # noqa: PT011 plotter.image_scale = 0.5 plotter.close() @pytest.mark.usefixtures('no_images_to_verify') def test_screenshot_altered_window_size(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.window_size = (800, 800) a = plotter.screenshot() assert a.shape == (800, 800, 3) # plotter.show(auto_close=False) # for image regression test plotter.window_size = (1000, 1000) b = plotter.screenshot() assert b.shape == (1000, 1000, 3) # plotter.show(auto_close=False) # for image regression test d = plotter.screenshot(window_size=(600, 600)) assert d.shape == (600, 600, 3) # plotter.show() # for image regression test plotter.close() def test_screenshot_bytes(): # Test screenshot to bytes object buffer = io.BytesIO() plotter = pv.Plotter(off_screen=True) plotter.add_mesh(pv.Sphere()) plotter.show(screenshot=buffer) buffer.seek(0) im = Image.open(buffer) assert im.format == 'PNG' @pytest.mark.usefixtures('no_images_to_verify') def test_screenshot_rendering(tmpdir): plotter = pv.Plotter() plotter.add_mesh(examples.load_airplane(), smooth_shading=True) filename = str(tmpdir.mkdir('tmpdir').join('export-graphic.svg')) assert plotter._first_time plotter.save_graphic(filename) assert not plotter._first_time @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize('ext', SUPPORTED_FORMATS) def test_save_screenshot(tmpdir, sphere, ext): filename = str(tmpdir.mkdir('tmpdir').join('tmp' + ext)) plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.screenshot(filename) assert Path(filename).is_file() assert pathlib.Path(filename).stat().st_size def test_scalars_by_name(verify_image_cache): verify_image_cache.windows_skip_image_cache = True plotter = pv.Plotter() data = examples.load_uniform() plotter.add_mesh(data, scalars='Spatial Cell Data') plotter.show() def test_multi_block_plot(verify_image_cache): verify_image_cache.windows_skip_image_cache = True multi = pv.MultiBlock() multi.append(examples.load_rectilinear()) uni = examples.load_uniform() arr = np.random.default_rng().random(uni.n_cells) uni.cell_data.set_array(arr, 'Random Data') multi.append(uni) # And now add a data set without the desired array and a NULL component multi.append(examples.load_airplane()) # missing data should still plot multi.plot(scalars='Random Data') multi.plot(multi_colors=True) def test_clear(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.clear() plotter.show() def test_plot_texture(): """Test adding a texture to a plot""" globe = examples.load_globe() texture = examples.load_globe_texture() plotter = pv.Plotter() plotter.add_mesh(globe, texture=texture) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.skipif(not HAS_IMAGEIO, reason='Requires imageio') def test_plot_numpy_texture(): """Text adding a np.ndarray texture to a plot""" globe = examples.load_globe() texture_np = np.asarray(imageio.v2.imread(examples.mapfile)) plotter = pv.Plotter() plotter.add_mesh(globe, texture=texture_np) @pytest.mark.skipif(not HAS_IMAGEIO, reason='Requires imageio') def test_read_texture_from_numpy(): """Test adding a texture to a plot""" globe = examples.load_globe() texture = numpy_to_texture(imageio.v2.imread(examples.mapfile)) plotter = pv.Plotter() plotter.add_mesh(globe, texture=texture) plotter.show() def _make_rgb_dataset(dtype: str, return_composite: bool, scalars: str): def _dtype_convert_func(dtype): # Convert color to the specified dtype if dtype == 'float': def as_dtype(color: tuple[float, float, float]): return pv.Color(color).float_rgb elif dtype == 'int': def as_dtype(color: tuple[float, float, float]): return pv.Color(color).int_rgb elif dtype == 'uint8': def as_dtype(color: tuple[float, float, float]): return np.array(pv.Color(color).int_rgb, dtype=np.uint8) else: raise NotImplementedError return as_dtype def _make_polys(): # Create 3 separate PolyData with one quad cell each faces = [4, 0, 1, 2, 3] poly1 = pv.PolyData( [[1.0, 0.0, 0.0], [1.0, 1.0, 0.0], [1.0, 1.0, 1.0], [1.0, 0.0, 1.0]], faces ) poly2 = pv.PolyData( [[0.0, 1.0, 1.0], [0.0, 1.0, 0.0], [1.0, 1.0, 0.0], [1.0, 1.0, 1.0]], faces ) poly3 = pv.PolyData( [[0.0, 0.0, 1.0], [0.0, 1.0, 1.0], [1.0, 1.0, 1.0], [1.0, 0.0, 1.0]], faces ) return poly1, poly2, poly3 poly1, poly2, poly3 = _make_polys() dtype_convert_func = _dtype_convert_func(dtype) RED = dtype_convert_func((1.0, 0.0, 0.0)) GREEN = dtype_convert_func((0.0, 1.0, 0.0)) BLUE = dtype_convert_func((0.0, 0.0, 1.0)) # Color the polydata cells poly1[scalars] = [RED] poly2[scalars] = [GREEN] poly3[scalars] = [BLUE] dataset = pv.MultiBlock((poly1, poly2, poly3)) # Make sure the dataset is as expected if return_composite: assert isinstance(dataset, pv.MultiBlock) assert all(np.dtype(block[scalars].dtype) == np.dtype(dtype) for block in dataset) assert all(block.array_names == [scalars] for block in dataset) else: # Merge and return dataset = pv.merge(dataset) assert isinstance(dataset, pv.PolyData) assert np.dtype(dataset[scalars].dtype) == np.dtype(dtype) assert dataset.array_names == [scalars] return dataset # check_gc fails for polydata (suspected memory leak with pv.merge) @pytest.mark.skip_check_gc @pytest.mark.parametrize('composite', [True, False], ids=['composite', 'polydata']) @pytest.mark.parametrize('dtype', ['float', 'int', 'uint8']) def test_plot_rgb(composite, dtype): scalars = 'face_colors' dataset = _make_rgb_dataset(dtype, return_composite=composite, scalars=scalars) plotter = pv.Plotter() actor = plotter.add_mesh(dataset, scalars=scalars, rgb=True) actor.prop.lighting = False plotter.show() # check_gc fails for polydata (suspected memory leak with pv.merge) @pytest.mark.skip_check_gc @pytest.mark.parametrize('scalars', ['_rgb', '_rgba']) @pytest.mark.parametrize('composite', [True, False], ids=['composite', 'polydata']) def test_plot_rgb_implicit(composite, scalars): dataset = _make_rgb_dataset(dtype='uint8', return_composite=composite, scalars=scalars) plotter = pv.Plotter() actor = plotter.add_mesh(dataset) actor.prop.lighting = False plotter.show() def test_vector_array_with_points(multicomp_poly): """Test using vector valued data with and without component arg.""" # test no component argument pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_points') pl.camera_position = 'xy' pl.camera.tight() pl.show() # test component argument pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_points', component=0) pl.camera_position = 'xy' pl.camera.tight() pl.show() @skip_windows_mesa def test_vector_array_with_cells(multicomp_poly): """Test using vector valued data with and without component arg.""" pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_cells') pl.camera_position = 'xy' pl.camera.tight() pl.show() # test component argument pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_cells', component=0) pl.camera_position = 'xy' pl.camera.tight() pl.show() def test_vector_array(multicomp_poly): """Test using vector valued data for image regression.""" pl = pv.Plotter(shape=(2, 2)) pl.subplot(0, 0) pl.add_mesh(multicomp_poly, scalars='vector_values_points', show_scalar_bar=False) pl.camera_position = 'xy' pl.camera.tight() pl.subplot(0, 1) pl.add_mesh(multicomp_poly.copy(), scalars='vector_values_points', component=0) pl.subplot(1, 0) pl.add_mesh(multicomp_poly.copy(), scalars='vector_values_points', component=1) pl.subplot(1, 1) pl.add_mesh(multicomp_poly.copy(), scalars='vector_values_points', component=2) pl.link_views() pl.show() @skip_windows_mesa def test_vector_plotting_doesnt_modify_data(multicomp_poly): """Test that the operations in plotting do not modify the data in the mesh.""" copy_vector_values_points = multicomp_poly['vector_values_points'].copy() copy_vector_values_cells = multicomp_poly['vector_values_cells'].copy() # test that adding a vector with no component parameter to a Plotter instance # does not modify it. pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_points') pl.show() assert np.array_equal(multicomp_poly['vector_values_points'], copy_vector_values_points) pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_cells') pl.show() assert np.array_equal(multicomp_poly['vector_values_cells'], copy_vector_values_cells) # test that adding a vector with a component parameter to a Plotter instance # does not modify it. pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_points', component=0) pl.show() assert np.array_equal(multicomp_poly['vector_values_points'], copy_vector_values_points) pl = pv.Plotter() pl.add_mesh(multicomp_poly, scalars='vector_values_cells', component=0) pl.show() assert np.array_equal(multicomp_poly['vector_values_cells'], copy_vector_values_cells) @pytest.mark.usefixtures('no_images_to_verify') def test_vector_array_fail_with_incorrect_component(multicomp_poly): """Test failure modes of component argument.""" p = pv.Plotter() # Non-Integer with pytest.raises(TypeError): p.add_mesh(multicomp_poly, scalars='vector_values_points', component=1.5) # Component doesn't exist p = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 p.add_mesh(multicomp_poly, scalars='vector_values_points', component=3) # Component doesn't exist p = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 p.add_mesh(multicomp_poly, scalars='vector_values_points', component=-1) def test_camera(sphere): plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.view_isometric() plotter.reset_camera() plotter.view_xy() plotter.view_xz() plotter.view_yz() plotter.add_mesh(examples.load_uniform(), reset_camera=True, culling=True) plotter.view_xy(negative=True) plotter.view_xz(negative=True) plotter.view_yz(negative=True) plotter.show() plotter = pv.Plotter() plotter.add_mesh(sphere) plotter.camera.zoom(5) plotter.camera.up = 0, 0, 10 plotter.show() def test_multi_renderers(verify_image_cache): # TODO: Change this to (9, 6, 0) when VTK 9.6 is released if pyvista.vtk_version_info < (9, 5, 99): # Axis labels changed substantially in VTK 9.6 verify_image_cache.skip = True plotter = pv.Plotter(shape=(2, 2)) plotter.subplot(0, 0) plotter.add_text('Render Window 0', font_size=30) sphere = pv.Sphere() plotter.add_mesh(sphere, scalars=sphere.points[:, 2], show_scalar_bar=False) plotter.add_scalar_bar('Z', vertical=True) plotter.subplot(0, 1) plotter.add_text('Render Window 1', font_size=30) plotter.add_mesh(pv.Cube(), show_edges=True) plotter.subplot(1, 0) plotter.add_text('Render Window 2', font_size=30) plotter.add_mesh(pv.Arrow(), color='y', show_edges=True) plotter.subplot(1, 1) plotter.add_text('Render Window 3', position=(0.0, 0.0), font_size=30, viewport=True) plotter.add_mesh(pv.Cone(), color='g', show_edges=True, culling=True) plotter.add_bounding_box(render_lines_as_tubes=True, line_width=5) plotter.show_bounds(all_edges=True) plotter.update_bounds_axes() plotter.show() def test_multi_renderers_subplot_ind_2x1(): # Test subplot indices (2 rows by 1 column) plotter = pv.Plotter(shape=(2, 1)) # First row plotter.subplot(0, 0) plotter.add_mesh(pv.Sphere()) # Second row plotter.subplot(1, 0) plotter.add_mesh(pv.Cube()) plotter.show() def test_multi_renderers_subplot_ind_1x2(): # Test subplot indices (1 row by 2 columns) plotter = pv.Plotter(shape=(1, 2)) # First column plotter.subplot(0, 0) plotter.add_mesh(pv.Sphere()) # Second column plotter.subplot(0, 1) plotter.add_mesh(pv.Cube()) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_multi_renderers_bad_indices(): # Test bad indices plotter = pv.Plotter(shape=(1, 2)) with pytest.raises(IndexError): plotter.subplot(1, 0) def test_multi_renderers_subplot_ind_3x1(): # Test subplot 3 on left, 1 on right plotter = pv.Plotter(shape='3|1') # First column plotter.subplot(0) plotter.add_mesh(pv.Sphere()) plotter.subplot(1) plotter.add_mesh(pv.Cube()) plotter.subplot(2) plotter.add_mesh(pv.Cylinder()) plotter.subplot(3) plotter.add_mesh(pv.Cone()) plotter.show() def test_multi_renderers_subplot_ind_3x1_splitting_pos(): # Test subplot 3 on top, 1 on bottom plotter = pv.Plotter(shape='3/1', splitting_position=0.5) # First column plotter.subplot(0) plotter.add_mesh(pv.Sphere()) plotter.subplot(1) plotter.add_mesh(pv.Cube()) plotter.subplot(2) plotter.add_mesh(pv.Cylinder()) plotter.subplot(3) plotter.add_mesh(pv.Cone()) plotter.show() def test_multi_renderers_subplot_ind_1x3(): # Test subplot 3 on bottom, 1 on top plotter = pv.Plotter(shape='1|3') # First column plotter.subplot(0) plotter.add_mesh(pv.Sphere()) plotter.subplot(1) plotter.add_mesh(pv.Cube()) plotter.subplot(2) plotter.add_mesh(pv.Cylinder()) plotter.subplot(3) plotter.add_mesh(pv.Cone()) plotter.show() def test_subplot_groups(): plotter = pv.Plotter(shape=(3, 3), groups=[(1, [1, 2]), (np.s_[:], 0)]) plotter.subplot(0, 0) plotter.add_mesh(pv.Sphere()) plotter.subplot(0, 1) plotter.add_mesh(pv.Cube()) plotter.subplot(0, 2) plotter.add_mesh(pv.Arrow()) plotter.subplot(1, 1) plotter.add_mesh(pv.Cylinder()) plotter.subplot(2, 1) plotter.add_mesh(pv.Cone()) plotter.subplot(2, 2) plotter.add_mesh(pv.Box()) plotter.show() @pytest.mark.usefixtures('no_images_to_verify') def test_subplot_groups_fail(): # Test group overlap with pytest.raises(ValueError): # noqa: PT011 # Partial overlap pv.Plotter(shape=(3, 3), groups=[([1, 2], [0, 1]), ([0, 1], [1, 2])]) with pytest.raises(ValueError): # noqa: PT011 # Full overlap (inner) pv.Plotter(shape=(4, 4), groups=[(np.s_[:], np.s_[:]), ([1, 2], [1, 2])]) with pytest.raises(ValueError): # noqa: PT011 # Full overlap (outer) pv.Plotter(shape=(4, 4), groups=[(1, [1, 2]), ([0, 3], np.s_[:])]) @pytest.mark.skip_windows def test_link_views(sphere): plotter = pv.Plotter(shape=(1, 4)) plotter.subplot(0, 0) plotter.add_mesh(sphere, smooth_shading=False, show_edges=False) plotter.subplot(0, 1) plotter.add_mesh(sphere, smooth_shading=True, show_edges=False) plotter.subplot(0, 2) plotter.add_mesh(sphere, smooth_shading=False, show_edges=True) plotter.subplot(0, 3) plotter.add_mesh(sphere, smooth_shading=True, show_edges=True) with pytest.raises(TypeError): plotter.link_views(views='foo') plotter.link_views([0, 1]) plotter.link_views() with pytest.raises(TypeError): plotter.unlink_views(views='foo') plotter.unlink_views([0, 1]) plotter.unlink_views(2) plotter.unlink_views() plotter.show() @pytest.mark.skip_windows @pytest.mark.usefixtures('verify_image_cache') def test_link_views_camera_set(): p = pv.Plotter(shape=(1, 2)) p.add_mesh(pv.Cone()) assert not p.renderer.camera_set p.subplot(0, 1) p.add_mesh(pv.Cube()) assert not p.renderer.camera_set p.link_views() # make sure the default isometric view is used for renderer in p.renderers: assert not renderer.camera_set p.show() p = pv.Plotter(shape=(1, 2)) p.add_mesh(pv.Cone()) p.subplot(0, 1) p.add_mesh(pv.Cube()) p.link_views() p.unlink_views() for renderer in p.renderers: assert not renderer.camera_set p.show() wavelet = pv.Wavelet().clip('x') p = pv.Plotter(shape=(1, 2)) p.add_mesh(wavelet, color='red') p.subplot(0, 1) p.add_mesh(wavelet, color='red') p.link_views() p.camera_position = [(55.0, 16, 31), (-5.0, 0.0, 0.0), (-0.22, 0.97, -0.09)] p.show() def test_orthographic_slicer(uniform): uniform.set_active_scalars('Spatial Cell Data') slices = uniform.slice_orthogonal() # Orthographic Slicer p = pv.Plotter(shape=(2, 2)) p.subplot(1, 1) p.add_mesh(slices, clim=uniform.get_data_range()) p.add_axes() p.enable() p.subplot(0, 0) p.add_mesh(slices['XY']) p.view_xy() p.disable() p.subplot(0, 1) p.add_mesh(slices['XZ']) p.view_xz(negative=True) p.disable() p.subplot(1, 0) p.add_mesh(slices['YZ']) p.view_yz() p.disable() p.show() def test_remove_actor(uniform): plotter = pv.Plotter() plotter.add_mesh(uniform.copy(), name='data') plotter.add_mesh(uniform.copy(), name='data') plotter.add_mesh(uniform.copy(), name='data') plotter.show() def test_image_properties(): mesh = examples.load_uniform() p = pv.Plotter() p.add_mesh(mesh) p.show(auto_close=False) # DO NOT close plotter # Get RGB image _ = p.image # Get the depth image _ = p.get_image_depth() p.close() p = pv.Plotter() p.add_mesh(mesh) p.show() # close plotter # Get RGB image _ = p.image # verify property matches method while testing both available assert np.allclose(p.image_depth, p.get_image_depth(), equal_nan=True) p.close() # gh-920 rr = np.array([[-0.5, -0.5, 0], [-0.5, 0.5, 1], [0.5, 0.5, 0], [0.5, -0.5, 1]]) tris = np.array([[3, 0, 2, 1], [3, 2, 0, 3]]) mesh = pv.PolyData(rr, tris) p = pv.Plotter() p.add_mesh(mesh, color=True) p.renderer.camera_position = (0.0, 0.0, 1.0) p.renderer.ResetCamera() p.enable_parallel_projection() assert p.renderer.camera_set p.show(interactive=False, auto_close=False) img = p.get_image_depth(fill_value=0.0) rng = np.ptp(img) assert 0.3 < rng < 0.4, rng # 0.3313504 in testing p.close() def test_volume_rendering_from_helper(uniform, verify_image_cache): verify_image_cache.windows_skip_image_cache = True uniform.plot(volume=True, opacity='linear') @skip_windows_mesa # due to opacity def test_volume_rendering_from_plotter(uniform): plotter = pv.Plotter() plotter.add_volume(uniform, opacity='sigmoid', cmap='jet', n_colors=15) plotter.show() @skip_windows_mesa # due to opacity @skip_9_0_X def test_volume_rendering_rectilinear(uniform): grid = uniform.cast_to_rectilinear_grid() plotter = pv.Plotter() plotter.add_volume(grid, opacity='sigmoid', cmap='jet', n_colors=15) plotter.show() plotter = pv.Plotter() plotter.add_volume(grid) plotter.show() plotter = pv.Plotter() with pytest.raises(TypeError): plotter.add_volume(grid, mapper='fixed_point') plotter.close() @skip_windows_mesa # due to opacity @pytest.mark.parametrize('mapper', ['fixed_point', 'gpu', 'open_gl', 'smart']) def test_volume_rendering_mappers_image_data(mapper): image = pv.ImageData(dimensions=(50, 50, 50)) image['scalars'] = -image.x plotter = pv.Plotter() plotter.add_volume(image, mapper=mapper) plotter.show() @pytest.mark.skip_windows def test_multiblock_volume_rendering(uniform): ds_a = uniform.copy() ds_b = uniform.copy() ds_b.origin = (9.0, 0.0, 0.0) ds_c = uniform.copy() ds_c.origin = (0.0, 9.0, 0.0) ds_d = uniform.copy() ds_d.origin = (9.0, 9.0, 0.0) data = pv.MultiBlock( dict( a=ds_a, b=ds_b, c=ds_c, d=ds_d, ), ) data['a'].rename_array('Spatial Point Data', 'a') data['b'].rename_array('Spatial Point Data', 'b') data['c'].rename_array('Spatial Point Data', 'c') data['d'].rename_array('Spatial Point Data', 'd') data.plot(volume=True, multi_colors=True) def test_array_volume_rendering(uniform, verify_image_cache): verify_image_cache.windows_skip_image_cache = True arr = uniform['Spatial Point Data'].reshape(uniform.dimensions) pv.plot(arr, volume=True, opacity='linear') def test_plot_compare_four(): # Really just making sure no errors are thrown mesh = examples.load_uniform() data_a = mesh.contour() data_b = mesh.threshold_percent(0.5) data_c = mesh.decimate_boundary(0.5) data_d = mesh.glyph(scale=False, orient=False) pv.plot_compare_four( data_a, data_b, data_c, data_d, display_kwargs={'color': 'w'}, ) def test_plot_depth_peeling(): mesh = examples.load_airplane() p = pv.Plotter() p.add_mesh(mesh) p.enable_depth_peeling() p.disable_depth_peeling() p.show() @pytest.mark.skip_windows('No testing on windows for EDL') def test_plot_eye_dome_lighting_plot(airplane): airplane.plot(eye_dome_lighting=True) @pytest.mark.skip_windows('No testing on windows for EDL') def test_plot_eye_dome_lighting_plotter(airplane): p = pv.Plotter() p.add_mesh(airplane) p.enable_eye_dome_lighting() p.show() @pytest.mark.skip_windows('No testing on windows for EDL') def test_plot_eye_dome_lighting_enable_disable(airplane): p = pv.Plotter() p.add_mesh(airplane) p.enable_eye_dome_lighting() p.disable_eye_dome_lighting() p.show() @pytest.mark.skip_windows def test_opacity_by_array_direct(plane, verify_image_cache): # VTK regression 9.0.1 --> 9.1.0 verify_image_cache.high_variance_test = True # test with opacity parm as an array, both cell and point sized plane_shift = plane.translate((0, 0, 1), inplace=False) pl = pv.Plotter() pl.add_mesh(plane, color='b', opacity=np.linspace(0, 1, plane.n_points), show_edges=True) pl.add_mesh( plane_shift, color='r', opacity=np.linspace(0, 1, plane.n_cells), show_edges=True, ) pl.show() @skip_windows_mesa def test_opacity_by_array(uniform): # Test with opacity array opac = uniform['Spatial Point Data'] / uniform['Spatial Point Data'].max() uniform['opac'] = opac p = pv.Plotter() p.add_mesh(uniform, scalars='Spatial Point Data', opacity='opac') p.show() @skip_windows_mesa def test_opacity_by_array_uncertainty(uniform): # Test with uncertainty array (transparency) opac = uniform['Spatial Point Data'] / uniform['Spatial Point Data'].max() uniform['unc'] = opac p = pv.Plotter() p.add_mesh(uniform, scalars='Spatial Point Data', opacity='unc', use_transparency=True) p.show() def test_opacity_by_array_user_transform(uniform, verify_image_cache): verify_image_cache.high_variance_test = True uniform['Spatial Point Data'] /= uniform['Spatial Point Data'].max() # Test with user defined transfer function opacities = [0, 0.2, 0.9, 0.2, 0.1] p = pv.Plotter() p.add_mesh(uniform, scalars='Spatial Point Data', opacity=opacities) p.show() @pytest.mark.usefixtures('no_images_to_verify') def test_opacity_mismatched_fail(uniform): opac = uniform['Spatial Point Data'] / uniform['Spatial Point Data'].max() uniform['unc'] = opac # Test using mismatched arrays p = pv.Plotter() with pytest.raises(ValueError): # noqa: PT011 # cell scalars vs point opacity p.add_mesh(uniform, scalars='Spatial Cell Data', opacity='unc') @skip_windows_mesa def test_opacity_by_array_preference(): tetra = pv.Tetrahedron() # 4 points, 4 cells opacities = np.linspace(0.2, 0.8, tetra.n_points) tetra.clear_data() tetra.point_data['scalars'] = tetra.cell_data['scalars'] = np.arange(tetra.n_points) tetra.point_data['opac'] = tetra.cell_data['opac'] = opacities # test opacity by key p = pv.Plotter() p.add_mesh(tetra.copy(), opacity='opac', preference='cell') p.add_mesh(tetra.translate((2, 0, 0), inplace=False), opacity='opac', preference='point') p.close() # test opacity by array p = pv.Plotter() p.add_mesh(tetra.copy(), opacity=opacities, preference='cell') p.add_mesh(tetra.translate((2, 0, 0), inplace=False), opacity=opacities, preference='point') p.show() @pytest.mark.usefixtures('no_images_to_verify') @pytest.mark.parametrize('mapping', [None, True, object()]) def test_opacity_transfer_functions_raises(mapping): with pytest.raises( TypeError, match=re.escape(f'Transfer function type ({type(mapping)}) not understood'), ): pv.opacity_transfer_function(mapping, n_colors=10) @pytest.mark.usefixtures('no_images_to_verify') def test_opacity_transfer_functions(): n = 256 mapping = pv.opacity_transfer_function('linear', n) assert len(mapping) == n mapping = pv.opacity_transfer_function('sigmoid_10', n) assert len(mapping) == n mapping = pv.opacity_transfer_function('foreground', n) assert len(mapping) == n mapping = pv.opacity_transfer_function('foreground', 5) assert np.array_equal(mapping, [0, 255, 255, 255, 255]) with pytest.raises(ValueError): # noqa: PT011 mapping = pv.opacity_transfer_function('foo', n) with pytest.raises(RuntimeError): mapping = pv.opacity_transfer_function(np.linspace(0, 1, 2 * n), n) foo = np.linspace(0, n, n) mapping = pv.opacity_transfer_function(foo, n) assert np.allclose(foo, mapping) foo = [0, 0.2, 0.9, 0.2, 0.1] mapping = pv.opacity_transfer_function(foo, n, interpolate=False) assert len(mapping) == n foo = [3, 5, 6, 10] mapping = pv.opacity_transfer_function(foo, n) assert len(mapping) == n @skip_windows_mesa @pytest.mark.parametrize( 'opacity', [ 'sigmoid', 'sigmoid_1', 'sigmoid_2', 'sigmoid_3', 'sigmoid_4', 'sigmoid_5', 'sigmoid_6', 'sigmoid_7', 'sigmoid_8', 'sigmoid_9', 'sigmoid_10', 'sigmoid_15', 'sigmoid_20', ], ) def test_plot_sigmoid_opacity_transfer_functions(uniform, opacity): pl = pv.Plotter() pl.add_volume(uniform, opacity=opacity) pl.show() def test_closing_and_mem_cleanup(verify_image_cache): verify_image_cache.windows_skip_image_cache = True verify_image_cache.skip = True n = 5 for _ in range(n): for _ in range(n): p = pv.Plotter() for k in range(n): p.add_mesh(pv.Sphere(radius=k)) p.show() pv.close_all() def test_above_below_scalar_range_annotations(): p = pv.Plotter() p.add_mesh( examples.load_uniform(), clim=[100, 500], cmap='viridis', below_color='blue', above_color='red', ) p.show() def test_user_annotations_scalar_bar_mesh(uniform): p = pv.Plotter() p.add_mesh(uniform, annotations={100.0: 'yum'}) p.show() def test_fixed_font_size_annotation_text_scaling_off(): p = pv.Plotter() sargs = {'title_font_size': 12, 'label_font_size': 10} p.add_mesh( examples.load_uniform(), clim=[100, 500], cmap='viridis', below_color='blue', above_color='red', annotations={300.0: 'yum'}, scalar_bar_args=sargs, ) p.show() def test_user_annotations_scalar_bar_volume(uniform, verify_image_cache): verify_image_cache.windows_skip_image_cache = True p = pv.Plotter() p.add_volume(uniform, scalars='Spatial Point Data', annotations={100.0: 'yum'}) p.show() @pytest.mark.usefixtures('no_images_to_verify') def test_user_matrix_volume(uniform): shear = np.eye(4) shear[0, 1] = 1 p = pv.Plotter() volume = p.add_volume(uniform, user_matrix=shear) np.testing.assert_almost_equal(volume.user_matrix, shear) match = 'Shape must be one of [(3, 3), (4, 4)].' with pytest.raises(ValueError, match=re.escape(match)): p.add_volume(uniform, user_matrix=np.eye(5)) with pytest.raises(TypeError): p.add_volume(uniform, user_matrix='invalid') @pytest.mark.usefixtures('no_images_to_verify') def test_user_matrix_mesh(sphere): shear = np.eye(4) shear[0, 1] = 1 p = pv.Plotter() actor = p.add_mesh(sphere, user_matrix=shear) np.testing.assert_almost_equal(actor.user_matrix, shear) match = 'Shape must be one of [(3, 3), (4, 4)].' with pytest.raises(ValueError, match=re.escape(match)): p.add_mesh(sphere, user_matrix=np.eye(5)) with pytest.raises(TypeError): p.add_mesh(sphere, user_matrix='invalid') def test_user_matrix_silhouette(airplane): matrix = [[-1, 0, 0, 1], [0, 1, 0, 2], [0, 0, -1, 3], [0, 0, 0, 1]] pl = pv.Plotter() pl.add_mesh( airplane, silhouette=dict(line_width=10), user_matrix=matrix, ) pl.show() @pytest.mark.usefixtures('no_images_to_verify') def test_scalar_bar_args_unmodified_add_mesh(sphere): sargs = {'vertical': True} sargs_copy = sargs.copy() p = pv.Plotter() p.add_mesh(sphere, scalar_bar_args=sargs) assert sargs == sargs_copy @pytest.mark.usefixtures('no_images_to_verify') def test_scalar_bar_args_unmodified_add_volume(uniform): sargs = {'vertical': True} sargs_copy = sargs.copy() p = pv.Plotter() p.add_volume(uniform, scalar_bar_args=sargs) assert sargs == sargs_copy def test_plot_string_array(verify_image_cache): verify_image_cache.windows_skip_image_cache = True mesh = examples.load_uniform() labels = np.empty(mesh.n_cells, dtype='