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

13
README.md
View File

@ -294,7 +294,7 @@ third the rate of curvature along x axis `curv_rate_x` and the third is the rate
* Working example curved stl generation:
```
python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json new_ridge --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
@ -311,7 +311,7 @@ Optional parameters are height of the papilar lines and base thickness.
* Working example of planar stl generation:
```
python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json new_ridge --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 to existing finger model
@ -331,7 +331,7 @@ The last parameter `finger_model` allows the user to choose custom finger model.
* Working example of finger mapping
```
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-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
```
@ -344,7 +344,7 @@ When in doubt, you can always check the help with:
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 | --stl m height_line iter finger_x finger_y finger_z finger_model [-d | --database database_filename]
usage: main.py [-h] [-m | --mirror | --no-mirror] input_file output_file dpi ([-c | --config config_file preset] | [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]
Program for processing a 2D image into 3D fingerprint.
@ -359,10 +359,13 @@ options:
-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
```
# Troubleshooting

BIN
docs/build/.doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
docs/build/.doctrees/filtering.doctree vendored
View File

Binary file not shown.

BIN
docs/build/.doctrees/generation.doctree vendored
View File

Binary file not shown.

BIN
docs/build/.doctrees/usage.doctree vendored
View File

Binary file not shown.

2
docs/build/_sources/filtering.rst.txt vendored
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

12
docs/build/_sources/generation.rst.txt vendored
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
--------------------------------------------
@ -52,19 +52,19 @@ Mapping fingerprint to existing finger model
Using `m` mode modifies the preexisting finger model to contain fingerprint.
First optional parameter is papilar line height `height_line`, second is the number of iterations `iter` to make the finger mesh denser. Higher number of itertions results in denser finger mesh and better result.
The last three parameters are axis offsets for the finger, `finger_x`, `finger_y`, `finger_z`.
These control the location of the finger. They need to be set only if the user wants to move core of the print closer to the center of the finger.
The next three parameters are axis offsets for the finger, `finger_x`, `finger_y`, `finger_z`.
These control the location of the finger. They need to be set only if the user wants to move core of the print closer to the center of the finger model. The last parameter `finger_model` allows the user to choose custom finger model.
* General command form for mapped stl generation
.. code-block:: console
$ python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line iter finger_x finger_y finger_z
$ python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line iter finger_x finger_y finger_z finger_model
* Working example of finger mapping
.. 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
$ 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

2
docs/build/_sources/usage.rst.txt vendored
View File

@ -20,7 +20,7 @@ Which will print out the following message.
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 |
--stl m height_line iter finger_x finger_y finger_z]
--stl m height_line iter finger_x finger_y finger_z finger_model]
[-d | --database database_filename]
Program for processing a 2D image into 3D fingerprint.

2
docs/build/filtering.html vendored
View File

@ -230,7 +230,7 @@ Fingerprint sample is located in res/examples, its name is Palec_P4.tif.</p>
<ol class="arabic simple" start="2">
<li><p>load them from preset in a JSON <strong>configuration file</strong>, that can be used to tune and modify existing presets, or create new ones:</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(.venv)$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json git_example
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(.venv)$ python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config conf/conf.json new_ridge
</pre></div>
</div>
</section>

12
docs/build/generation.html vendored
View File

@ -221,7 +221,7 @@ third the rate of curvature along x axis <cite>curv_rate_x</cite> and the third
<ul class="simple">
<li><p>Working example curved stl generation:</p></li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>res/examples/Palec_P4.tif<span class="w"> </span>res/examples/Palec_P4_from_preset.png<span class="w"> </span><span class="m">600</span><span class="w"> </span>--config<span class="w"> </span>config/config.json<span class="w"> </span>git_example<span class="w"> </span>--stl<span class="w"> </span>c<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">10</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">2</span>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>res/examples/Palec_P4.tif<span class="w"> </span>res/examples/Palec_P4_from_preset.png<span class="w"> </span><span class="m">600</span><span class="w"> </span>--config<span class="w"> </span>conf/conf.json<span class="w"> </span>new_ridge<span class="w"> </span>--stl<span class="w"> </span>c<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">10</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">2</span>
</pre></div>
</div>
</section>
@ -238,7 +238,7 @@ Optional parameters are height of the papilar lines and base thickness.</p>
<ul class="simple">
<li><p>Working example of planar stl generation:</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ 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
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ 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
</pre></div>
</div>
</section>
@ -246,18 +246,18 @@ Optional parameters are height of the papilar lines and base thickness.</p>
<h2>Mapping fingerprint to existing finger model<a class="headerlink" href="#mapping-fingerprint-to-existing-finger-model" title="Permalink to this heading">#</a></h2>
<p>Using <cite>m</cite> mode modifies the preexisting finger model to contain fingerprint.
First optional parameter is papilar line height <cite>height_line</cite>, second is the number of iterations <cite>iter</cite> to make the finger mesh denser. Higher number of itertions results in denser finger mesh and better result.
The last three parameters are axis offsets for the finger, <cite>finger_x</cite>, <cite>finger_y</cite>, <cite>finger_z</cite>.
These control the location of the finger. They need to be set only if the user wants to move core of the print closer to the center of the finger.</p>
The next three parameters are axis offsets for the finger, <cite>finger_x</cite>, <cite>finger_y</cite>, <cite>finger_z</cite>.
These control the location of the finger. They need to be set only if the user wants to move core of the print closer to the center of the finger model. The last parameter <cite>finger_model</cite> allows the user to choose custom finger model.</p>
<ul class="simple">
<li><p>General command form for mapped stl generation</p></li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>input_file<span class="w"> </span>output_file<span class="w"> </span>dpi<span class="w"> </span>--config<span class="w"> </span>config_file<span class="w"> </span>preset<span class="w"> </span>--stl<span class="w"> </span>m<span class="w"> </span>height_line<span class="w"> </span>iter<span class="w"> </span>finger_x<span class="w"> </span>finger_y<span class="w"> </span>finger_z
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>input_file<span class="w"> </span>output_file<span class="w"> </span>dpi<span class="w"> </span>--config<span class="w"> </span>config_file<span class="w"> </span>preset<span class="w"> </span>--stl<span class="w"> </span>m<span class="w"> </span>height_line<span class="w"> </span>iter<span class="w"> </span>finger_x<span class="w"> </span>finger_y<span class="w"> </span>finger_z<span class="w"> </span>finger_model
</pre></div>
</div>
<ul class="simple">
<li><p>Working example of finger mapping</p></li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>res/examples/Palec_P4.tif<span class="w"> </span>res/examples/Palec_P4.png<span class="w"> </span><span class="m">600</span><span class="w"> </span>--config<span class="w"> </span>conf/conf.json<span class="w"> </span>ridge<span class="w"> </span>--stl<span class="w"> </span>m<span class="w"> </span><span class="m">0</span>.2<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="m">0</span>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python3<span class="w"> </span>src/main.py<span class="w"> </span>res/examples/Palec_P4.tif<span class="w"> </span>res/examples/Palec_P4.png<span class="w"> </span><span class="m">600</span><span class="w"> </span>--config<span class="w"> </span>conf/conf.json<span class="w"> </span>new_ridge<span class="w"> </span>--stl<span class="w"> </span>m<span class="w"> </span><span class="m">0</span>.2<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="m">0</span><span class="w"> </span>res/finger_backup/finger.stl
</pre></div>
</div>
</section>

2
docs/build/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

2
docs/build/usage.html vendored
View File

@ -215,7 +215,7 @@
<span class="go">output_file dpi ([-c | --config config_file preset] |</span>
<span class="go">[filters ...]) [-s | --stl_file p height_line height_base |</span>
<span class="go">--stl_file c height_line height_base curv_rate_x curv_rate_y |</span>
<span class="go">--stl m height_line iter finger_x finger_y finger_z]</span>
<span class="go">--stl m height_line iter finger_x finger_y finger_z finger_model]</span>
<span class="go">[-d | --database database_filename]</span>
<span class="go">Program for processing a 2D image into 3D fingerprint.</span>

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