From bd33d9696bd92a5a8e926b7a9a6a28feecfbc674 Mon Sep 17 00:00:00 2001 From: sfmig <33267254+sfmig@users.noreply.github.com> Date: Wed, 29 Jan 2025 18:20:28 +0000 Subject: [PATCH] bounding boxes centroids -> bounding box centroids --- docs/source/community/mission-scope.md | 2 +- docs/source/user_guide/input_output.md | 2 +- docs/source/user_guide/movement_dataset.md | 2 +- movement/io/load_bboxes.py | 4 ++-- movement/validators/datasets.py | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/community/mission-scope.md b/docs/source/community/mission-scope.md index 1d2ae8b7..e9663080 100644 --- a/docs/source/community/mission-scope.md +++ b/docs/source/community/mission-scope.md @@ -28,7 +28,7 @@ generate keypoint representations from video data by detecting body parts and tracking them across frames. In the context of `movement`, we refer to these trajectories as _tracks_: we use _pose tracks_ to refer to the trajectories of a set of keypoints, _bounding box tracks_ to refer to the trajectories -of bounding boxes centroids, or _motion tracks_ in the more general case. +of bounding box centroids, or _motion tracks_ in the more general case. Our vision is to present a **consistent interface for representing motion tracks** along with **modular and accessible analysis tools**. We aim to diff --git a/docs/source/user_guide/input_output.md b/docs/source/user_guide/input_output.md index 122db146..3511d0f1 100644 --- a/docs/source/user_guide/input_output.md +++ b/docs/source/user_guide/input_output.md @@ -4,7 +4,7 @@ (target-formats)= ## Supported formats (target-supported-formats)= -`movement` supports the analysis of trajectories of keypoints (_pose tracks_) and of bounding boxes centroids (_bounding box tracks_). +`movement` supports the analysis of trajectories of keypoints (_pose tracks_) and of bounding box centroids (_bounding box tracks_). To analyse pose tracks, `movement` supports loading data from various frameworks: - [DeepLabCut](dlc:) (DLC) diff --git a/docs/source/user_guide/movement_dataset.md b/docs/source/user_guide/movement_dataset.md index 23314c18..8c83b378 100644 --- a/docs/source/user_guide/movement_dataset.md +++ b/docs/source/user_guide/movement_dataset.md @@ -162,7 +162,7 @@ A `movement` poses dataset contains two **data variables**: :::{tab-item} Bounding boxes dataset A `movement` bounding boxes dataset contains three **data variables**: -- `position`: the 2D locations of the bounding boxes centroids over time, with shape (`time`, `space`, `individuals`). +- `position`: the 2D locations of the bounding box centroids over time, with shape (`time`, `space`, `individuals`). - `shape`: the width and height of the bounding boxes over time, with shape (`time`, `space`, `individuals`). - `confidence`: the confidence scores associated with each predicted bounding box, with shape (`time`, `individuals`). ::: diff --git a/movement/io/load_bboxes.py b/movement/io/load_bboxes.py index e9198fbc..e5c2014b 100644 --- a/movement/io/load_bboxes.py +++ b/movement/io/load_bboxes.py @@ -37,7 +37,7 @@ def from_numpy( ---------- position_array : np.ndarray Array of shape (n_frames, n_space, n_individuals) - containing the tracks of the bounding boxes centroids. + containing the tracks of the bounding box centroids. It will be converted to a :class:`xarray.DataArray` object named "position". shape_array : np.ndarray @@ -377,7 +377,7 @@ def _numpy_arrays_from_via_tracks_file( keys: - position_array (n_frames, n_space, n_individuals): - contains the trajectories of the bounding boxes centroids. + contains the trajectories of the bounding box centroids. - shape_array (n_frames, n_space, n_individuals): contains the shape of the bounding boxes (width and height). - confidence_array (n_frames, n_individuals): diff --git a/movement/validators/datasets.py b/movement/validators/datasets.py index 81794ee1..0f51eec5 100644 --- a/movement/validators/datasets.py +++ b/movement/validators/datasets.py @@ -250,7 +250,7 @@ class ValidBboxesDataset: ---------- position_array : np.ndarray Array of shape (n_frames, n_space, n_individuals) - containing the tracks of the bounding boxes centroids. + containing the tracks of the bounding box centroids. shape_array : np.ndarray Array of shape (n_frames, n_space, n_individuals) containing the shape of the bounding boxes. The shape of a bounding