Skip to content

Commit

Permalink
Updated the readme with an example of ndfilters.mean_filter(). (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrdie authored May 27, 2024
1 parent e39a644 commit 53a854f
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,18 @@ Similar to the filters in `scipy.ndimage` but accelerated using `numba`.
pip install ndfilters
```

## Examples
## Gallery

The only filter currently implemented is a [trimmed mean filter](https://ndfilters.readthedocs.io/en/latest/_autosummary/ndfilters.trimmed_mean_filter.html#ndfilters.trimmed_mean_filter).
This filter ignores a given portion of the dataset before calculating the mean at each pixel.
### Mean filter

![trimmed mean filter](https://ndfilters.readthedocs.io/en/latest/_images/ndfilters.trimmed_mean_filter_0_2.png)
The [mean filter](https://ndfilters.readthedocs.io/en/latest/_autosummary/ndfilters.mean_filter.html#ndfilters.mean_filter)
calculates a multidimensional rolling mean for the given kernel shape.

![mean filter](https://ndfilters.readthedocs.io/en/latest/_images/ndfilters.mean_filter_0_3.png)

### Trimmed mean filter

The [trimmed mean filter](https://ndfilters.readthedocs.io/en/latest/_autosummary/ndfilters.trimmed_mean_filter.html#ndfilters.trimmed_mean_filter)
is like the mean filter except it ignores a given portion of the dataset before calculating the mean at each pixel.

![trimmed mean filter](https://ndfilters.readthedocs.io/en/latest/_images/ndfilters.trimmed_mean_filter_0_0.png)

0 comments on commit 53a854f

Please sign in to comment.