Rename pose_tracks to position

niksirbi commented 3 months ago

Description

What is this PR

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

Why is this PR needed?

With the addition of kinematic data variables named displacement, velocity, acceleration etc., it's awkward to keep calling the variable containing poses pose_tracks. All of these variables are "tracks", in the sense that they are time-series.

What does this PR do?

It renames the xarray.DataArray previously known as pose_tracks to position. This is more consistent with the naming of the other variables. I also did some additional renaming in comments/docstrings and in a few variables/functions/class names, to ensure that they are consistent with the new terminology.

Note that in many places in the docs and in comments/docstrings I decided to keep using the term "pose tracks". But this usage refers to the overall type of the data - i.e. tracks of poses over time - not the particular variable/attribute. This should become clearer once we address #69.

References

Closes #100

How has this PR been tested?

This kind of change would be very painful without existing tests. Our nearly universal test coverage allowed me to catch the few instances I'd missed. I fixed them and the tests all pass now.

Does this PR require an update to the documentation?

Yes, and I went through the docs and updated all instances I (and my IDEs) could find. I've also updated an image that contained the term pose_tracks as the name of the corresponding DataArray.

How to review

The diff of this PR will be impossible to review directly, as almost all files have been affected. Perhaps it's more critical to go over our public docs and double-check that the term is used consistently there.

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 3 months ago

Codecov Report

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

Project coverage is 99.28%. Comparing base (7455216) to head (58bc960).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #149 +/- ## ======================================= Coverage 99.28% 99.28% ======================================= Files 9 9 Lines 556 557 +1 ======================================= + Hits 552 553 +1 Misses 4 4 ```

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