Added example using `median_filter()` and `savgol_filter()`

niksirbi commented 1 month ago

Description

What is this PR

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

Why is this PR needed?

PR #163 added median and Savitzky-Golay filters but their usages has not beed documented in tutorials/examples.

What does this PR do?

This PR adds a new "Smooth pose tracks" example that guides the users through smoothing data using either or both new filters. Additionally, the titles and subtitles of all examples are using the imperative case (e.g. "smooth" instead of "smoothing") to be consistent with our docstrings.

References

Closes #179 PRs #163 and #189

How has this PR been tested?

The documentation was built locally and inspected. This is also the recommended way of reviewing this PR, as the rendered html is more readable than the sphinx-gallery source file.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

It is in itself an update to documentation.

Checklist:

[x] The code has been tested locally
[n/a] 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.68%. Comparing base (426003c) to head (82a8b6c).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #193 +/- ## ======================================= 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.

niksirbi commented 1 month ago

@lochhh I've accepted all your suggestions! Once CI passes and you approve the PR, it's ready to merge 🎉