diff --git a/movement/analysis/kinematics.py b/movement/analysis/kinematics.py index 1d273194..671461d5 100644 --- a/movement/analysis/kinematics.py +++ b/movement/analysis/kinematics.py @@ -370,7 +370,7 @@ def compute_interkeypoint_distances( ---------- data : xarray.DataArray The input data containing - ``('time', 'individuals', 'keypoints', 'space'`` as dimensions. + ``('time', 'individuals', 'keypoints', 'space')`` as dimensions. pairs : dict[str, str | list[str]], optional A dictionary containing the mapping between pairs of keypoints. The key is the keypoint and the value is a list of keypoints @@ -424,16 +424,17 @@ def compute_interkeypoint_distances( * key1 (key1) >> dist_key1_key2.sel(key1="ind1", key2="ind1") To obtain the distances between ``key1`` of ``ind1`` and ``key2`` of ``ind2``: + >>> dist_key1_key2.sel(key1="ind1", key2="ind2") Compute the city block or Manhattan distance for multiple pairs of @@ -530,7 +531,7 @@ def _compute_pairwise_distances( ---------- data : xarray.DataArray The input data containing - ``('time', 'individuals', 'keypoints', 'space'`` as dimensions. + ``('time', 'individuals', 'keypoints', 'space')`` as dimensions. dim : str The dimension to compute the distances for. Must be either ``'individuals'`` or ``'keypoints'``.