Add a ValidBboxesDataset class

sfmig commented 3 weeks ago

Description

What is this PR

[ ] Bug fix
[x] Addition of a new feature
[ ] Other

Why is this PR needed? We want to be able to load bounding boxes tracks (see #167).

What does this PR do?? This PR defines a ValidBboxesDataset class, that follows ValidPosesDataset.

A bounding boxes dataset is made up of 4 data arrays:

position: (required) holds the x, y coordinates of the bounding box centroid.
- Typically it will be an array of shape (n_frames, n_individuals, n_spatial_coords), but we only enforce the last dimension (spatial) to have 2 coordinates.
shape: (required) holds the width and height of the bounding box.
- The same validation from the position array is applied.
confidence: (optional) holds the confidence score for the bounding box. If None is passed, it is filled in with nans.
- We check its n dimensions have the same number of coordinates as the first n dimensions of the position array.
individual_names: (optional) a list of bounding boxes IDs. If None is passed, we assign 1-based IDs that are unique per frame. The 1-based convention for the IDs follows MOT challenge.

We are assuming 2D bounding boxes only for now (through the validation of the position and the shape arrays).

Questions

In the tests, I am ensuring the error case is the one I expect to fall in by checking the error message. Should we do this in the rest of the tests too?
In the pose dataset, we enforce the position array to have a fixed number of dimensions, which I am not doing in the bboxes dataset. This is inconsistent atm, but my understanding from chats with @niksirbi, from this PR #206 and from this related issue is that we would like to remove that restriction. Do correct me if I am wrong!

References

Issue #167.

This work is derived from splitting #186 into smaller PRs.

How has this PR been tested?

Tests pass locally and on CI.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

It will require an update once the bounding boxes functionality is complete.

Checklist:

[x] The code has been tested locally
[x] Tests have been added to cover all new functionality
[ n/a ] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.70%. Comparing base (e4eea35) to head (2f4cf20).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #201 +/- ## ========================================== + Coverage 99.68% 99.70% +0.01% ========================================== Files 12 12 Lines 643 678 +35 ========================================== + Hits 641 676 +35 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.