Commit fa111d31 authored by Yvan Masson's avatar Yvan Masson

Many new things and fixes!

Sorry, I do not remember everything that changed since last commit,
but it fixes important issues, it adds new sheet formats, 3/4 face
cropping, it improves documentation and adds examples.
parent eb63970c
No preview for this file type
......@@ -2,15 +2,42 @@ trombilinux
===========
Trombilinux aims at creating simple face books / trombinoscope: a sheet
containing faces and corresponding names.
containing faces and corresponding names, typically used in schools.
Main features:
Features:
- Source pictures can be automatically cropped using face detection.
- Source pictures can be automatically cropped around face (square or 3/4
format) using face detection.
- Names can be gathered from picture names or from a CSV file.
- Faces can be sorted by picture name or by sorting the CSV.
- Multiple formats available (A4 and A3 portrait or landscape, 4x5, 5x6…)
- Generates multipage PDF if needed
- Multiple formats and DPI are available (A4 and A3 portrait or landscape, 4x5,
5x6…), and other can be easily added.
- Generates multipage PDF (or any formats supported by ImageMagick) if needed
- When using a CSV file, a missing picture is replaced by a default image.
Examples
========
- `Example.pdf` was created by running
`trombilinux example/ -t "Famous people" -o Example.pdf`
- `Example_with_csv.pdf` was created by running
`trombilinux example/ -n example_names.csv -o "Example_with_csv.pdf"`
- `Example_cropped_3-4.pdf` was created by runing
`trombilinux example/ --crop -t "Famous people" -o "Example_cropped_3-4.pdf"`,
manual selection of faces that were wrongly detected (see [Issues](#issues)),
and a second run with
`trombilinux example/cropped/ -t "Famous people" -o "Example_cropped_3-4.pdf"`
- `Example_cropped_square_4x5_300dpi.pdf` was created by running
`trombilinux example/ --crop -t "Famous people" -f "a4,portrait,4x5,square,300dpi" -o "Example_cropped_square_4x5_300dpi.pdf"`,
manual selection of faces that were wrongly detected (again see
[Issues](#issues)), and a second run with
`trombilinux example/cropped/ -t "Famous people" -f "a4,portrait,4x5,square,300dpi" -o "Example_cropped_square_4x5_300dpi.pdf"`
Usage
=====
Please run `trombilinux --help`.
Dependencies
......@@ -42,26 +69,30 @@ Issues
You can consider this program as a proof of concept, as it has many issues:
- Face detection works better if the face is in front of the camera and if the
person is over a blank background. Even with good pictures, the program often
detects more than one face, or fails to detect one. In such a case:
- manually crop these failing pictures
- put them in the "cropped" subdirectory created on first run
- re-run the program without face detection using pictures from the
"cropped" directory
- I am asolutely not a developper, so there are probably many many bugs. Notably,
there is almost no error handling if you provide bad parameters.
person is over a blank background. Even with good pictures, the program often
detects more than one face, or fails to detect one:
- If it does not detect any face, manually crop the picture and put it in the
"cropped" directory created on first run.
- If it detects more than one face but uses the wrong one, simply rename the
picture in the "cropped" subdirectory.
- Then, re-run the program without face detection and using pictures directly
from the "cropped" directory.
- I am not a developper, so there are probably many bugs. Notably, there is
almost no error handling if you provide bad parameters.
For contributors
================
If you want to check output PDF resolution, you can use `pdfimages` command
with `-list` option (from poppler-utils package on Debian).
If you want to check output PDF resolution (for example to define new sheet
formats), you can use `pdfimages` command with `-list` option (from the
poppler-utils package on Debian).
Credits
=======
default_face.jpg is a modified version of the picture found on
`default_face_3-4.jpg` and `default_face_square.jpg` are modified versions of
the picture found on
http://maxpixel.freegreatpicture.com/Avatar-Grey-Account-User-Person-Operating-System-1699635,
and thus is also distributed under Creative Commons Zero - CC0 licence.
and thus are also distributed under Creative Commons Zero - CC0 licence.
surname1,name1
surname2,name2,NOPIC
surname3,name3
surname4,name4
surname5,name5
surname6,name6
surname7,name7
surname8,name8
surname9,name9
surname10,name10
surname11,name11
surname12,name12
surname13,name13
surname14,name14
surname15,name15
surname16,name16
surname17,name17
surname18,name18
surname19,name19
surname20,name20
surname21,name21
surname22,name22
surname23,name23
surname24,name24
surname25,name25
surname26,name26
surname27,name27
surname28,name28
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment