Load bboxes dataset from VIA tracks file (3/4)

sfmig commented 1 week ago

Rebase after #231 is merged

Description

What is this PR

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

Why is this PR needed? To be able to load a VIA tracks file with bounding boxes into a movement dataset.

What does this PR do?

Adds a movement.io.load_bboxes module, which follows the equivalent poses one as much as possible.
Adds corresponding unit tests in tests_load_bboxes.

Question: how to make mypy aware of the type transformations that take place in __attrs_post_init__? For example, the confidence array passed to ValidBboxesDataset can be None, and mypy flags that a .shape attribute is used later which None doesn't have. But mypy seems to be missing that the confidence array is populated with nans in __attrs_post_init__ if None is passed as input. Is there a nice way to fix this?

References

This PR would close #167

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?

I updated api_index.rst.

Checklist:

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

codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 99.76%. Comparing base (2e406e1) to head (f8052a8).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #229 +/- ## ========================================== + Coverage 99.70% 99.76% +0.05% ========================================== Files 12 13 +1 Lines 678 840 +162 ========================================== + Hits 676 838 +162 Misses 2 2 ```

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