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

Updated README and user manual.

Browse Source
master
Rostislav Lán 2 years ago
parent fe20f7a39a
commit a1b81722c4
3 changed files with 51 additions and 22 deletions
Show Stats Download Patch File Download Diff File

14
README.md
Unescape View File

@ -274,16 +274,24 @@ Optional parameters are height of the papilar lines and base thickness.
# Mapping to existing finger model
This section will be added later, (if implemented) mapping of fingerprint to a given 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.
* General command form for mapped stl generation
```sh
python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line height_base finger_file
python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line iter finger_x finger_y finger_z
```
* Working example of finger mapping
```sh
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
```
# Usage
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_file m height_line height_base finger_file]
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] [-d | --database database_filename]
Program for processing a 2D image into 3D fingerprint.

13
doc/manual/manual.html
Unescape View File

@ -219,10 +219,12 @@ Woking example
<pre><code>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</code></pre></li>
</ul>
<h2 id="mapping-to-existing-finger-model">Mapping to existing finger model</h2>
<p>This section will be added later, (if implemented) mapping of fingerprint to a given finger model.</p>
<p>Using <code>m</code> mode modifies the preexisting finger model to contain fingerprint. First optional parameter is papilar line height <code>height_line</code>, second is the number of iterations <code>iter</code> 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, <code>finger_x</code>, <code>finger_y</code>, <code>finger_z</code>. 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>
<ul>
<li><p>General command form for mapped stl generation:</p>
<pre><code>python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line height_base finger_file</code></pre></li>
<li><p>General command form for mapped stl generation</p>
<pre><code>python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line iter finger_x finger_y finger_z</code></pre></li>
<li><p>Working example of finger mapping</p>
<pre><code>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</code></pre></li>
</ul>
<h1 id="usage">Usage</h1>
<p>When in doubt, you can always check the help with:</p>
@ -231,8 +233,9 @@ Woking example
<pre><code>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_file m height_line height_base finger_file]
--stl_file c height_line height_base curv_rate_x curv_rate_y |
--stl m height_line iter finger_x finger_y finger_z]
[-d | --database database_filename]
Program for processing a 2D image into 3D fingerprint.

46
doc/manual/manual.md
Unescape View File

@ -311,12 +311,21 @@ Optional parameters are height of the papilar lines and base thickness.
## Mapping to existing finger model
This section will be added later, (if implemented) mapping of fingerprint to a given 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.
* General command form for mapped stl generation:
* General command form for mapped stl generation
```
python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line height_base finger_file
python3 src/main.py input_file output_file dpi --config config_file preset --stl m height_line iter finger_x finger_y finger_z
```
* Working example of finger mapping
```
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
```
# Usage
@ -331,8 +340,9 @@ 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_file m height_line height_base finger_file]
--stl_file c height_line height_base curv_rate_x curv_rate_y |
--stl m height_line iter finger_x finger_y finger_z]
[-d | --database database_filename]
Program for processing a 2D image into 3D fingerprint.
@ -366,7 +376,7 @@ options:
</thead>
<tbody>
<tr>
<td>
<td>
main.py: error: the following arguments are required: input_file, output_file, dpi, filters
</td>
<td>
@ -374,7 +384,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Input file res/Palec_P14.tif does not exist
</td>
<td>
@ -382,7 +392,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Config file not found
</td>
<td>
@ -390,7 +400,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Preset not found in config file
</td>
<td>
@ -398,7 +408,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Filter undefined_filter not found
</td>
<td>
@ -406,7 +416,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Unrecognized generation mode
</td>
<td>
@ -414,7 +424,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Line depth must be less than plate thickness
</td>
<td>
@ -422,7 +432,7 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Depth of plate height must be positive
</td>
<td>
@ -430,12 +440,20 @@ options:
</td>
</tr>
<tr>
<td>
<td>
ERROR: Base and line height must both be positive
</td>
<td>
In curved generation any negative argument is an error, casts are only for planar mode.
</td>
</tr>
<tr>
<td>
ERROR: Fingerprint image is outside of the finger model
</td>
<td>
Outside of range of the finger, fingerprint cannot be mapped to nothing. Try to change finger_x, finger_y and finger_z parameters.
</td>
</tr>
</tbody>
</table>
Write Preview
Loading…
Cancel
Save