File: grids.rst

package info (click to toggle)
python-pyvista 0.46.4-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 176,968 kB
  • sloc: python: 94,346; sh: 216; makefile: 70
file content (59 lines) | stat: -rw-r--r-- 1,709 bytes parent folder | download
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
.. jupyter-execute::
   :hide-code:

   # jupyterlab boiler plate setup
   import pyvista
   pyvista.set_plot_theme('document')
   pyvista.set_jupyter_backend('static')
   pyvista.global_theme.window_size = [600, 400]
   pyvista.global_theme.axes.show = False
   pyvista.global_theme.anti_aliasing = 'fxaa'
   pyvista.global_theme.show_scalar_bar = False


Gridded Data
============

Gridded datasets in PyVista are datasets with topologically regular
point spacing. These are less flexible than :ref:`point_sets_api`,
but are much more memory efficient as they can be described with a
handful of parameters rather than having to explicitly describe the
points and geometry of the dataset.

PyVista gridded data is composed of the
:class:`pyvista.RectilinearGrid` and :class:`pyvista.ImageData`
classes. These classes inherit from the :vtk:`vtkRectilinearGrid` and
:vtk:`vtkImageData` classes and are commonly used to model images or
volumetric data.

A :class:`pyvista.RectilinearGrid` is used for modeling datasets with
variable spacing in the three coordinate directions.

.. jupyter-execute::
   :hide-code:

   from pyvista import demos
   demos.plot_datasets('RectilinearGrid')


A :class:`pyvista.ImageData` is used for modeling datasets with
uniform spacing in the three coordinate directions.

.. jupyter-execute::
   :hide-code:

   from pyvista import demos
   demos.plot_datasets('ImageData')


**Class Descriptions**

The following table describes PyVista's grid set classes. These
classes inherit all methods from their corresponding VTK
:vtk:`vtkRectilinearGrid` and :vtk:`vtkImageData` superclasses.

.. autosummary::
   :toctree: _autosummary

   pyvista.RectilinearGrid
   pyvista.ImageData