diff --git a/.gitignore b/.gitignore index ccff41e..b501851 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ /src/__pycache__ -/res/* /res !/res/example-before.png !/res/example-after.png \ No newline at end of file diff --git a/README.md b/README.md index ce3abdb..0ea4f58 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ It should also have the functionality to convert the image to stl model. For now this is only viable for ubuntu gnu/linux machines Before cloning repository, you need these to succesfully use the application. -* python3.10 is a requirement +* python version 3.10 is a requirement might work on earlier python 3 versions ```sh apt install python3.10 ``` @@ -21,6 +21,7 @@ Before cloning repository, you need these to succesfully use the application. pip install numpy matplotlib opencv-python pillow ``` + # Installation Installation is relatively fast and easy. @@ -31,6 +32,7 @@ Installation is relatively fast and easy. ``` 2. Prepare the image file with fingerprint, run the application + # Usage There are two ways to enter filter series @@ -43,6 +45,13 @@ There are two ways to enter filter series ```sh python src/main.py res/test_fp.png res/test_fp_cpy.png 100 --config config/config.json default_preset ``` +# Resulting images +Before filtering | After filtering +:-------------------------:|:-------------------------: +![before filtering](https://strade.fit.vutbr.cz/git/xlanro00/BP_DP-xlanro00/src/branch/master/res/example-before.png) | +![after filtering](https://strade.fit.vutbr.cz/git/xlanro00/BP_DP-xlanro00/src/branch/master/res/example-after.png) + + # Roadmap @@ -54,6 +63,7 @@ There are two ways to enter filter series - [ ] Convert image to stl format - [ ] Export final model ready for printing + # ### Author diff --git a/res/example-after.png b/res/example-after.png new file mode 100644 index 0000000..cf45b3b Binary files /dev/null and b/res/example-after.png differ diff --git a/res/example-before.png b/res/example-before.png new file mode 100644 index 0000000..5e01cec Binary files /dev/null and b/res/example-before.png differ