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
|
General Utilities
-----------------
.. currentmodule:: pyvista
.. autosummary::
:toctree: _autosummary
core.utilities.VtkErrorCatcher
core.utilities.axis_rotation
core.utilities.is_inside_bounds
core.utilities.set_error_output_file
Object Conversions or Wrapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
array_from_vtkmatrix
cubemap
cubemap_from_filenames
image_to_texture
is_pyvista_dataset
numpy_to_texture
pyvista_ndarray
vtkmatrix_from_array
wrap
Features
~~~~~~~~
.. autosummary::
:toctree: _autosummary
cartesian_to_spherical
cell_quality_info
create_grid
grid_from_sph_coords
merge
perlin_noise
principal_axes
sample_function
spherical_to_cartesian
transform_vectors_sph_to_cart
voxelize
voxelize_volume
File IO
~~~~~~~
.. autosummary::
:toctree: _autosummary
from_meshio
get_ext
is_meshio_mesh
read
read_exodus
read_grdecl
read_meshio
read_texture
save_meshio
set_pickle_format
set_vtkwriter_mode
to_meshio
Mesh Creation
~~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
CellType
fit_line_to_points
fit_plane_to_points
lines_from_points
vector_poly_data
vtk_points
Array Access
~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
cell_array
convert_array
field_array
get_array
point_array
Transformations
~~~~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
Transform
Image Comparison and Regression
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
compare_images
Colors
~~~~~~
.. autosummary::
:toctree: _autosummary
Color
ColorLike
Named colors supported by :class:`~pyvista.Color`, :class:`~pyvista.Plotter`,
and other plotting-related methods:
.. toctree::
:maxdepth: 3
/api/utilities/named_colors
Named colormaps supported by :class:`~pyvista.LookupTable`, :class:`~pyvista.Plotter`,
and other plotting-related methods:
.. toctree::
:maxdepth: 3
/api/utilities/named_colormaps
Miscellaneous
~~~~~~~~~~~~~
.. autosummary::
:toctree: _autosummary
set_new_attribute
start_xvfb
Report
vtk_verbosity
vtk_snake_case
PyVista Version Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The PyVista library provides a way of getting the version installed in your
environment.
>>> # Output the version of PyVista.
>>> import pyvista
>>> pyvista.version_info
(0, 44, 0)
VTK Version Information
~~~~~~~~~~~~~~~~~~~~~~~
The PyVista library is heavily dependent on VTK and provides an easy
way of getting the version of VTK in your environment.
>>> # Output the version of VTK.
>>> import pyvista
>>> pyvista.vtk_version_info
VTKVersionInfo(major=9, minor=1, micro=0)
>>> # Get the major version of VTK
>>> pyvista.vtk_version_info.major
9
|
