pyvista.MultiBlock

class MultiBlock(*args, **kwargs)

A composite class to hold many data sets which can be iterated over.

This wraps/extends the vtkMultiBlockDataSet class so that we can easily plot these data sets and use the composite in a Pythonic manner.

You can think of MultiBlock like a list as we can iterate over this data structure by index. It has some dictionary features as we can also access blocks by their string name.

Changed in version 0.36.0: MultiBlock adheres more closely to being list like, and inherits from collections.abc.MutableSequence. Multiple nonconforming behaviors were removed or modified.

Parameters:

*argsdict, optional

Data object dictionary.

**kwargsdict, optional

See pyvista.read() for additional options.

Examples

>>> import pyvista as pv

Create an empty composite dataset.

>>> blocks = pv.MultiBlock()

Add a dataset to the collection.

>>> sphere = pv.Sphere()
>>> blocks.append(sphere)

Add a named block.

>>> blocks['cube'] = pv.Cube()

Instantiate from a list of objects.

>>> data = [
...     pv.Sphere(center=(2, 0, 0)),
...     pv.Cube(center=(0, 2, 0)),
...     pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.plot()

Static Scene

Interactive Scene

Instantiate from a dictionary.

>>> data = {
...     'cube': pv.Cube(),
...     'sphere': pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.plot()

Static Scene

Interactive Scene

Iterate over the collection.

>>> for name in blocks.keys():
...     block = blocks[name]

>>> for block in blocks:
...     # Do something with each dataset
...     surf = block.extract_surface()

Methods

MultiBlock.append(dataset[, name])	Add a data set to the next block index.
MultiBlock.as_polydata_blocks([copy])	Convert all the datasets within this MultiBlock to PolyData.
MultiBlock.as_unstructured_grid_blocks([copy])	Convert all the datasets within this MultiBlock to UnstructuredGrid.
MultiBlock.clean([empty])	Remove any null blocks in place.
MultiBlock.clear_all_cell_data()	Clear all cell data from all blocks.
MultiBlock.clear_all_data()	Clear all data from all blocks.
MultiBlock.clear_all_point_data()	Clear all point data from all blocks.
MultiBlock.copy([deep])	Return a copy of the multiblock.
MultiBlock.copy_meta_from(ido, deep)	Copy pyvista meta data onto this object from another object.
MultiBlock.deep_copy(to_copy)	Overwrite this MultiBlock with another MultiBlock as a deep copy.
MultiBlock.extend(datasets)	Extend MultiBlock with an Iterable.
MultiBlock.flatten(*[, order, name_mode, ...])	Flatten this MultiBlock.
MultiBlock.get(index[, default])	Get a block by its index or name.
MultiBlock.get_block(index)	Get a block by its index or name.
MultiBlock.get_block_name(index)	Return the string name of the block at the given index.
MultiBlock.get_data_range(name[, ...])	Get the min/max of an array given its name across all blocks.
MultiBlock.get_index_by_name(name)	Find the index number by block name.
MultiBlock.insert(index, dataset[, name])	Insert data before index.
MultiBlock.keys()	Get all the block names in the dataset.
MultiBlock.move_nested_field_data_to_root(*)	Move or copy field data from all nested MultiBlock blocks.
MultiBlock.plot([off_screen, full_screen, ...])	Plot a PyVista, numpy, or vtk object.
MultiBlock.pop([index])	Pop off a block at the specified index.
MultiBlock.recursive_iterator([contents, ...])	Iterate over all nested blocks recursively.
MultiBlock.replace(index, dataset)	Replace dataset at index while preserving key name.
MultiBlock.reverse()	Reverse MultiBlock in-place.
MultiBlock.set_active_scalars(name[, ...])	Find the scalars by name and appropriately set it as active.
MultiBlock.set_block_name(index, name)	Set a block's string name at the specified index.
MultiBlock.shallow_copy(to_copy[, recursive])	Shallow copy the given multiblock to this multiblock.
MultiBlock.wrap_nested()	Ensure that all nested data structures are wrapped as PyVista datasets.

Attributes

MultiBlock.block_types	Return a set of all block type(s).
MultiBlock.bounds	Find min/max for bounds across blocks.
MultiBlock.center	Return the center of the bounding box.
MultiBlock.is_all_polydata	Return True when all the blocks are PolyData.
MultiBlock.is_empty	Return True if there are no blocks.
MultiBlock.is_heterogeneous	Return True any two nested blocks have different type.
MultiBlock.is_homogeneous	Return True if all nested blocks have the same type.
MultiBlock.is_nested	Return True if any blocks are a MultiBlock.
MultiBlock.length	Return the length of the diagonal of the bounding box.
MultiBlock.n_blocks	Return the total number of blocks set.
MultiBlock.nested_block_types	Return a set of all nested block type(s).
MultiBlock.volume	Return the total volume of all meshes in this dataset.
MultiBlock.points