Skip to content

Commit

Permalink
bounding boxes centroids -> bounding box centroids
Browse files Browse the repository at this point in the history
  • Loading branch information
sfmig committed Jan 29, 2025
1 parent afb4105 commit bd33d96
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/community/mission-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/input_output.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/movement_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
:::
Expand Down
4 changes: 2 additions & 2 deletions movement/io/load_bboxes.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion movement/validators/datasets.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bd33d96

Please sign in to comment.