Add a ValidVIAtracksCSV class (2/4)

[sfmig]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
We want to be able to load track bounding boxes annotations written in the VIA format.

What does this PR do?
It adds a ValidVIAtracksCSV class that validates VIA output files.

The validator is a bit more strict in its checks than the currently existing ones. This is because when we later load the VIA file data into a bounding box class, we make assumptions about it that are not necessarily enforced in the annotator tool per se (e.g. having unique bounding boxes IDs per frame).

The checks are roughly:

• a unique frame number must be associated with each image file,
• the csv file must contain tracked and rectangular bounding boxes,
• the bounding boxes IDs are unique per frame.

The fixtures in conftest.py have increased quite a bit though, but I left that for a future PR (issue #222).

References

#167

How has this PR been tested?

Tests pass locally and in CI.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

I updated api_index.rst (but this won't be needed anymore soon! 🥳 #213)

Checklist:

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.74%. Comparing base (4830fd5) to head (8c8beea).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #219      +/-   ##
==========================================
+ Coverage   99.71%   99.74%   +0.02%     
==========================================
  Files          13       13              
  Lines         714      771      +57     
==========================================
+ Hits          712      769      +57     
  Misses          2        2              

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

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[niksirbi]

WoW, what a titanic effort to define all those valdations and fixtures. But now you can be sure your parsing is tightly secure :)

Nothing substantial to comment here, other than the (now obvious) need for a fixture refactor, which you've mentioned yourself

[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 SonarCloud