Arrays

Data arrays are attached to a dataset through DataSetAttributes, available as point_data, cell_data, and field_data. The functions on this page look up those arrays by name and convert between NumPy arrays and VTK arrays.

See also

PyVista Data Model

How points, cells, and data arrays fit together.

Point Cell Scalars

Point data versus cell data when plotting.

FieldAssociation

The association returned by get_array_association().

Array Access

cell_array(obj, name)	Return cell array of a pyvista or vtk object.
field_array(obj, name)	Return field data of a pyvista or vtk object.
get_array(mesh, name[, preference, err])	Search point, cell, and field data for an array.
get_array_association(mesh, name[, ...])	Return the array association.
point_array(obj, name)	Return point array of a pyvista or vtk object.
set_default_active_scalars(mesh)	Set a default scalars array on mesh, if not already set.
set_default_active_vectors(mesh)	Set a default vectors array on mesh, if not already set.

Array Conversion

array_from_vtkmatrix(matrix)	Convert a vtk matrix to an array.
convert_array(...)	Convert a NumPy array to a vtkDataArray or vice versa.
pyvista_ndarray(*args, **kwargs)	A ndarray which references the owning dataset and the underlying vtk array.
vtk_points(points[, deep, force_float, ...])	Convert a NumPy array or array-like to a vtkPoints object.
vtkmatrix_from_array(array)	Convert a numpy.ndarray or array-like to a vtk matrix.