pept.processing.VectorGrid3D

class pept.processing.VectorGrid3D(xvoxels: Voxels, yvoxels: Voxels, zvoxels: Voxels)

Bases: object

Object produced by VectorField3D storing 3 grids of voxels xvoxels, yvoxels, zvoxels, for example velocity vector fields / quiver plots.

Examples

Compute a 3D velocity vector field (velocities were first calculated using pept.tracking.Velocity):

>>> from pept.processing import *
>>> trajectories = pept.PointData(...)
>>> field = VectorField3D(0.6).fit(trajectories)
>>> field
VectorGrid3D(xvoxels, yvoxels, zvoxels)

Create a 3D vector field (needs PyVista):

>>> scaling = 16
>>> fig = field.vectors(scaling)
>>> fig.plot(cmap = "magma")

__init__(xvoxels: Voxels, yvoxels: Voxels, zvoxels: Voxels)

Methods

__init__(xvoxels, yvoxels, zvoxels)
vectors([factor])

vectors(factor=1)