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

Adding Docstrings #115

Merged
merged 3 commits into from
Apr 10, 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
32 changes: 32 additions & 0 deletions vsdenoise/freqs.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,38 @@ def frequency_merge(
mean_diff: bool = False, planes: PlanesT = None, mv_args: KwargsT | None = None,
**kwargs: Any
) -> vs.VideoNode:
"""
Merges the frequency components of the input clips.

:param _clips: The clips to merge.
:param tr: The temporal radius to use for motion compensation.
:param mode_high: The mode to use for the high frequency components or
specifying the clip with the high frequency components.
:param mode_low: The mode to use for the low frequency components or
specifying the clip with the low frequency components.
:param mode_tr: The mode to use for motion compensation.
If None, it defaults to the value of mode_high.
:param lowpass: The lowpass filter to used to extract low frequency components.
Example:
```
lowpass=[
None,
lambda i: core.fmtc.resample(
i,
h=1080,
w=1920,
kernel="lanczos",
taps=[4, 2],
fv=[1 / 1.25, 1 / 1.375],
fh=[1 / 1.25, 1 / 1.375],
)
```
:param mean_diff: Whether to use the mean of the lowpass filter and the original clip to
extract the low frequency components. Default is False.
:param planes: The planes to process. If None, all planes will be processed.
:param mv_args: The arguments to pass to the MVTools class.
"""

clips = flatten_vnodes(_clips)
n_clips = len(clips)

Expand Down
Loading