xlanro00/BP_DP-xlanro00
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated readme.

Browse Source
This commit is contained in:
Rostislav Lán
2023-02-20 15:11:26 +01:00
parent 8c97c1ca8d
commit c6d59dcd2c
1 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -44,11 +44,11 @@ There are two ways to enter filters
* manually from command line, list filter names and parameters * manually from command line, list filter names and parameters
```sh ```sh
python src/main.py res/test_fp.png res/test_fp_cpy.png 100 gaussian ksize=5 erode dilate sharpen python src/main.py res/test_fp.png res/test_fp_cpy.png 100 denoise_tv_chambolle iterations=1 weight=0.1 median ksize=3
``` ```
* manually from preset saved in a json config file, that can be used to create new presets * manually from preset saved in a json config file, that can be used to create new presets
```sh ```sh
python src/main.py res/test_fp.png res/test_fp_cpy.png 100 --config config/config.json default python src/main.py res/test_fp.png res/test_fp_cpy.png 100 --config config/config.json weak
``` ```
# Configuration # Configuration
@ -57,21 +57,24 @@ There is an option to input the filter series as a preset to json configuration
```diff ```diff
{ {
"preset_name": [ "weak": [
{ {
"name": "first_filter_name", "name": "denoise_tv_chambolle",
"first_param_name": first_param_value, "sigmaColor": 0.1,
"second_param_name": second_param_value "weight": 0.01,
... "sigmaSpace": 3,
"channelAxis": 0,
"iterations": 1
}, },
{ {
"name": "second_filter_name", "name": "median",
... "ksize": 3
} },
], ],
"another_preset_name": [ "strong": [
... ...
] ]
...
} }
``` ```
@ -92,19 +95,22 @@ Image before processing the fingerprint and after applying a presets.
</tbody> </tbody>
</table> </table>
# Generated STL lithophane # Generating STL file
It is possible to generate 3D printable stl planar model using `--stl` switch, which requires aditional parameter containing stl filename. Using `-p` switch makes the model planar. This is not the main goal of the application. It is possible to generate 3D printable stl planar model using `--stl` switch, which requires aditional parameter containing stl filename. Using `-p` switch makes the model planar. This is not the main goal of the application.
Additional parameters with model thickness and papilar lines height will be optional. Additional parameters with model thickness and papilar lines height will be optional.
Example running * Example stl generation
```sh
python src/main.py res/test_fp.png res/test_fp_mod.png 508 --config config/config.json weak --stl res/test_fp.stl -p
```
# Generated STL finger model # Generating STL finger model
When `--stl` switch is given without `-p`, the output model will either be a generated curved finger model, or later (if implemented) a fingerprint mapped to finger model. When `--stl` switch is given without `-p`, the output model will either be a generated curved finger model, or later (if implemented) a fingerprint mapped to finger model.
# Fingerprint mapped to finger model # Mapping to existing finger model
This section will be added later. This section will be added later.