Updated readme.

master
Rostislav Lán 2 years ago
parent 8c97c1ca8d
commit c6d59dcd2c

@ -44,11 +44,11 @@ There are two ways to enter filters
* manually from command line, list filter names and parameters
```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
```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
@ -57,21 +57,24 @@ There is an option to input the filter series as a preset to json configuration
```diff
{
"preset_name": [
"weak": [
{
"name": "first_filter_name",
"first_param_name": first_param_value,
"second_param_name": second_param_value
...
"name": "denoise_tv_chambolle",
"sigmaColor": 0.1,
"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>
</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.
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.
# Fingerprint mapped to finger model
# Mapping to existing finger model
This section will be added later.

Loading…
Cancel
Save