compute_signed_angle_2d

movement.utils.vector.compute_signed_angle_2d(u, v, v_as_left_operand=False)

Compute the signed angle from the vector u to the vector v.

The signed angle between u and v is the rotation that needs to be applied to u to have it point in the same direction as v (see Notes). Angles are returned in radians, spanning \((-\pi, \pi]\) according to the arctan2 convention.

Parameters:

• u (xarray.DataArray) – An array of position vectors containing the space dimension with only "x" and "y" coordinates.

• v (xarray.DataArray | numpy.ndarray) – A 2D vector (or array of 2D vectors) against which to compare u. May either be an xarray DataArray containing the "space" dimension or a numpy array containing one or more 2D vectors. (See Notes)

• v_as_left_operand (bool, default False) – If True, the signed angle between v and u is returned, instead of the signed angle between u and v. This is a convenience wrapper for when one of the two vectors to be used does not have time points, and the other does.

Returns:

An xarray DataArray containing signed angle between u and v for every time point. Matches the dimensions of u, but without the space dimension.

Return type:

xarray.DataArray

Notes

Given two vectors \(u = (u_x, u_y)\) and \(v = (v_x, v_y)\), the signed angle \(\alpha\) between u and v is computed as

\[\begin{split}\alpha &= \mathrm{arctan2}(u \times v, u\cdot v) \\ &= \mathrm{arctan2}(u_x v_y - u_y v_x, u_x v_x + u_y v_y),\end{split}\]

which corresponds to the rotation that needs to be applied to u for it to point in the direction of v.

If v is passed as an xarray.DataArray, v must have spatial coordinates that match those of u. Furthermore, any dimensions that are present in both u and v must match in length.

If passed as a numpy array, v must have one of three shapes:

• (2,): where dimension 0 contains spatial coordinates (x,y), and no time dimension is specified.

• (1,2):, where dimension 0 corresponds to a single time-point and dimension 1 contains spatial coordinates (x,y).

• (n,2): where dimension 0 corresponds to time and dimension 1 contains spatial coordinates (x,y), and where n == len(u.time).

Vectors given as v that contain more dimensions, or have shapes otherwise different from those defined above are considered invalid.