Skip to content

Commit

Permalink
Correct prefilters docstrings (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
emotion3459 authored Sep 25, 2024
1 parent af610b5 commit 5cad32c
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions vsdenoise/prefilters.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,13 +253,13 @@ class Prefilter(PrefilterBase):
"""Don't do any prefiltering. Returns the clip as-is."""

MINBLUR1 = 0
"""A gaussian/temporal median merge with a radius of 1."""
"""Minimum difference of a gaussian/median blur with a radius of 1."""

MINBLUR2 = 1
"""A gaussian/temporal median merge with a radius of 2."""
"""Minimum difference of a gaussian/median blur with a radius of 2."""

MINBLUR3 = 2
"""A gaussian/temporal median merge with a radius of 3."""
"""Minimum difference of a gaussian/median blur with a radius of 3."""

MINBLURFLUX = 3
""":py:attr:`MINBLUR2` with temporal/spatial average."""
Expand All @@ -271,19 +271,19 @@ class Prefilter(PrefilterBase):
"""Denoising like in DFTTEST but with high defaults for lower frequencies."""

NLMEANS = 5
"""Denoising with NLMeans, then postprocessed to remove low frequencies."""
"""Denoising with NLMeans, then postprocessed to restore low frequencies."""

BM3D = 6
"""Normal spatio-temporal denoising using BM3D."""

SCALEDBLUR = 7
"""Perform blurring at a scaled-down resolution, then scale it back up."""
"""Perform blurring at a scaled-down resolution, then scaled back up."""

GAUSS = 13
"""Simply Gaussian blur."""
"""Gaussian blur."""

GAUSSBLUR = 8
"""Gaussian blurred, then postprocessed to remove low frequencies."""
"""Gaussian blurred, then postprocessed to restore low frequencies."""

GAUSSBLUR1 = 9
"""Clamped gaussian/box blurring."""
Expand Down Expand Up @@ -352,7 +352,7 @@ def __call__( # type: ignore
simr: SingleOrArr[int] = 2, device_type: DeviceType = DeviceType.AUTO, **kwargs: Any
) -> vs.VideoNode:
"""
Denoising with NLMeans, then postprocessed to remove low frequencies.
Denoising with NLMeans, then postprocessed to restore low frequencies.
:param clip: Source clip.
:param strength: Controls the strength of the filtering.\n
Expand Down Expand Up @@ -408,7 +408,7 @@ def __call__( # type: ignore
downscaler: ScalerT = Bilinear, upscaler: ScalerT | None = None
) -> vs.VideoNode:
"""
Perform blurring at a scaled-down resolution, then scale it back up.
Perform blurring at a scaled-down resolution, then scaled back up.
:param clip: Clip to be preprocessed.
:param planes: Planes to be preprocessed.
Expand All @@ -431,7 +431,7 @@ def __call__( # type: ignore
sigma: float | None = 1.0, sharp: float | None = None, mode: ConvMode = ConvMode.HV
) -> vs.VideoNode:
"""
Gaussian blurred, then postprocessed to remove low frequencies.
Gaussian blurred, then postprocessed to restore low frequencies.
:param clip: Clip to be preprocessed.
:param planes: Planes to be preprocessed.
Expand Down Expand Up @@ -597,7 +597,7 @@ def __call__( # type: ignore
simr: SingleOrArr[int] = 2, device_type: DeviceType = DeviceType.AUTO, **kwargs: Any
) -> PrefilterPartial:
"""
Denoising with NLMeans, then postprocessed to remove low frequencies.
Denoising with NLMeans, then postprocessed to restore low frequencies.
:param planes: Set the clip planes to be processed.
:param strength: Controls the strength of the filtering.\n
Expand Down Expand Up @@ -649,7 +649,7 @@ def __call__( # type: ignore
downscaler: ScalerT = Bilinear, upscaler: ScalerT | None = None
) -> PrefilterPartial:
"""
Perform blurring at a scaled-down resolution, then scale it back up.
Perform blurring at a scaled-down resolution, then scaled back up.
:param planes: Planes to be preprocessed.
:param full_range: Whether to return a prefiltered clip in full range.
Expand All @@ -670,7 +670,7 @@ def __call__( # type: ignore
sigma: float | None = 1.0, sharp: float | None = None, mode: ConvMode = ConvMode.HV
) -> PrefilterPartial:
"""
Gaussian blurred, then postprocessed to remove low frequencies.
Gaussian blurred, then postprocessed to restore low frequencies.
:param planes: Planes to be preprocessed.
:param full_range: Whether to return a prefiltered clip in full range.
Expand Down

0 comments on commit 5cad32c

Please sign in to comment.