No project description provided
Project description
Fast Reflection Removal
Removes reflections quickly and easily.
How to use
You can either:
- install it as a Python package,
- clone and use it as a repository, or
- use it as a web app on my website.
How to install
Prerequisities
- Python: 3.8
As a package
In your own project, just perform the following command:
# python refers to the virtual environment to install package to
python -m pip install fast-reflection-removal
Now, you can use the reflection removal in your project in the following manner:
from frr.core import FastReflectionRemoval
...
# numpy array with values between 0 and 1 of shape (H, W, C)
img = ...
# instantiate the algoroithm class
alg = FastReflectionRemoval(h = 0.11)
# run the algorithm and get result of shape (H, W, C)
dereflected_img = alg.remove_reflection(img)
...
As a repository
- Clone the project and go to its root directory.
- Create and activate the virtual environment:
# create the environment python3 -m venv "venv" # activate the environment source venv/bin/activate # on Windows ./venv/Scripts/activate.ps1 in Powershell
- Install the necessary packages:
python -m pip install --upgrade pip python -m pip install --upgrade wheel setuptools pip-tools
- Install the packages from requirements and the project:
make sync # on windows just perform the following commands: python -m piptools sync requirements.txt; python -m pip install -e .
How to run the project
To run the project, we need to run script bin/run.py. The important parameters of this script are:
- h: larger h leads to more reflections removed, but the result image will be blurrier,
- input_path: path to the input image,
- output_path: path to the output image.
Example:
# activate the environment
source venv/bin/activate # on Windows ./venv/Scripts/activate.ps1 in Powershell
python bin/run.py --h=0.11 --input_path="docs/toy_example.jpg" --output_path="docs/toy_example_out.jpg"
The program, in this example, loads input image from the path docs/toy_example.jpg, processes it with parameter h=0.11 and outputs it into docs/toy_example_out.jpg.
Project structure
Folders:
- bin: executable python files.
- docs: documentation.
- src: contains list of folders for sources, e.g. python.
- tests: follows the structure of src/python.
Credits
This repository implements paper Fast Single Image Reflection Suppression via Convex Optimization authored by Yang Yang, Wenye Ma, Yin Zheng, Jian-Feng Cai and Weiyu Xu.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for fast_reflection_removal-1.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 296168e41495f1a51bf5cfd0de59d951d554ea27e4a4cf2a791288e1e34391f3 |
|
MD5 | 2e8ddf5bf076b6397135d93c3f6fc4ce |
|
BLAKE2b-256 | 83ef56492a941f70b678aea73c0e61adb3a81a82c981cb76e460ca34715d6b9a |