Version 24 (modified by Suryajith Chillara, 10 years ago) ( diff )

added a few more lines refined it

Blueprint for Optical Character Recognition


GSoC 2010 project produced a separate package based on Python & usable via CLI


This needs to be integrated into Eden so that there is a PDF icon on create forms which opens the PDF representation for the create form, e.g.:

The classes should be moved to a new file: modules/ should be moved to: static/scripts/tools

The functionality should be accessible from models/'s shn_create()

The Installation Documentation needs to be updated with dependencies:

  1. Core xml libs like xml.dom.minidom and xml.sax (can also use lxml, which is already in the dependency list)
  2. sane on unix and twain on Windows to support scanning
  3. pyscanning (
  4. Imaging-sane ( on Unix , not necessary on windows )
  5. urllib, urllib2, Reportlab, PIL >= 1.6

Installation Scripts/Binaries need to be updated with these dependencies.

Write up UserGuidelines

There is discussion on how to provide UI for Assisted OCR here:


Be able to scan in a paper-based form to populate the database

This would be useful if Sahana is being used to generate forms which are printed, and filled out by hand, then can be scanned back, directly, into the database.
It may be impractical to get people to fill out forms in handwriting which can be "recognized".

  • Being able to identify check-boxes being checked - and design forms which rely heavily on check boxes.
  • Being able to copy blocks of test out of a hand written form, and display it on screen, next to an editable text box, where the text can be "recognized" and entered manually.

Use Case

Quote from Pakistan Floods Responders:

  • One more basic problem was poor internet connections, plus forms in English. so one group decided to print and then fill and feed the forms.


The C++ code written for SahanaPHP (during GSoC 2007) could almost-certainly be tweaked to work with Sahana Eden:

This version uses OpenCV & FANN

A Firefox add-on to enable a nice workflow for users was developed for SahanaPHP as part of GSoC 2009:

This will access the Scanner (e.g. using TWAIN or SANE) and read the Image. The acquired image will be passed to the OCR library & the result will be posted into the web form.
Again, this should be easy to tweak to get working with Eden.

Possibility of using pytesser with cross platform tesseract-ocr

Plone uses Tesseract:

Google now include an OCR option in Docs (although quality isn't great yet):

Notes from Main-dev List

Why not just use data which is currently entered in the database for the keywords? (eg, location tables, organization tables, etc)

Regarding checkboxes – if could be possible to design a survey which only requires checkboxes, maybe fields for dates. Scales of 1-10 could be converted into checkboxes.

I like your idea for reviewing the text – I think even if the OCR isn’t too accurate, having the text from the paper displayed on screen next to the data entry box would make it easier to input the data. In some cases, it may not be important to convert the image of the writing into text, as long as the image is saved in the DB (eg, additional notes in a survey)

Also – can you “tell” the OCR whether it should be looking for letters or numbers? It should be quite easy to determine which fields should have letters in them and which should have numbers.

Regarding Barcodes:
They’re easy to make, simply get a font from: and display an appropriate number in that font.
I’m not convinced that each field needs a barcode, but definitely each page. Also you may want to give each form a UID (in the barcode and human readable, particularly if the forms are printed over multiple pages – that way if the pages get mixed up, they can easily be sorted out.

Check Boxes

Check boxes could be used in a number of different ways:


Living in a temporary shelter: □

Option List

Current Residence:
Own House: □   Renting: □   Temporary Shelter: □   Government Camp: □   Barracks: □


Severity of Damage (1-lowest 5-highest):
1: □   2: □   3: □   4: □   5: □
1  2  3  4  5
□  □  □  □  □ 


Days in current location:
0-3: □   4-10: □   10-30: □   31+: □

Step 1: Form Generation

A couple of ways to go about it:

  1. Generate the XML files from the user defined data requirements and then use XSL-FO (eXtensible Stylesheet Language - Formatting Object) to work with the XML documents to tailor the document appearance for printing. A XSL-FO processor, Apache FOP has to be used to generate PDFs out of it. Well this does not give enough flexibility to print all the information we need. Thus we ruled it out.
  1. The required data be exported into reST format from the XML files generated by the SahanaPy framework and the package rst2pdf could be used to generate pdfs. rst2pdf uses reportlab which enables us not only to logicaly format the data to be printed but also helps us keep the co-ordinates of the printed data with reference to the bottom left point taken as origin. This proved to be very roundabout way.
  1. The way the GSoC 2010 participant has approached this problem is to parse the XML file down the tree and using reportlab to generate the pdf file. So a parser has been implemented and th

It is ideal if each of the documents be provided with a header (for example: 3 opaque square blocks two on either ends and one in the middle) to help align the form during the recognition process.

To minimize the task of recognizing the handwriting, most of the general data (like gender, location etc.) can be printed in the forms with corresponding checkboxes. The rest of the data like name and age has to be handwritten for which providing checkboxes isnt practical has to be recognized.

Each custom form generated can be given an unique ID either by just printing the unique ID logically in the form of a bar codes.

The forms could be generated using the which is located in the scripts folder using the syntax as mentioned below. Incase the pdfname is not mentioned, it uses the <uuid>.pdf format to save the files. The default storage location is the ocrforms folder in the main directory structure if the path is not mentioned.

Usage: python <xforminput> <OPTIONAL -> pdfoutput>

Step 2: OCR

The most successful software for OCR is tesseract which is cross platform compatible. NOTE: The uploaded images so as to be recognized have to be supplied to tesseract, have to be in .tiff format.

  1. The image which has been scanned into .tiff format has to be checked for any skewness using the relative position of the three squares on the top and thus set the frame of reference for the image. (using python imaging library)
  2. There are two ways of reading the data. (using tesseract)
    1. The spatial information from the step1 which has been used to format the content using reportlab can be used to identify the contents of each block of data individually treating it as a seperate letter.(This can be done by segmenting each block out of the image and read it). This gives us more accuracy.
    2. The data from the image could be directly read and parsed later. The problems with this way of reading could be that a single letter could be misinterpretated as a combination of letters etc. Segmenting into smaller images and then reading it would be much more time consuming but accurate where as the other is less accurate and extremely fast.
  3. Each of the checkboxes which correspond to the relevant data shall be marked with 'X' which could be read as character 'x'.
  4. The read data should be parsed and be written accordingly into an xml file for other applications to use in case of need. ( Also the segmented images can be stored until manual data verification)

NOTE: The accuracy of the OCR engine depends on the training data which makes it critical.

Step3: Implementation of a training module

A sub-module for the automated training of the handwriting for the end users. The data for training shall be imported as the tiff images.

  1. The User shall be provided a form with the boxes in it to fill to replicate the characters in his/her handwriting according to a set of data generated by the module.
  1. The automated matching of this data is done with the box file generated from image rather than human involvement .
  1. Then the tesseract can be run in the training format and then clustering using different training images is done. (for the shape prototypes, the number of expected features for each character and the character normalization sensitivity prototypes).
  1. Tesseract needs to know the set of possible characters it can output. To generate the unicharset data file, use the unicharset_extractor program on the same training pages bounding box files as used for clustering.


GSoC 2010 code layout

config <- Global config file

images: <- A possible storage area for the images

layoutfiles: <- Default storage area for the layout info of the forms generated
ocrforms: <- Default storage area for the xml forms

parseddata: <- Stores the parsed data

README <- Explains the howto

        | <- A class to parse the images and dump the data 
        | <- A class to handle the xforms and print them to pdf
        | <- A module with all the necessary functions for this entire ocr module
        | <- A script to parse the forms
        | <- A class to handle the reportlab api to print forms
        | <- A Class which describes a region in an image
        | <- A script to upload the files
        | <- A module which augments urllib2's functionality to upload files
        | <- Converts xforms to pdfs and uses the classes from formhandler and printform

tessdata: <- A folder where the necessary training info is stored to parse the scanned forms

        | <- Generates the training form
        | <- Trains the engine and stores the training data in the tessdata folder
        |-datafiles: <- Contains the input to generate training form and also the training form layout info files
        |-printedpdfs: <- Printed trainging forms reside here 

Training Data


Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.