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

Updated documentation to fix issues with old parameters.

Browse Source
This commit is contained in:
Rostislav Lán
2023-05-06 16:07:06 +02:00
parent c709f730f3
commit d32e0279e4
15 changed files with 35 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/filtering.rst
View File

@ -34,4 +34,4 @@ There are two ways to enter the filters:
.. code-block::
(.venv)$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json git_example
(.venv)$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json new_ridge

6
docs/source/generation.rst
View File

@ -26,7 +26,7 @@ third the rate of curvature along x axis `curv_rate_x` and the third is the rate
.. code-block:: console
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json git_example --stl c 2 10 2 2
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json new_ridge --stl c 2 10 2 2
Generating planar finger model
-----------------------------------
@ -44,7 +44,7 @@ Optional parameters are height of the papilar lines and base thickness.
.. code-block::
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json git_example --stl p 2 10
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json new_ridge --stl p 2 10
Mapping fingerprint to existing finger model
--------------------------------------------
@ -65,6 +65,6 @@ These control the location of the finger. They need to be set only if the user w
.. code-block:: console
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4.png 600 --config conf/conf.json ridge --stl m 0.2 2 0 0 0 res/finger_backup/finger-mod.stl
$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4.png 600 --config conf/conf.json new_ridge --stl m 0.2 2 0 0 0 res/finger_backup/finger.stl

8
docs/source/usage.rst
View File

@ -18,8 +18,8 @@ Which will print out the following message.
$ usage: main.py [-h] [-m | --mirror | --no-mirror] input_file
output_file dpi ([-c | --config config_file preset] |
[filters ...]) [-s | --stl_file p height_line height_base |
--stl_file c height_line height_base curv_rate_x curv_rate_y |
[filters ...]) [-s | --stl p height_line height_base |
--stl c height_line height_base curv_rate_x curv_rate_y |
--stl m height_line iter finger_x finger_y finger_z finger_model]
[-d | --database database_filename]
@ -37,8 +37,10 @@ Which will print out the following message.
-h, --help show this help message and exit
-m, --mirror, --no-mirror
switch to mirror input image
-s [STL_FILE ...], --stl_file [STL_FILE ...]
-s [STL ...], --stl [STL ...]
create stl model from processed image
-c CONFIG CONFIG, --config CONFIG CONFIG
pair: name of the config file with presets,
name of the preset
-d DATABASE, --database DATABASE
switch to store presets in config database