Compute Forward Vector - Githubissues

b-peri commented 1 month ago

Description (Edited 24/09/2024)

This PR adds compute_forward_vector() - a new kinematic function for computing a forward/rostral-facing vector given two keypoints - to movement. As described in #238, this function takes two left-right symmetrical keypoints (i.e. symmetrical across the animal's mid-saggital plane) and computes the vector perpendicular to the line connecting them. The result is an xr.DataArray of vectors pointing in the animal's rostral direction at each timepoint. As we expect this function to be commonly used for the computation of head direction vectors, this PR also adds compute_head_direction_vector(), a convenient alias for compute_forward_vector() whose docstring more explicitly refers to points on the head (rather than on the body, more generically).

What is this PR

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

References

Part one of #238

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 month ago

Codecov Report

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

Project coverage is 99.77%. Comparing base (9c80786) to head (b2de46a).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #276 +/- ## ======================================= Coverage 99.77% 99.77% ======================================= Files 15 15 Lines 887 909 +22 ======================================= + Hits 885 907 +22 Misses 2 2 ```

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

lochhh commented 2 weeks ago

Quality Gate passed

Issues 3 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

Hey @b-peri , just a note to also remove any uppercase letters in function names.

b-peri commented 2 weeks ago

Quality Gate passed

Issues 3 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

Hey @b-peri , just a note to also remove any uppercase letters in function names.