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 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
|
"""Test pyvista core utilities."""
from __future__ import annotations
import importlib
import json
import os
from pathlib import Path
import pickle
import shutil
from unittest import mock
import warnings
import numpy as np
import pytest
import vtk
import pyvista as pv
from pyvista import examples as ex
from pyvista.core.utilities import cells
from pyvista.core.utilities import fileio
from pyvista.core.utilities import fit_plane_to_points
from pyvista.core.utilities import transformations
from pyvista.core.utilities.arrays import _coerce_pointslike_arg
from pyvista.core.utilities.arrays import _coerce_transformlike_arg
from pyvista.core.utilities.arrays import _SerializedDictArray
from pyvista.core.utilities.arrays import copy_vtk_array
from pyvista.core.utilities.arrays import get_array
from pyvista.core.utilities.arrays import has_duplicates
from pyvista.core.utilities.arrays import raise_has_duplicates
from pyvista.core.utilities.arrays import vtk_id_list_to_array
from pyvista.core.utilities.arrays import vtkmatrix_from_array
from pyvista.core.utilities.docs import linkcode_resolve
from pyvista.core.utilities.fileio import get_ext
from pyvista.core.utilities.helpers import is_inside_bounds
from pyvista.core.utilities.misc import assert_empty_kwargs
from pyvista.core.utilities.misc import check_valid_vector
from pyvista.core.utilities.misc import has_module
from pyvista.core.utilities.misc import no_new_attr
from pyvista.core.utilities.observers import Observer
from pyvista.core.utilities.points import vector_poly_data
def test_version():
assert "major" in str(pv.vtk_version_info)
ver = vtk.vtkVersion()
assert ver.GetVTKMajorVersion() == pv.vtk_version_info.major
assert ver.GetVTKMinorVersion() == pv.vtk_version_info.minor
assert ver.GetVTKBuildVersion() == pv.vtk_version_info.micro
ver_tup = (
ver.GetVTKMajorVersion(),
ver.GetVTKMinorVersion(),
ver.GetVTKBuildVersion(),
)
assert ver_tup == pv.vtk_version_info
assert pv.vtk_version_info >= (0, 0, 0)
def test_createvectorpolydata_error():
orig = np.random.default_rng().random((3, 1))
vec = np.random.default_rng().random((3, 1))
with pytest.raises(ValueError): # noqa: PT011
vector_poly_data(orig, vec)
def test_createvectorpolydata_1D():
orig = np.random.default_rng().random(3)
vec = np.random.default_rng().random(3)
vdata = vector_poly_data(orig, vec)
assert np.any(vdata.points)
assert np.any(vdata.point_data['vectors'])
def test_createvectorpolydata():
orig = np.random.default_rng().random((100, 3))
vec = np.random.default_rng().random((100, 3))
vdata = vector_poly_data(orig, vec)
assert np.any(vdata.points)
assert np.any(vdata.point_data['vectors'])
@pytest.mark.parametrize(
('path', 'target_ext'),
[
("/data/mesh.stl", ".stl"),
("/data/image.nii.gz", '.nii.gz'),
("/data/other.gz", ".gz"),
],
)
def test_get_ext(path, target_ext):
ext = get_ext(path)
assert ext == target_ext
@pytest.mark.parametrize('use_pathlib', [True, False])
def test_read(tmpdir, use_pathlib):
fnames = (ex.antfile, ex.planefile, ex.hexbeamfile, ex.spherefile, ex.uniformfile, ex.rectfile)
if use_pathlib:
fnames = [Path(fname) for fname in fnames]
types = (
pv.PolyData,
pv.PolyData,
pv.UnstructuredGrid,
pv.PolyData,
pv.ImageData,
pv.RectilinearGrid,
)
for i, filename in enumerate(fnames):
obj = fileio.read(filename)
assert isinstance(obj, types[i])
# this is also tested for each mesh types init from file tests
filename = str(tmpdir.mkdir("tmpdir").join('tmp.npy'))
arr = np.random.default_rng().random((10, 10))
np.save(filename, arr)
with pytest.raises(IOError): # noqa: PT011
_ = pv.read(filename)
# read non existing file
with pytest.raises(IOError): # noqa: PT011
_ = pv.read('this_file_totally_does_not_exist.vtk')
# Now test reading lists of files as multi blocks
multi = pv.read(fnames)
assert isinstance(multi, pv.MultiBlock)
assert multi.n_blocks == len(fnames)
nested = [ex.planefile, [ex.hexbeamfile, ex.uniformfile]]
multi = pv.read(nested)
assert isinstance(multi, pv.MultiBlock)
assert multi.n_blocks == 2
assert isinstance(multi[1], pv.MultiBlock)
assert multi[1].n_blocks == 2
def test_read_force_ext(tmpdir):
fnames = (ex.antfile, ex.planefile, ex.hexbeamfile, ex.spherefile, ex.uniformfile, ex.rectfile)
types = (
pv.PolyData,
pv.PolyData,
pv.UnstructuredGrid,
pv.PolyData,
pv.ImageData,
pv.RectilinearGrid,
)
dummy_extension = '.dummy'
for fname, type_ in zip(fnames, types):
path = Path(fname)
root = str(path.parent / path.stem)
original_ext = path.suffix
_, name = os.path.split(root)
new_fname = tmpdir / name + '.' + dummy_extension
shutil.copy(fname, new_fname)
data = fileio.read(new_fname, force_ext=original_ext)
assert isinstance(data, type_)
@mock.patch('pyvista.BaseReader.read')
@mock.patch('pyvista.BaseReader.reader')
@mock.patch('pyvista.BaseReader.show_progress')
def test_read_progress_bar(mock_show_progress, mock_reader, mock_read):
"""Test passing attrs in read."""
pv.read(ex.antfile, progress_bar=True)
mock_show_progress.assert_called_once()
def test_read_force_ext_wrong_extension(tmpdir):
# try to read a .vtu file as .vts
# vtkXMLStructuredGridReader throws a VTK error about the validity of the XML file
# the returned dataset is empty
fname = tmpdir / 'airplane.vtu'
ex.load_airplane().cast_to_unstructured_grid().save(fname)
with warnings.catch_warnings():
warnings.simplefilter("ignore")
data = fileio.read(fname, force_ext='.vts')
assert data.n_points == 0
# try to read a .ply file as .vtm
# vtkXMLMultiBlockDataReader throws a VTK error about the validity of the XML file
# the returned dataset is empty
fname = ex.planefile
with warnings.catch_warnings():
warnings.simplefilter("ignore")
data = fileio.read(fname, force_ext='.vtm')
assert len(data) == 0
fname = ex.planefile
with pytest.raises(IOError): # noqa: PT011
fileio.read(fname, force_ext='.not_supported')
@mock.patch('pyvista.core.utilities.fileio.read_exodus')
def test_pyvista_read_exodus(read_exodus_mock):
# check that reading a file with extension .e calls `read_exodus`
# use the globefile as a dummy because pv.read() checks for the existence of the file
pv.read(ex.globefile, force_ext='.e')
args, kwargs = read_exodus_mock.call_args
filename = args[0]
assert filename == Path(ex.globefile)
def test_get_array_cell(hexbeam):
carr = np.random.default_rng().random(hexbeam.n_cells)
hexbeam.cell_data.set_array(carr, 'test_data')
data = get_array(hexbeam, 'test_data', preference='cell')
assert np.allclose(carr, data)
def test_get_array_point(hexbeam):
parr = np.random.default_rng().random(hexbeam.n_points)
hexbeam.point_data.set_array(parr, 'test_data')
data = get_array(hexbeam, 'test_data', preference='point')
assert np.allclose(parr, data)
oarr = np.random.default_rng().random(hexbeam.n_points)
hexbeam.point_data.set_array(oarr, 'other')
data = get_array(hexbeam, 'other')
assert np.allclose(oarr, data)
def test_get_array_field(hexbeam):
hexbeam.clear_data()
# no preference
farr = np.random.default_rng().random(hexbeam.n_points * hexbeam.n_cells)
hexbeam.field_data.set_array(farr, 'data')
data = get_array(hexbeam, 'data')
assert np.allclose(farr, data)
# preference and multiple data
hexbeam.point_data.set_array(np.random.default_rng().random(hexbeam.n_points), 'data')
data = get_array(hexbeam, 'data', preference='field')
assert np.allclose(farr, data)
def test_get_array_error(hexbeam):
parr = np.random.default_rng().random(hexbeam.n_points)
hexbeam.point_data.set_array(parr, 'test_data')
# invalid inputs
with pytest.raises(TypeError):
get_array(hexbeam, 'test_data', preference={'invalid'})
with pytest.raises(ValueError): # noqa: PT011
get_array(hexbeam, 'test_data', preference='invalid')
with pytest.raises(ValueError, match='`preference` must be'):
get_array(hexbeam, 'test_data', preference='row')
def test_get_array_none(hexbeam):
arr = get_array(hexbeam, 'foo')
assert arr is None
def get_array_vtk(hexbeam):
# test raw VTK input
grid_vtk = vtk.vtkUnstructuredGrid()
grid_vtk.DeepCopy(hexbeam)
get_array(grid_vtk, 'test_data')
get_array(grid_vtk, 'foo')
def test_is_inside_bounds():
data = ex.load_uniform()
bnds = data.bounds
assert is_inside_bounds((0.5, 0.5, 0.5), bnds)
assert not is_inside_bounds((12, 5, 5), bnds)
assert not is_inside_bounds((5, 12, 5), bnds)
assert not is_inside_bounds((5, 5, 12), bnds)
assert not is_inside_bounds((12, 12, 12), bnds)
def test_voxelize(uniform):
vox = pv.voxelize(uniform, 0.5)
assert vox.n_cells
def test_voxelize_non_uniform_density(uniform):
vox = pv.voxelize(uniform, [0.5, 0.3, 0.2])
assert vox.n_cells
vox = pv.voxelize(uniform, np.array([0.5, 0.3, 0.2]))
assert vox.n_cells
def test_voxelize_invalid_density(rectilinear):
# test error when density is not length-3
with pytest.raises(ValueError, match='not enough values to unpack'):
pv.voxelize(rectilinear, [0.5, 0.3])
# test error when density is not an array-like
with pytest.raises(TypeError, match='expected number or array-like'):
pv.voxelize(rectilinear, {0.5, 0.3})
def test_voxelize_throws_point_cloud(hexbeam):
mesh = pv.PolyData(hexbeam.points)
with pytest.raises(ValueError, match='must have faces'):
pv.voxelize(mesh)
def test_voxelize_volume_default_density(uniform):
expected = pv.voxelize_volume(uniform, density=uniform.length / 100).n_cells
actual = pv.voxelize_volume(uniform).n_cells
assert actual == expected
def test_voxelize_volume_invalid_density(rectilinear):
with pytest.raises(TypeError, match='expected number or array-like'):
pv.voxelize_volume(rectilinear, {0.5, 0.3})
def test_voxelize_volume_no_face_mesh(rectilinear):
with pytest.raises(ValueError, match='must have faces'):
pv.voxelize_volume(pv.PolyData())
def test_report():
report = pv.Report(gpu=True)
assert report is not None
assert "GPU Details : None" not in report.__repr__()
report = pv.Report(gpu=False)
assert report is not None
assert "GPU Details : None" in report.__repr__()
def test_line_segments_from_points():
points = np.array([[0, 0, 0], [1, 0, 0], [1, 0, 0], [1, 1, 0]])
poly = pv.line_segments_from_points(points)
assert poly.n_cells == 2
assert poly.n_points == 4
cells = poly.lines
assert np.allclose(cells[:3], [2, 0, 1])
assert np.allclose(cells[3:], [2, 2, 3])
def test_lines_from_points():
points = np.array([[0, 0, 0], [1, 0, 0], [1, 1, 0]])
poly = pv.lines_from_points(points)
assert poly.n_cells == 2
assert poly.n_points == 3
cells = poly.lines
assert np.allclose(cells[:3], [2, 0, 1])
assert np.allclose(cells[3:], [2, 1, 2])
def test_grid_from_sph_coords():
x = np.arange(0.0, 360.0, 40.0) # longitude
y = np.arange(0.0, 181.0, 60.0) # colatitude
z = [1] # elevation (radius)
g = pv.grid_from_sph_coords(x, y, z)
assert g.n_cells == 24
assert g.n_points == 36
assert np.allclose(
g.bounds,
[
-0.8137976813493738,
0.8660254037844387,
-0.8528685319524434,
0.8528685319524433,
-1.0,
1.0,
],
)
assert np.allclose(g.points[1], [0.8660254037844386, 0.0, 0.5])
z = np.linspace(10, 30, 3)
g = pv.grid_from_sph_coords(x, y, z)
assert g.n_cells == 48
assert g.n_points == 108
assert np.allclose(g.points[0], [0.0, 0.0, 10.0])
def test_transform_vectors_sph_to_cart():
lon = np.arange(0.0, 360.0, 40.0) # longitude
lat = np.arange(0.0, 181.0, 60.0) # colatitude
lev = [1] # elevation (radius)
u, v = np.meshgrid(lon, lat, indexing="ij")
w = u**2 - v**2
uu, vv, ww = pv.transform_vectors_sph_to_cart(lon, lat, lev, u, v, w)
assert np.allclose(
[uu[-1, -1], vv[-1, -1], ww[-1, -1]],
[67.80403533828323, 360.8359915416445, -70000.0],
)
def test_vtkmatrix_to_from_array():
rng = np.random.default_rng()
array3x3 = rng.integers(0, 10, size=(3, 3))
matrix = pv.vtkmatrix_from_array(array3x3)
assert isinstance(matrix, vtk.vtkMatrix3x3)
for i in range(3):
for j in range(3):
assert matrix.GetElement(i, j) == array3x3[i, j]
array = pv.array_from_vtkmatrix(matrix)
assert isinstance(array, np.ndarray)
assert array.shape == (3, 3)
for i in range(3):
for j in range(3):
assert array[i, j] == matrix.GetElement(i, j)
array4x4 = rng.integers(0, 10, size=(4, 4))
matrix = pv.vtkmatrix_from_array(array4x4)
assert isinstance(matrix, vtk.vtkMatrix4x4)
for i in range(4):
for j in range(4):
assert matrix.GetElement(i, j) == array4x4[i, j]
array = pv.array_from_vtkmatrix(matrix)
assert isinstance(array, np.ndarray)
assert array.shape == (4, 4)
for i in range(4):
for j in range(4):
assert array[i, j] == matrix.GetElement(i, j)
# invalid cases
with pytest.raises(ValueError): # noqa: PT011
matrix = pv.vtkmatrix_from_array(np.arange(3 * 4).reshape(3, 4))
invalid = vtk.vtkTransform()
with pytest.raises(TypeError):
array = pv.array_from_vtkmatrix(invalid)
def test_assert_empty_kwargs():
kwargs = {}
assert assert_empty_kwargs(**kwargs)
kwargs = {"foo": 6}
with pytest.raises(TypeError):
assert_empty_kwargs(**kwargs)
kwargs = {"foo": 6, "goo": "bad"}
with pytest.raises(TypeError):
assert_empty_kwargs(**kwargs)
def test_convert_id_list():
ids = np.array([4, 5, 8])
id_list = vtk.vtkIdList()
id_list.SetNumberOfIds(len(ids))
for i, v in enumerate(ids):
id_list.SetId(i, v)
converted = vtk_id_list_to_array(id_list)
assert np.allclose(converted, ids)
def test_progress_monitor():
mesh = pv.Sphere()
ugrid = mesh.delaunay_3d(progress_bar=True)
assert isinstance(ugrid, pv.UnstructuredGrid)
def test_observer():
msg = "KIND: In PATH, line 0\nfoo (ADDRESS): ALERT"
obs = Observer()
ret = obs.parse_message("foo")
assert ret[3] == "foo"
ret = obs.parse_message(msg)
assert ret[3] == "ALERT"
for kind in ["WARNING", "ERROR"]:
obs.log_message(kind, "foo")
# Pass positionally as that's what VTK will do
obs(None, None, msg)
assert obs.has_event_occurred()
assert obs.get_message() == "ALERT"
assert obs.get_message(etc=True) == msg
alg = vtk.vtkSphereSource()
alg.GetExecutive()
obs.observe(alg)
with pytest.raises(RuntimeError, match="algorithm"):
obs.observe(alg)
def test_check_valid_vector():
with pytest.raises(ValueError, match="length three"):
check_valid_vector([0, 1])
check_valid_vector([0, 1, 2])
def test_cells_dict_utils():
# No pyvista object
with pytest.raises(ValueError): # noqa: PT011
cells.get_mixed_cells(None)
with pytest.raises(ValueError): # noqa: PT011
cells.get_mixed_cells(np.zeros(shape=[3, 3]))
def test_apply_transformation_to_points():
mesh = ex.load_airplane()
points = mesh.points
points_orig = points.copy()
# identity 3 x 3
tf = np.eye(3)
points_new = transformations.apply_transformation_to_points(tf, points, inplace=False)
assert points_new == pytest.approx(points)
# identity 4 x 4
tf = np.eye(4)
points_new = transformations.apply_transformation_to_points(tf, points, inplace=False)
assert points_new == pytest.approx(points)
# scale in-place
tf = np.eye(4) * 2
tf[3, 3] = 1
r = transformations.apply_transformation_to_points(tf, points, inplace=True)
assert r is None
assert mesh.points == pytest.approx(2 * points_orig)
def _generate_vtk_err():
"""Simple operation which generates a VTK error."""
x, y, z = np.meshgrid(np.arange(-10, 10, 0.5), np.arange(-10, 10, 0.5), np.arange(-10, 10, 0.5))
mesh = pv.StructuredGrid(x, y, z)
x2, y2, z2 = np.meshgrid(np.arange(-1, 1, 0.5), np.arange(-1, 1, 0.5), np.arange(-1, 1, 0.5))
mesh2 = pv.StructuredGrid(x2, y2, z2)
alg = vtk.vtkStreamTracer()
obs = pv.Observer()
obs.observe(alg)
alg.SetInputDataObject(mesh)
alg.SetSourceData(mesh2)
alg.Update()
@pytest.mark.xfail(importlib.util.find_spec("paraview"),
reason="paraview provides inconsistent vtk")
def test_vtk_error_catcher():
# raise_errors: False
error_catcher = pv.core.utilities.observers.VtkErrorCatcher()
with error_catcher:
_generate_vtk_err()
_generate_vtk_err()
assert len(error_catcher.events) == 2
# raise_errors: False, no error
error_catcher = pv.core.utilities.observers.VtkErrorCatcher()
with error_catcher:
pass
# raise_errors: True
error_catcher = pv.core.utilities.observers.VtkErrorCatcher(raise_errors=True)
with pytest.raises(RuntimeError):
with error_catcher:
_generate_vtk_err()
assert len(error_catcher.events) == 1
# raise_errors: True, no error
error_catcher = pv.core.utilities.observers.VtkErrorCatcher(raise_errors=True)
with error_catcher:
pass
def test_axis_angle_rotation():
# rotate points around body diagonal
points = np.eye(3)
axis = [1, 1, 1]
# no-op case
angle = 360
trans = transformations.axis_angle_rotation(axis, angle)
actual = transformations.apply_transformation_to_points(trans, points)
assert np.array_equal(actual, points)
# default origin
angle = np.radians(120)
expected = points[[1, 2, 0], :]
trans = transformations.axis_angle_rotation(axis, angle, deg=False)
actual = transformations.apply_transformation_to_points(trans, points)
assert np.allclose(actual, expected)
# non-default origin
p0 = [-2, -3, 4]
points += p0
expected += p0
trans = transformations.axis_angle_rotation(axis, angle, point=p0, deg=False)
actual = transformations.apply_transformation_to_points(trans, points)
assert np.allclose(actual, expected)
# invalid cases
with pytest.raises(ValueError): # noqa: PT011
transformations.axis_angle_rotation([1, 0, 0, 0], angle)
with pytest.raises(ValueError): # noqa: PT011
transformations.axis_angle_rotation(axis, angle, point=[1, 0, 0, 0])
with pytest.raises(ValueError): # noqa: PT011
transformations.axis_angle_rotation([0, 0, 0], angle)
@pytest.mark.parametrize(
("axis", "angle", "times"),
[
([1, 0, 0], 90, 4),
([1, 0, 0], 180, 2),
([1, 0, 0], 270, 4),
([0, 1, 0], 90, 4),
([0, 1, 0], 180, 2),
([0, 1, 0], 270, 4),
([0, 0, 1], 90, 4),
([0, 0, 1], 180, 2),
([0, 0, 1], 270, 4),
],
)
def test_axis_angle_rotation_many_times(axis, angle, times):
# yields the exact same input
expect = np.eye(3)
actual = expect.copy()
trans = transformations.axis_angle_rotation(axis, angle)
for _ in range(times):
actual = transformations.apply_transformation_to_points(trans, actual)
assert np.array_equal(actual, expect)
def test_reflection():
# reflect points of a square across a diagonal
points = np.array(
[
[1, 1, 0],
[-1, 1, 0],
[-1, -1, 0],
[1, -1, 0],
],
)
normal = [1, 1, 0]
# default origin
expected = points[[2, 1, 0, 3], :]
trans = transformations.reflection(normal)
actual = transformations.apply_transformation_to_points(trans, points)
assert np.allclose(actual, expected)
# non-default origin
p0 = [1, 1, 0]
expected += 2 * np.array(p0)
trans = transformations.reflection(normal, point=p0)
actual = transformations.apply_transformation_to_points(trans, points)
assert np.allclose(actual, expected)
# invalid cases
with pytest.raises(ValueError): # noqa: PT011
transformations.reflection([1, 0, 0, 0])
with pytest.raises(ValueError): # noqa: PT011
transformations.reflection(normal, point=[1, 0, 0, 0])
with pytest.raises(ValueError): # noqa: PT011
transformations.reflection([0, 0, 0])
def test_merge(sphere, cube, datasets):
with pytest.raises(TypeError, match="Expected a sequence"):
pv.merge(None)
with pytest.raises(ValueError, match="Expected at least one"):
pv.merge([])
with pytest.raises(TypeError, match="Expected pyvista.DataSet"):
pv.merge([None, sphere])
# check polydata
merged_poly = pv.merge([sphere, cube])
assert isinstance(merged_poly, pv.PolyData)
assert merged_poly.n_points == sphere.n_points + cube.n_points
merged = pv.merge([sphere, sphere], merge_points=True)
assert merged.n_points == sphere.n_points
merged = pv.merge([sphere, sphere], merge_points=False)
assert merged.n_points == sphere.n_points * 2
# check unstructured
merged_ugrid = pv.merge(datasets, merge_points=False)
assert isinstance(merged_ugrid, pv.UnstructuredGrid)
assert merged_ugrid.n_points == sum([ds.n_points for ds in datasets])
# check main has priority
sphere_a = sphere.copy()
sphere_b = sphere.copy()
sphere_a['data'] = np.zeros(sphere_a.n_points)
sphere_b['data'] = np.ones(sphere_a.n_points)
merged = pv.merge(
[sphere_a, sphere_b],
merge_points=True,
main_has_priority=False,
)
assert np.allclose(merged['data'], 1)
merged = pv.merge(
[sphere_a, sphere_b],
merge_points=True,
main_has_priority=True,
)
assert np.allclose(merged['data'], 0)
def test_convert_array():
arr = np.arange(4).astype('O')
arr2 = pv.core.utilities.arrays.convert_array(arr, array_type=np.dtype('O'))
assert arr2.GetNumberOfValues() == 4
# https://github.com/pyvista/pyvista/issues/2370
arr3 = pv.core.utilities.arrays.convert_array(
pickle.loads(pickle.dumps(np.arange(4).astype('O'))),
array_type=np.dtype('O'),
)
assert arr3.GetNumberOfValues() == 4
# check lists work
my_list = [1, 2, 3]
arr4 = pv.core.utilities.arrays.convert_array(my_list)
assert arr4.GetNumberOfValues() == len(my_list)
# test string scalar is converted to string array with length on
my_str = 'abc'
arr5 = pv.core.utilities.arrays.convert_array(my_str)
assert arr5.GetNumberOfValues() == 1
arr6 = pv.core.utilities.arrays.convert_array(np.array(my_str))
assert arr6.GetNumberOfValues() == 1
def test_has_duplicates():
assert not has_duplicates(np.arange(100))
assert has_duplicates(np.array([0, 1, 2, 2]))
assert has_duplicates(np.array([[0, 1, 2], [0, 1, 2]]))
with pytest.raises(ValueError): # noqa: PT011
raise_has_duplicates(np.array([0, 1, 2, 2]))
def test_copy_vtk_array():
with pytest.raises(TypeError, match='Invalid type'):
copy_vtk_array([1, 2, 3])
value_0 = 10
value_1 = 10
arr = vtk.vtkFloatArray()
arr.SetNumberOfValues(2)
arr.SetValue(0, value_0)
arr.SetValue(1, value_1)
arr_copy = copy_vtk_array(arr, deep=True)
assert arr_copy.GetNumberOfValues()
assert value_0 == arr_copy.GetValue(0)
arr_copy_shallow = copy_vtk_array(arr, deep=False)
new_value = 5
arr.SetValue(1, new_value)
assert value_1 == arr_copy.GetValue(1)
assert new_value == arr_copy_shallow.GetValue(1)
def test_cartesian_to_spherical():
def polar2cart(r, phi, theta):
return np.vstack(
(r * np.sin(phi) * np.cos(theta), r * np.sin(phi) * np.sin(theta), r * np.cos(phi)),
).T
points = np.random.default_rng().random((1000, 3))
x, y, z = points.T
r, phi, theta = pv.cartesian_to_spherical(x, y, z)
assert np.allclose(polar2cart(r, phi, theta), points)
def test_spherical_to_cartesian():
points = np.random.default_rng().random((1000, 3))
r, phi, theta = points.T
x, y, z = pv.spherical_to_cartesian(r, phi, theta)
assert np.allclose(pv.cartesian_to_spherical(x, y, z), points.T)
def test_set_pickle_format():
pv.set_pickle_format('legacy')
assert pv.PICKLE_FORMAT == 'legacy'
pv.set_pickle_format('xml')
assert pv.PICKLE_FORMAT == 'xml'
with pytest.raises(ValueError): # noqa: PT011
pv.set_pickle_format('invalid_format')
def test_linkcode_resolve():
assert linkcode_resolve('not-py', {}) is None
link = linkcode_resolve('py', {'module': 'pyvista', 'fullname': 'pyvista.core.DataObject'})
assert 'dataobject.py' in link
assert '#L' in link
# badmodule name
assert linkcode_resolve('py', {'module': 'doesnotexist', 'fullname': 'foo.bar'}) is None
assert (
linkcode_resolve('py', {'module': 'pyvista', 'fullname': 'pyvista.not.an.object'}) is None
)
# test property
link = linkcode_resolve('py', {'module': 'pyvista', 'fullname': 'pyvista.core.DataSet.points'})
assert 'dataset.py' in link
link = linkcode_resolve('py', {'module': 'pyvista', 'fullname': 'pyvista.core'})
assert link.endswith('__init__.py')
def test_coerce_point_like_arg():
# Test with Sequence
point = [1.0, 2.0, 3.0]
coerced_arg, singular = _coerce_pointslike_arg(point)
assert isinstance(coerced_arg, np.ndarray)
assert coerced_arg.shape == (1, 3)
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
assert singular
# Test with 1D np.ndarray
point = np.array([1.0, 2.0, 3.0])
coerced_arg, singular = _coerce_pointslike_arg(point)
assert isinstance(coerced_arg, np.ndarray)
assert coerced_arg.shape == (1, 3)
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
assert singular
# Test with (1, 3) np.ndarray
point = np.array([[1.0, 2.0, 3.0]])
coerced_arg, singular = _coerce_pointslike_arg(point)
assert isinstance(coerced_arg, np.ndarray)
assert coerced_arg.shape == (1, 3)
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
assert not singular
# Test with 2D ndarray
point = np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]])
coerced_arg, singular = _coerce_pointslike_arg(point)
assert isinstance(coerced_arg, np.ndarray)
assert coerced_arg.shape == (2, 3)
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]))
assert not singular
def test_coerce_point_like_arg_copy():
# Sequence is always copied
point = [1.0, 2.0, 3.0]
coerced_arg, _ = _coerce_pointslike_arg(point, copy=True)
point[0] = 10.0
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
point = [1.0, 2.0, 3.0]
coerced_arg, _ = _coerce_pointslike_arg(point, copy=False)
point[0] = 10.0
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
# 1D np.ndarray can be copied or not
point = np.array([1.0, 2.0, 3.0])
coerced_arg, _ = _coerce_pointslike_arg(point, copy=True)
point[0] = 10.0
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0]]))
point = np.array([1.0, 2.0, 3.0])
coerced_arg, _ = _coerce_pointslike_arg(point, copy=False)
point[0] = 10.0
assert np.array_equal(coerced_arg, np.array([[10.0, 2.0, 3.0]]))
# 2D np.ndarray can be copied or not
point = np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]])
coerced_arg, _ = _coerce_pointslike_arg(point, copy=True)
point[0, 0] = 10.0
assert np.array_equal(coerced_arg, np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]))
point = np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]])
coerced_arg, _ = _coerce_pointslike_arg(point, copy=False)
point[0, 0] = 10.0
assert np.array_equal(coerced_arg, np.array([[10.0, 2.0, 3.0], [4.0, 5.0, 6.0]]))
def test_coerce_point_like_arg_errors():
# wrong length sequence
with pytest.raises(ValueError): # noqa: PT011
_coerce_pointslike_arg([1, 2])
# wrong type
with pytest.raises(TypeError):
# allow Sequence but not Iterable
_coerce_pointslike_arg({1, 2, 3})
# wrong length ndarray
with pytest.raises(ValueError): # noqa: PT011
_coerce_pointslike_arg(np.empty(4))
with pytest.raises(ValueError): # noqa: PT011
_coerce_pointslike_arg(np.empty([2, 4]))
# wrong ndim ndarray
with pytest.raises(ValueError): # noqa: PT011
_coerce_pointslike_arg(np.empty([1, 3, 3]))
def test_coerce_points_like_args_does_not_copy():
source = np.random.default_rng().random((100, 3))
output, _ = _coerce_pointslike_arg(source) # test that copy=False is default
output /= 2
assert np.array_equal(output, source)
assert np.may_share_memory(output, source)
def test_has_module():
assert has_module('pytest')
assert not has_module('not_a_module')
def test_fit_plane_to_points():
points = ex.load_airplane().points
plane, center, normal = fit_plane_to_points(points, return_meta=True)
assert np.allclose(normal, [-2.5999512e-08, 0.121780515, -0.99255705])
assert np.allclose(center, [896.9954860028446, 686.6470205328502, 78.13187948615939])
assert np.allclose(
plane.bounds,
[
139.06036376953125,
1654.9306640625,
38.0776252746582,
1335.2164306640625,
-1.4434913396835327,
157.70724487304688,
],
)
@pytest.mark.parametrize(
'transform_like',
[
np.array(np.eye(3)),
np.array(np.eye(4)),
vtkmatrix_from_array(np.eye(3)),
vtkmatrix_from_array(np.eye(4)),
vtk.vtkTransform(),
],
)
def test_coerce_transformlike_arg(transform_like):
result = _coerce_transformlike_arg(transform_like)
assert np.array_equal(result, np.eye(4))
def test_coerce_transformlike_arg_raises():
with pytest.raises(ValueError, match="must be 3x3 or 4x4"):
_coerce_transformlike_arg(np.array([1, 2, 3]))
with pytest.raises(TypeError, match="must be one of"):
_coerce_transformlike_arg([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
with pytest.raises(TypeError, match="must be one of"):
_coerce_transformlike_arg("abc")
@pytest.fixture()
def no_new_attr_subclass():
@no_new_attr
class A: ...
class B(A):
_new_attr_exceptions = 'eggs'
def __init__(self):
self.eggs = 'ham'
return B
def test_no_new_attr_subclass(no_new_attr_subclass):
obj = no_new_attr_subclass()
assert obj
msg = 'Attribute "_eggs" does not exist and cannot be added to type B'
with pytest.raises(AttributeError, match=msg):
obj._eggs = 'ham'
@pytest.fixture()
def serial_dict_empty():
return _SerializedDictArray()
@pytest.fixture()
def serial_dict_with_foobar():
serial_dict = _SerializedDictArray()
serial_dict.data = dict(foo='bar')
return serial_dict
def test_serial_dict_init():
# empty init
serial_dict = _SerializedDictArray()
assert serial_dict == {}
assert repr(serial_dict) == '{}'
# init from dict
new_dict = dict(ham='eggs')
serial_dict = _SerializedDictArray(new_dict)
assert serial_dict['ham'] == 'eggs'
assert repr(serial_dict) == '{"ham": "eggs"}'
# init from UserDict
serial_dict = _SerializedDictArray(serial_dict)
assert serial_dict['ham'] == 'eggs'
assert repr(serial_dict) == '{"ham": "eggs"}'
# init from JSON string
json_dict = json.dumps(new_dict)
serial_dict = _SerializedDictArray(json_dict)
assert serial_dict['ham'] == 'eggs'
assert repr(serial_dict) == '{"ham": "eggs"}'
def test_serial_dict_as_dict(serial_dict_with_foobar):
assert not isinstance(serial_dict_with_foobar, dict)
actual_dict = dict(serial_dict_with_foobar)
assert isinstance(actual_dict, dict)
assert actual_dict == serial_dict_with_foobar.data
def test_serial_dict_overrides__setitem__(serial_dict_empty):
serial_dict_empty['foo'] = 'bar'
assert repr(serial_dict_empty) == '{"foo": "bar"}'
def test_serial_dict_overrides__delitem__(serial_dict_with_foobar):
del serial_dict_with_foobar['foo']
assert repr(serial_dict_with_foobar) == '{}'
def test_serial_dict_overrides__setattr__(serial_dict_empty):
serial_dict_empty.data = dict(foo='bar')
assert repr(serial_dict_empty) == '{"foo": "bar"}'
def test_serial_dict_overrides_popitem(serial_dict_with_foobar):
serial_dict_with_foobar['ham'] = 'eggs'
item = serial_dict_with_foobar.popitem()
assert item == ('foo', 'bar')
assert repr(serial_dict_with_foobar) == '{"ham": "eggs"}'
def test_serial_dict_overrides_pop(serial_dict_with_foobar):
item = serial_dict_with_foobar.pop('foo')
assert item == 'bar'
assert repr(serial_dict_with_foobar) == '{}'
def test_serial_dict_overrides_update(serial_dict_empty):
serial_dict_empty.update(dict(foo='bar'))
assert repr(serial_dict_empty) == '{"foo": "bar"}'
def test_serial_dict_overrides_clear(serial_dict_with_foobar):
serial_dict_with_foobar.clear()
assert repr(serial_dict_with_foobar) == '{}'
def test_serial_dict_overrides_setdefault(serial_dict_empty, serial_dict_with_foobar):
serial_dict_empty.setdefault('foo', 42)
assert repr(serial_dict_empty) == '{"foo": 42}'
serial_dict_with_foobar.setdefault('foo', 42)
assert repr(serial_dict_with_foobar) == '{"foo": "bar"}'
|