Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct prefilters docstrings #127

Merged
merged 1 commit into from
Sep 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading