Metadata-Version: 2.1
Name: vsdenoise
Version: 2.3.0
Summary: VapourSynth denoising functions
Author: Irrational Encoding Wizardry
Author-email: wizards@encode.moe
Maintainer: Irrational Encoding Wizardry
Maintainer-email: wizards@encode.moe
Project-URL: Source Code, https://github.com/Irrational-Encoding-Wizardry/vs-denoise
Project-URL: Documentation, https://vsdenoise.encode.moe/en/latest/
Project-URL: Contact, https://discord.gg/qxTxVJGtst
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# vs-denoise

### VapourSynth denoising, regression, and motion-compensation functions
<br>

Wrappers for denoising, regression, and motion-compensation-related plugins and functions.

You can find me in the [IEW Discord server](https://discord.gg/qxTxVJGtst), @Setsugennoao#6969.
<br><br>
## How to install

Install `vsdenoise` with the following command:

```sh
$ pip install vsdenoise
```

Or if you want the latest git version, install it with this command:

```sh
$ pip install git+https://github.com/Irrational-Encoding-Wizardry/vs-denoise.git
```
<br><br>

## Example usage
```py
from vsdenoise import MVTools, SADMode, MotionMode, Prefilter, BM3DCuda, Profile, nl_means

clip = ...

ref = MVTools.denoise(
    clip, thSAD=100, block_size=32, overlap=16,
    motion=MotionMode.HIGH_SAD,
    prefilter=Prefilter.DFTTEST,
    sad_mode=(
        SADMode.ADAPTIVE_SPATIAL_MIXED,
        SADMode.ADAPTIVE_SATD_MIXED,
    )
)

denoise = BM3DCuda.denoise(
    clip, sigma=0.8, tr=2, profile=Profile.NORMAL, ref=ref, planes=0
)

denoise = nl_means(denoise, tr=2, strength=0.6, ref=ref, planes=[1, 2])
```
