Gaussian filter and smoothing recipe

d-chambers commented 8 months ago

Description

This PR addresses #296 by implementing a Patch.gaussian_filter method. Patch.savgol_filter was added previously.

Additionally, I created a recipe which demonstrates each of the smoothing methods (rolling, gaussian, savgol). I also tweaked the existing savgol_filter implementation so that multiple dimensions can be filtered in the same function call.

Checklist

I have (if applicable):

[ ] referenced the GitHub issue this PR closes.
[ ] documented the new feature with docstrings or appropriate doc page.
[ ] included a test. See testing guidelines.
[ ] your name has been added to the contributors page (docs/contributors.md).
[ ] added the "ready_for_review" tag once the PR is ready to be reviewed.

codecov[bot] commented 8 months ago

Codecov Report

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

Comparison is base (8190ec7) 99.52% compared to head (671b6a1) 99.52%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #337 +/- ## ======================================= Coverage 99.52% 99.52% ======================================= Files 91 91 Lines 7192 7201 +9 ======================================= + Hits 7158 7167 +9 Misses 34 34 ``` | [Flag](https://app.codecov.io/gh/DASDAE/dascore/pull/337/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/DASDAE/dascore/pull/337/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | `99.52% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE#carryforward-flags-in-the-pull-request-comment) to find out more.

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

d-chambers commented 8 months ago

I am going to merge this so the new docs build (I need to setup an PR doc deployment, but not today...)

@ariellellouch do you mind taking a look before the next release (probably towards the end of next week) and open a new PR/issue if you can think of any changes to make?

ariellellouch commented 8 months ago

Thanks! It looks good to me, so no need for a new PR The only comment I have is that the .qmd file (line 112) seems to be cut mid-line

d-chambers commented 8 months ago

The only comment I have is that the .qmd file (line 112) seems to be cut mid-line

Thanks! I am not sure how I missed that.

DASDAE / dascore