neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
77 stars 7 forks source link

Added new smoothing functions to API index #189

Closed ivanvrlg closed 1 month ago

ivanvrlg commented 1 month ago

Description

What is this PR

Why is this PR needed? PR 163 added median and Savgol filter functions but they were not added to the API index. What does this PR do? Updated documentation for two existing functions savgol_filter and median_filter

References

163

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

No

Does this PR require an update to the documentation?

No, it itself is an update to the documentation.

Checklist:

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 99.68%. Comparing base (ccd30d4) to head (ea831af).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #189 +/- ## ======================================= Coverage 99.68% 99.68% ======================================= Files 11 11 Lines 638 638 ======================================= Hits 636 636 Misses 2 2 ```

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

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud