Bounding boxes example

[sfmig]

Rebase after #313 is merged

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
To demo the bounding boxes' dataset.

What does this PR do?

• It shows how to load a sample bounding boxes dataset and its structure
• It shows how to plot bounding boxes using the position and shape arrays
• It shows different simple options to fill in missing values in the position and shape arrays
• It also fixes a typo in the input/output documentation re exporting bounding boxes datasets as csv files.

References

Closes #247.

Rebase after #313 is merged

How has this PR been tested?

Docs build locally and test pass locally and in CI.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

No.

Checklist:

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

[sonarqubecloud]

Quality Gate failed

Failed conditions
21.6% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (e0cdf8e) to head (1d7299f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #312   +/-   ##
=======================================
  Coverage   99.78%   99.78%           
=======================================
  Files          14       14           
  Lines         932      932           
=======================================
  Hits          930      930           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lochhh]

Quality Gate passed

Issues 3 New issues

Need resolving

[sfmig]

hey, thanks for having a look!

From the issues flagged by sonarcloud:

• two are due to duplicate lines, because I am printing explanatory lines a few times in the example. Namely:
  • print("Position data array (first 14 frames):") and
  • print("Shape data array (first 14 frames):").
• one is due to commented out code for # sphinx_gallery_thumbnail_number = 2, but this is the syntax to change the default thumbnail shown in the example. We are using the same approach in another example too.

I think for clarity it makes sense to keep the duplicate lines as is and not define a separate variable, but lmk if you disagree.

I cannot retrieve the reports from previous tutorials anymore (examples here and here) but it seems in those cases we skipped three issues too.

[niksirbi]

Thank you @sfmig, this is a great example! I left a bunch of comments, many of them nitpicky and/or subjective.

My two substantial points are:

• I think we should change the name and/or tagline of this example. I don't think that "reindexing" means much to most users
• we should rely on selecting the data with sel and isel as much as possible, and avoid numpy-style indexing (which is contingent on a certain dimension order).

[niksirbi]

hey, thanks for having a look!

From the issues flagged by sonarcloud:

• two are due to duplicate lines, because I am printing explanatory lines a few times in the example. Namely:

  • print("Position data array (first 14 frames):") and
  • print("Shape data array (first 14 frames):").

• one is due to commented out code for # sphinx_gallery_thumbnail_number = 2, but this is the syntax to change the default thumbnail shown in the example. We are using the same approach in another example too.

I think for clarity it makes sense to keep the duplicate lines as is and not define a separate variable, but lmk if you disagree.

I cannot retrieve the reports from previous tutorials anymore (examples here and here) but it seems in those cases we skipped three issues too.

Regarding the sonarclous issues, I agree that you can ignore them in this case. We don't mind some repetition in the examples (it's often a good thing, pedagogically).

[niksirbi]

Just 1 comment @sfmig, and after that it's good to merge!

I really like the new plots you've added now.

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud