Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
Merge pull request #209 from jhlegarreta/RemoveOptionalValuesInDocstring
Browse files Browse the repository at this point in the history
DOC: Remove optional values in docstring
  • Loading branch information
oesteban authored Jun 12, 2024
2 parents c09cac4 + a1957dc commit f9078cc
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/eddymotion/data/filtering.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,19 @@ def advanced_clip(
----------
data : :obj:`~numpy.ndarray`
The input n-dimensional data array.
p_min : :obj:`float`, optional (default=35)
p_min : :obj:`float`, optional
The lower percentile threshold for clipping. Values below this percentile
are set to the threshold value.
p_max : :obj:`float`, optional (default=99.98)
p_max : :obj:`float`, optional
The upper percentile threshold for clipping. Values above this percentile
are set to the threshold value.
nonnegative : :obj:`bool`, optional (default=``True``)
nonnegative : :obj:`bool`, optional
If True, only consider non-negative values when calculating thresholds.
dtype : :obj:`str` or :obj:`~numpy.dtype`, optional
The desired data type for the output array. Supported types are "uint8"
and "int16".
invert : :obj:`bool`, optional (default=``False``)
If True, inverts the intensity values after scaling (1.0 - data).
invert : :obj:`bool`, optional
If ``True``, inverts the intensity values after scaling (1.0 - ``data``).
Returns
-------
Expand Down

0 comments on commit f9078cc

Please sign in to comment.