compute_forward_displacement#
- movement.kinematics.compute_forward_displacement(data)[source]#
Compute forward displacement array in Cartesian coordinates.
The forward displacement array is defined as the difference between the position array at time point
t+1and the position array at time pointt.As a result, for a given individual and keypoint, the forward displacement vector at time point
t, is the vector pointing from the currenttposition to the nextt+1, in Cartesian coordinates.- Parameters:
data (xarray.DataArray) – The input data containing position information, with
timeandspace(in Cartesian coordinates) as required dimensions.- Returns:
An xarray DataArray containing forward displacement vectors in Cartesian coordinates.
- Return type:
Notes
For the
positionarray of aposesdataset, theforward_displacementarray will hold the forward displacement vectors for every keypoint and every individual.For the
positionarray of abboxesdataset, theforward_displacementarray will hold the forward displacement vectors for the centroid of every individual bounding box.For the
shapearray of abboxesdataset, theforward_displacementarray will hold vectors with the change in width and height per bounding box, between consecutive time points.