Updated README.md.
This commit is contained in:
51
README.md
51
README.md
@ -4,7 +4,7 @@
|
||||
This project is being developed as a practical part of bachelor's thesis at Brno Universtiy of Technology - Faculty of Information Studies. It is as of now a work in progress, no results guaranteed.
|
||||
|
||||
The topic of this thesis is Generating a 3D Fingerprint Model. This application can be used to apply series of image processing filters to a fingerprint image to make it more suitable for conversion to 3D stl model and printing.
|
||||
It should also have the functionality to convert the image to stl model.
|
||||
It should also have the functionality to convert the image to stl lithophane and map it to a 3d finger model.
|
||||
|
||||
|
||||
# Prerequisites
|
||||
@ -13,15 +13,17 @@ For now this is only viable for ubuntu gnu/linux machines
|
||||
Before cloning repository, you need these to succesfully use the application.
|
||||
|
||||
* python version 3.10 is a requirement might work on earlier python 3 versions
|
||||
|
||||
```sh
|
||||
apt install python3.10
|
||||
```
|
||||
|
||||
* python graphical modules
|
||||
|
||||
```sh
|
||||
pip install numpy matplotlib pillow
|
||||
```
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
Installation is relatively fast and easy.
|
||||
@ -30,25 +32,42 @@ Installation is relatively fast and easy.
|
||||
```sh
|
||||
git clone ssh://git@strade.fit.vutbr.cz:3022/xlanro00/BP_DP-xlanro00.git
|
||||
```
|
||||
2. Prepare the image file with fingerprint, run the application
|
||||
|
||||
2. Prepare an image file containing fingerprint
|
||||
|
||||
3. Run the application
|
||||
|
||||
|
||||
# Usage
|
||||
|
||||
There are two ways to enter filter series
|
||||
|
||||
* manually from command line
|
||||
* manually from command line, list filter names and parameters will be added later
|
||||
```sh
|
||||
python src/main.py res/test_fp.png res/test_fp_cpy.png 100 blur
|
||||
python src/main.py res/test_fp.png res/test_fp_cpy.png 100 gaussian erode dilate sharpen
|
||||
```
|
||||
* manually from preset saved in a json config file, that can be used to create new presets
|
||||
* 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_preset
|
||||
python src/main.py res/test_fp.png res/test_fp_cpy.png 100 --config config/config.json default
|
||||
```
|
||||
|
||||
# Configuration
|
||||
|
||||
There is an option to input the filter series as a preset to json configuration file.
|
||||
|
||||
```diff
|
||||
{
|
||||
"preset_name": [
|
||||
"filter_1",
|
||||
"filter_2",
|
||||
"filter_3"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
# Comparison
|
||||
|
||||
Image before processing the fingerprint and after it.
|
||||
Image before processing the fingerprint and after applying a presets.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
@ -61,19 +80,23 @@ Image before processing the fingerprint and after it.
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
# Generated STL model
|
||||
# Generated STL lithophane
|
||||
|
||||
TODO
|
||||
This section will be added later. It will describe the process of converting the fingerprint image data to 3D stl lithophane.
|
||||
|
||||
# Roadmap
|
||||
|
||||
- [x] Load and store image
|
||||
- [x] Apply basic image processing filters
|
||||
- [ ] Create filter library with more filters
|
||||
- [ ] Scale the image using given dpi
|
||||
- [X] Create filter library with more filters
|
||||
- [ ] Add more suitable filters to the library
|
||||
- [x] Use presets from config files
|
||||
- [ ] Make it a viable option to process an image
|
||||
- [ ] Convert image to stl format
|
||||
- [ ] Export final model ready for printing
|
||||
- [ ] Add the option to save current filter presetto config file
|
||||
- [ ] Add the option to modify filter parameters
|
||||
- [ ] Convert the processed image to stl lithophane
|
||||
- [ ] Add the option to map the lithophane on a finger model
|
||||
- [ ] Export final model ready for 3D print
|
||||
|
||||
#
|
||||
### Author
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 155 KiB |
Reference in New Issue
Block a user