pyvista.ImageData.active_vectors_info

pyvista.ImageData.active_vectors_info#

property ImageData.active_vectors_info: ActiveArrayInfoTuple[source]#

Return the active vector’s association and name.

Association refers to the data association (e.g. point, cell, or field) of the active vectors.

Returns:
ActiveArrayInfo

The vectors info in an object with namedtuple semantics, with attributes association and name.

Notes

If both cell and point vectors are present and neither have been set active within at the dataset level, point vectors will be made active.

Examples

Create a mesh, compute the normals inplace, set the active vectors to the normals, and show that the active vectors are the 'Normals' array associated with points.

>>> import pyvista as pv
>>> mesh = pv.Sphere()
>>> _ = mesh.compute_normals(inplace=True)
>>> mesh.active_vectors_name = 'Normals'
>>> mesh.active_vectors_info
ActiveArrayInfoTuple(association=<FieldAssociation.POINT: 0>, name='Normals')
Contents