File: dataset.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 (42 lines) | stat: -rw-r--r-- 1,536 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
.. _dataset:

Data Sets
=========
Datasets are any spatially referenced information and usually consist of
geometrical representations of a surface or volume in 3D space.
In VTK, this superclass is represented by the :vtk:`vtkDataSet` abstract class.

In VTK, datasets consist of geometry, topology, and attributes to which PyVista
provides direct access:

* Geometry is the collection of points and cells in 2D or 3D space.
* Topology defines the structure of the dataset, or how the points are connected
  to each other to form a cells making a surface or volume.
* Attributes are any data values that are associated to either the points or
  cells of the dataset

All of the following data types are listed subclasses of a dataset and share a
set of common functionality which we wrap into the base class
:class:`pyvista.DataSet`.

For additional details regarding PyVista's data model, please see
:ref:`pyvista_data_model`.


Dataset API Reference
---------------------
The :class:`pyvista.DataSet` class holds attributes that
are *common* to all spatially referenced datasets in PyVista. This
base class is analogous to VTK's :vtk:`vtkDataSet` class.

The :class:`pyvista.DataSetAttributes` class contains the methods to access
arrays associated with cells, points, and the DataSet in general (fields).

.. autosummary::
   :toctree: _autosummary

   pyvista.DataSet
   pyvista.DataSetAttributes
   pyvista.core.dataset.ActiveArrayInfo
   pyvista.core.dataset.ActiveArrayInfoTuple
   pyvista.core.utilities.arrays.FieldAssociation