Updated readme to include optional stl generation parameters.

master
Rostislav Lán 2 years ago
parent 681c5bd051
commit 478497fb02

@ -61,10 +61,7 @@ There is an option to input the filter series as a preset to json configuration
"weak": [
{
"name": "denoise_tv_chambolle",
"sigmaColor": 0.1,
"weight": 0.01,
"sigmaSpace": 3,
"channelAxis": 0,
"iterations": 1
},
{
@ -96,24 +93,30 @@ Image before processing the fingerprint and after applying a presets.
</tbody>
</table>
# Generating STL file
# Generating curved finger model
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.
It is possible to generate 3D printable stl model using `--stl` switch, which requires aditional parameter containing stl filename.
In base mode the output model will be a curved finger model, with optional parameters following the filename controlling its shape.
First optional parameter is papilar line height, second rate of curvature along x axis and the third is the rate of curvature along y axis.
* Example stl generation
* Example planar 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
python src/main.py res/test_fp.png res/test_fp_mod.png 508 --config config/config.json weak --stl res/test_fp.stl 2 2 4
```
# Generating STL finger model
# Generating planar 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.
Using `-p` switch makes the generated model planar. This is not the main goal of the application.
Optional parameters are model base thickness and papilar lines height, they are set after stl file name.
* Example curved 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 10 2 -p
```
# Mapping to existing finger model
This section will be added later.
This section will be added later, (if implemented) mapping of fingerprint to a given finger model.
# Roadmap
@ -126,9 +129,9 @@ This section will be added later.
- [ ] Add the option to save current filter preset to config file
- [X] Add the option to modify filter parameters
- [X] Convert the processed image to stl lithophane
- [ ] Add the option to curve the lithophane into the shape of a finger
- [X] Add the option to curve the lithophane into the shape of a finger
- [ ] Add the option to map the lithophane on a given finger model
- [ ] Export final model ready for 3D print
- [X] Export final model ready for 3D print
#
### Author

Loading…
Cancel
Save