You are here: start » ocr_userguidelines

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
ocr_userguidelines [2010/08/19 12:04]
suryajith created 		ocr_userguidelines [2010/12/18 17:35] (current)
Line 1: Line 1:
-**User guidelines for the OCR project for Sahana-Eden** 
  
-__**Usage**__+**File structure of the ocr folder:**
  
-__Dependencies__+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 
 + 
 + 
 +sahanahcr: 
 +        |-dataHandler.py <- A class to parse the images and dump the data  
 +        |-formHandler.py <- A class to handle the xforms and print them to pdf 
 +        |-functions.py <- A module with all the necessary functions for this entire ocr module 
 +        |-parseform.py <- A script to parse the forms 
 +        |-printForm.py <- A class to handle the reportlab api to print forms 
 +        |-regions.py <- A Class which describes a region in an image 
 +        |-upload.py <- A script to upload the files 
 +        |-urllib2_file.py <- A module which augments urllib2's functionality to upload files 
 +        |-xforms2pdf.py <- 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 
 +        |-configs  
 +        |-tessconfigs  
 + 
 +training: 
 +        |-generatetrainingform.py <- Generates the training form 
 +        |-train.py <- 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  
 + 
 + 
 +xmlInput: 
 +------------ 
 + 
 + 
 + 
 + 
 +**Dependencies** 
 +------------
   - Reportlab   - Reportlab
-  - core xml libs like xml.dom.minidom and xml.sax+  - Core xml libs like xml.dom.minidom and xml.sax
   - sane on unix and twain on Windows to support scanning   - sane on unix and twain on Windows to support scanning
   - pyscanning (http://code.google.com/p/pyscanning/)   - pyscanning (http://code.google.com/p/pyscanning/)
Line 13: Line 55:
   - PIL >= 1.6   - PIL >= 1.6
  
-__Step 1: The form generation__+NOTE 1: All scripts have to be run from their respective directories at the moment.
  
-The forms could be generated using the xforms2pdf.py using the syntax as mentioned below. Incase the pdfname is not mentioned, it uses the <uuid>.pdf format to save the files. The location for the storage of the pdfs is asked in case the path is not given but just the filename where as the default place for storage is the ocrforms folder in the main directory structure. +NOTE 2: All the images used are to be provided in the .tif format. 
 + 
 + 
 +**USAGE** 
 + 
 + 
 +__Setting up the config file :__ 
 + 
 +[url] 
 + 
 +url = http://suryajith.in:5000/ 
 + 
 +The url to which data could be uploaded to 
 + 
 +[tessdata] 
 + 
 +tessdata = ../ 
 + 
 +The folder from the sahanahcr folder where the tessdata folder is located 
 + 
 +------------ 
 + 
 +__Step 1: The form generation__ 
 +The forms could be generated using the xforms2pdf.py using the syntax as mentioned below. Incase the pdfname is not mentioned, it uses the uuid.pdf format to save the files. They are stored in the OCRforms folder in the main directory structure.
  
     Usage: python xforms2pdf.py <xforminput> <OPTIONAL -> pdfoutput>     Usage: python xforms2pdf.py <xforminput> <OPTIONAL -> pdfoutput>
  
 __Step 2: Automated training__ __Step 2: Automated training__
- +Generation of the training forms. Uses the datainput.txt located in the "Training" folder which contains the necessary characters that are needed in the Training folder to generate the form and prints out the location details of the characters in a file, this goes into the 'Training' folder too but with the name "Trainingform.pdf" and a layout file with the name "Traininglayoutinfo". The training form file is used for the automated boxfile generation
-Generation of the training forms. Uses the datainput.txt located in the datafiles folder of the "Training" folder which contains the necessary characters that are needed in the Training folder to generate the form and prints out the location details of the characters in a file, this goes into the 'Training' folder too but with the name "Trainingform.pdf" and a layout file with the name "Traininglayoutinfo" which is stored in the datafiles folder. The training form layout info file is used for the automated boxfile generation+
  
     Usage: python generateTrainingform.py     Usage: python generateTrainingform.py
  
-The automation of the tesseract stores the necessary files in the tessdata folder with a <user> mentioned as prefix (which is generally the language) so that the while parsing the forms, when <user> is mentioned the specific trained data is used.+The automation of the tesseract stores the necessary files in the tessdata folder with a <user> mentioned as prefix (which is generally the language) so that the while parsing the forms, when <user> is mentioned the specific trained data is used. They are stored as user_alph.* for the alphabet training and user_num.* for the numeral training 
 + 
 +    Usage: python train.py <trainingimage> <layout info of the form which is generally training form> <user>
  
-    Usage: python train.py <trainingimage> <layout info of the form> <user> 
  
 __Step 3: Scan the Image or Add the Image__ __Step 3: Scan the Image or Add the Image__
- +The Images could either be added to the folder images as described in the files structure (or be scanned directly) and the parsing of the images takes place with accordance to the the layout files located in the layout folder. The layout is chosen as per the uuid mentioned on the form as the layout file is stored in the form uuid_page.xml so everytime a page is scanned, the page number has to be specified too. <user> mentioned is the user whose training data has to be used. 
-The Images could either be added to the folder images as described in the files structure (or be scanned directly) and the parsing of the images takes place with accordance to the the layout files located in the layout folder. The layout is chosen as per the uuid mentioned on the form as the layout file is stored in the form <uuid>_<page>.xml so everytime a page is scanned, the page number has to be specified too.+
  
     Usage: python parseform.py <imageinput> <uuid of the form> <pagenumber> <user>     Usage: python parseform.py <imageinput> <uuid of the form> <pagenumber> <user>
 +
 +The parsed data is stored in the form of an xml in the folder parseddata in the global file structure. It is stored in the <uuid> folder in the parseddata folder. The images of the text are also cut out and stored. The images and text are also uploaded to a web folder via the url mentioned in the config file.
 +
 +
 +
 +
 +
 +TODO
 +
 +  - Implement option parser instead of the regular files
 +  - Someway to deal with the files with multiple pages, a way to store the data instead of the present way of storing data in two different xmls
 +  - Do windows specific improvements and tests
 +  - Barcodes on each page
 +  - Make generateTrainingform.py generic for all languages
 +  - Improve the xforms parsing to use all the attributes of bind
 +  - Check the improvement due to parsing digits and alphabets independently
 +  - Try to check if individual character reading improves the accuracy rather than reading the entire string
 +  - Should check if multiple fields have been selected for a select1 element
 + 
 +LIMITATIONS
 +============
 +  * Just works with capital letters and digits now.
 +  * Cant really use the restricted attribute of bind in xforms for example, a question like are you pregnant is valid only for females and should be improve  to use it and other attributes of bind.
 +  * Not accurate parsing.
 +  * Selects the field related to the first darkened bubble for a select1 element.
 +
  

Trace:

QR Code
QR Code ocr_userguidelines (generated for current page)