DatasetsÂ¶
Datasets are any spatially reference 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
pyvista.Common
.
The Common ModelÂ¶
The pyvista.Common
class holds attributes that are common to all
spatially referenced datasets in PyVista.
This base class is analogous to VTKâ€™s vtk.vtkDataSet
class.
Attributes
Return the active scalars as an array. 

[field, name]. 

Return the active scalarâ€™s name. 

Return the active tensors array. 

[field, name]. 

Return the name of the active tensor array. 

Return the active vectors array. 

[field, name]. 

Return the name of the active vectors array. 

Return a list of array names for the dataset. 

Return a glyph representation of the active vector data as arrows. 

Return the bounding box of this dataset. 

Return vtkCellData as DataSetAttributes. 

Return the center of the bounding box. 

Return the range of the bounding box. 

Return the length of the diagonal of the bounding box. 

Return the number of arrays present in the dataset. 

Return the number of cells in the entire dataset. 

Return the number of points in the entire dataset. 

Return the number of cells. 

Return the number of points. 

Return vtkPointData as DataSetAttributes. 

Return a pointer to the points as a numpy object. 

Return the active texture coordinates on the points. 

Return a dictionary to hold compatible 

Return active vectors. 

Return the mesh volume. 
Methods
Get a new representation of this object as an 

Remove all arrays from point/cell/field data. 

Remove all cell arrays. 

Remove all point arrays. 

Clear the textures from this mesh. 


Copy pyvista meta data onto this object from another object. 

Find index of closest cell in this mesh to the given point. 

Find index of closest point in this mesh to the given point. 

Search both point, cell and field data for an array. 

Get the nonNaN min and max of a named array. 

Overwrite this mesh inplace with the new meshâ€™s geometries and data. 

Plot a vtk or numpy object. 
Make points double precision. 


Change array name by searching for the array then renaming it. 

Rotate mesh about the xaxis. 

Rotate mesh about the yaxis. 

Rotate mesh about the zaxis. 

Find the scalars by name and appropriately sets it as active. 

Find the tensors by name and appropriately sets it as active. 

Find the vectors by name and appropriately sets it as active. 

Compute a transformation in place using a 4x4 transform. 

Translate the mesh. 

class
pyvista.
Common
(*args, **kwargs)Â¶ Bases:
pyvista.core.filters.DataSetFilters
,pyvista.core.common.DataObject
Methods in common to spatially referenced objects.

property
active_scalars
Â¶ Return the active scalars as an array.

property
active_scalars_info
Â¶ [field, name].
 Type
Return the active scalarâ€™s field and name

property
active_scalars_name
Â¶ Return the active scalarâ€™s name.

property
active_tensors
Â¶ Return the active tensors array.

property
active_tensors_info
Â¶ [field, name].
 Type
Return the active tensorâ€™s field and name

property
active_tensors_name
Â¶ Return the name of the active tensor array.

property
active_vectors
Â¶ Return the active vectors array.

property
active_vectors_info
Â¶ [field, name].
 Type
Return the active scalarâ€™s field and name

property
active_vectors_name
Â¶ Return the name of the active vectors array.

property
array_names
Â¶ Return a list of array names for the dataset.
This makes sure to put the active scalarsâ€™ name first in the list.

property
arrows
Â¶ Return a glyph representation of the active vector data as arrows.
Arrows will be located at the points of the mesh and their size will be dependent on the length of the vector. Their direction will be the â€śdirectionâ€ť of the vector
 Returns
arrows â€“ Active scalars represented as arrows.
 Return type

property
bounds
Â¶ Return the bounding box of this dataset.
The form is: (xmin,xmax, ymin,ymax, zmin,zmax).

cast_to_unstructured_grid
()Â¶ Get a new representation of this object as an
pyvista.UnstructuredGrid
.

property
cell_arrays
Â¶ Return vtkCellData as DataSetAttributes.

property
center
Â¶ Return the center of the bounding box.

clear_arrays
()Â¶ Remove all arrays from point/cell/field data.

clear_cell_arrays
()Â¶ Remove all cell arrays.

clear_point_arrays
()Â¶ Remove all point arrays.

clear_textures
()Â¶ Clear the textures from this mesh.

copy_meta_from
(ido)Â¶ Copy pyvista meta data onto this object from another object.

property
extent
Â¶ Return the range of the bounding box.

find_closest_cell
(point)Â¶ Find index of closest cell in this mesh to the given point.
 Parameters
point (iterable(float) or np.ndarray) â€“ Length 3 coordinate of the point to query or a
numpy
array of coordinates. Returns
index â€“ Index or indices of the cell in this mesh that is closest to the given point.
 Return type
int or np.ndarray
Examples
Find nearest cell to a point on a sphere
>>> import pyvista >>> mesh = pyvista.Sphere() >>> index = mesh.find_closest_cell([0, 0, 0.5]) >>> index 59
Find the nearest cells to several random points. Note that
1
indicates that the locator was not able to find a reasonably close cell.>>> import numpy as np >>> points = np.random.random((1000, 3)) >>> indices = mesh.find_closest_cell(points) >>> print(indices.shape) (1000,)

find_closest_point
(point, n=1)Â¶ Find index of closest point in this mesh to the given point.
If wanting to query many points, use a KDTree with scipy or another library as those implementations will be easier to work with.
See: https://github.com/pyvista/pyvistasupport/issues/107
 Parameters
point (iterable(float)) â€“ Length 3 coordinate of the point to query.
n (int, optional) â€“ If greater than
1
, returns the indices of then
closest points.
 Returns
int
 Return type
the index of the point in this mesh that is closes to the given point.

get_array
(name, preference='cell', info=False)Â¶ Search both point, cell and field data for an array.

get_data_range
(arr=None, preference='cell')Â¶ Get the nonNaN min and max of a named array.
 Parameters
arr (str, np.ndarray, optional) â€“ The name of the array to get the range. If None, the active scalars is used.
preference (str, optional) â€“ When scalars is specified, this is the preferred array type to search for in the dataset. Must be either
'point'
,'cell'
, or'field'
.

property
length
Â¶ Return the length of the diagonal of the bounding box.

property
n_arrays
Â¶ Return the number of arrays present in the dataset.

property
n_cells
Â¶ Return the number of cells in the entire dataset.

property
n_points
Â¶ Return the number of points in the entire dataset.

property
number_of_cells
Â¶ Return the number of cells.

property
number_of_points
Â¶ Return the number of points.

overwrite
(mesh)Â¶ Overwrite this mesh inplace with the new meshâ€™s geometries and data.
 Parameters
mesh (vtk.vtkDataSet) â€“ The overwriting mesh.

plot
(off_screen=None, full_screen=False, screenshot=None, interactive=True, cpos=None, window_size=None, show_bounds=False, show_axes=True, notebook=None, background=None, text='', return_img=False, eye_dome_lighting=False, volume=False, parallel_projection=False, use_ipyvtk=None, **kwargs)Â¶ Plot a vtk or numpy object.
 Parameters
item (vtk or numpy object) â€“ VTK object or numpy array to be plotted.
off_screen (bool) â€“ Plots off screen when True. Helpful for saving screenshots without a window popping up.
full_screen (bool, optional) â€“ Opens window in full screen. When enabled, ignores window_size. Default False.
screenshot (str or bool, optional) â€“
Saves screenshot to file when enabled. See: help(pyvistanterface.Plotter.screenshot). Default disabled.
When True, takes screenshot and returns numpy array of image.
window_size (list, optional) â€“ Window size in pixels. Defaults to [1024, 768]
show_bounds (bool, optional) â€“ Shows mesh bounds when True. Default False. Alias
show_grid
also accepted.notebook (bool, optional) â€“ When True, the resulting plot is placed inline a jupyter notebook. Assumes a jupyter console is active.
show_axes (bool, optional) â€“ Shows a vtk axes widget. Enabled by default.
text (str, optional) â€“ Adds text at the bottom of the plot.
volume (bool, optional) â€“ Use the
add_volume
method for volume rendering.use_ipyvtk (bool, optional) â€“ Use the
ipyvtksimple
ViewInteractiveWidget
to visualize the plot within a juyterlab notebook.**kwargs (optional keyword arguments) â€“ See help(Plotter.add_mesh) for additional options.
 Returns
cpos (list) â€“ List of camera position, focal point, and view up.
img (numpy.ndarray) â€“ Array containing pixel RGB and alpha. Sized: [Window height x Window width x 3] for transparent_background=False [Window height x Window width x 4] for transparent_background=True Returned only when screenshot enabled

property
point_arrays
Â¶ Return vtkPointData as DataSetAttributes.

property
points
Â¶ Return a pointer to the points as a numpy object.

points_to_double
()Â¶ Make points double precision.

rename_array
(old_name, new_name, preference='cell')Â¶ Change array name by searching for the array then renaming it.

rotate_x
(angle)Â¶ Rotate mesh about the xaxis.
 Parameters
angle (float) â€“ Angle in degrees to rotate about the xaxis.

rotate_y
(angle)Â¶ Rotate mesh about the yaxis.
 Parameters
angle (float) â€“ Angle in degrees to rotate about the yaxis.

rotate_z
(angle)Â¶ Rotate mesh about the zaxis.
 Parameters
angle (float) â€“ Angle in degrees to rotate about the zaxis.

set_active_scalars
(name, preference='cell')Â¶ Find the scalars by name and appropriately sets it as active.
To deactivate any active scalars, pass
None
as thename
.

set_active_tensors
(name, preference='point')Â¶ Find the tensors by name and appropriately sets it as active.
To deactivate any active tensors, pass
None
as thename
.

set_active_vectors
(name, preference='point')Â¶ Find the vectors by name and appropriately sets it as active.
To deactivate any active vectors, pass
None
as thename
.

property
t_coords
Â¶ Return the active texture coordinates on the points.

property
textures
Â¶ Return a dictionary to hold compatible
vtk.vtkTexture
objects.When casting back to a VTK dataset or filtering this dataset, these textures will not be passed.

transform
(trans)Â¶ Compute a transformation in place using a 4x4 transform.
 Parameters
trans (vtk.vtkMatrix4x4, vtk.vtkTransform, or np.ndarray) â€“ Accepts a vtk transformation object or a 4x4 transformation matrix.

translate
(xyz)Â¶ Translate the mesh.
 Parameters
xyz (list or np.ndarray) â€“ Length 3 list or array.

property
vectors
Â¶ Return active vectors.

property
volume
Â¶ Return the mesh volume.
 Returns
volume â€“ Total volume of the mesh.
 Return type
float

property