Skip to content

Commit

Permalink
fix: remove literal from docstrings to see if it flies
Browse files Browse the repository at this point in the history
  • Loading branch information
oesteban committed Jun 10, 2024
1 parent ea30464 commit 07818c5
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/eddymotion/data/filtering.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,16 @@
from scipy.ndimage import median_filter
from skimage.morphology import ball

DEFAULT_DTYPE = "int16"
"""The default image's data type."""


def advanced_clip(
data: np.ndarray,
p_min: float = 35,
p_max: float = 99.98,
nonnegative: bool = True,
dtype: str | np.dtype = "int16",
dtype: str | np.dtype = DEFAULT_DTYPE,
invert: bool = False,
) -> np.ndarray:
"""
Expand All @@ -58,7 +61,7 @@ def advanced_clip(
are set to the threshold value.
nonnegative : :obj:`bool`, optional (default=``True``)
If True, only consider non-negative values when calculating thresholds.
dtype : :obj:`str` or :obj:`~numpy.dtype`, optional (default=``"int16"``)
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``)
Expand Down

0 comments on commit 07818c5

Please sign in to comment.