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
|
Partitioned Datasets
====================
The :class:`pyvista.PartitionedDataSet` class is a partitioned dataset that encapsulates
a dataset consisting of partitions. ``PartitionedDataSet`` behaves mostly like a list.
List-like Features
------------------
Create an empty partitioned dataset
.. jupyter-execute::
:hide-code:
# must have this here as our global backend may not be static
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
.. jupyter-execute::
import pyvista as pv
from pyvista import examples
partitions = pv.PartitionedDataSet()
partitions
Add some data to the collection.
.. jupyter-execute::
partitions.append(pv.Sphere())
partitions.append(pv.Cube(center=(0, 0, -1)))
``PartitionedDataSet`` is List-like so that individual partitions can be accessed via
indices.
.. jupyter-execute::
partitions[0] # Sphere
The length of the partition can be accessed through :func:`len`
.. jupyter-execute::
len(partitions)
or through the ``n_partitions`` attribute
.. jupyter-execute::
partitions.n_partitions
More specifically, ``PartitionedDataSet`` is a :class:`collections.abc.MutableSequence`
and supports operations such as append, insert, etc.
.. jupyter-execute::
partitions.append(pv.Cone())
partitions.reverse()
.. warning::
pop is not supported in ``PartitionedDataSet`` class.
``PartitionedDataSet`` also supports slicing to get or set partitions.
.. jupyter-execute::
partitions[0:2] # The Sphere and Cube objects in a new ``PartitionedDataSet``
PartitionedDataSet API Reference
--------------------------------
The :class:`pyvista.PartitionedDataSet` class holds attributes that
are *common* to all spatially referenced datasets in PyVista. This
base class is analogous to VTK's :vtk:`vtkPartitionedDataSet` class.
.. autosummary::
:toctree: _autosummary
pyvista.PartitionedDataSet
|