Skip to content

Update README.md #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hasanzadegan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 4 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,9 @@
# mrz-detection

## Run scripts

The best way to test the run scripts is to create a `data` directory in the root of this repo and put
the images in sub-directories of `data`.

### getMrz

`node run/getMrz.js --dir data/imageDir`

This script will treat all PNG or JPEG images in the specified `dir` and create an `out` sub-directory
containing the images at each step of the process.
The purpose of this script is to locate the MRZ and crop/rotate the image to keep only this part.

Final images will be in `data/imageDir/out/cropped`

### readMrz
1. config tesseract and copy mrz.traineddata in tesseract path tessdata folder
2. node run/mrzApi.js
3. see userinterface in http://localhost:3000
4. modify run/public/index.html as you want

`node run/readMrz.js --dir data/imageDir/out/cropped --reference data/imageDir/ground.csv`

This script will attempt to read the MRZ of all images in the specified `dir` and compare the read
data with the `reference`.

The reference should be a CSV file with the following format:

image-name,MRZ-LINE-1,MRZ-LINE-2,MRZ-LINE-3

* image-name is the filename of the original image without extension
* MRZ-LINE-x are each line of the MRZ (two or three lines)

## License

Expand Down