Difference between revisions of "Third-party software integration: OCR"

From OpenKM Documentation
Jump to: navigation, search
m
Line 1: Line 1:
Starting with OpenKM 5.1 you can choose between several OCR engines:
+
Starting with OpenKM 5.1.9 you can choose between several OCR engines:
  
  
Line 5: Line 5:
 
! OCR Engine || Text Extractor || Image Formats || Program arguments
 
! OCR Engine || Text Extractor || Image Formats || Program arguments
 
|-
 
|-
| [[Tesseract|Tesseract 2.x]] || com.openkm.extractor.Tesseract2TextExtractor || TIFF || Config.SYSTEM_OCR ${fileIn} ${fileOut}
+
| [[Tesseract|Tesseract 2.x]] || com.openkm.extractor.Tesseract2TextExtractor || TIFF || /path/to/tesseract ${fileIn} ${fileOut}
 
|-
 
|-
| [[Tesseract|Tesseract 3.x]] || com.openkm.extractor.Tesseract3TextExtractor || TIFF PNG JPG GIF || Config.SYSTEM_OCR ${fileIn} ${fileOut}
+
| [[Tesseract|Tesseract 3.x]] || com.openkm.extractor.Tesseract3TextExtractor || TIFF PNG JPG GIF || /path/to/tesseract ${fileIn} ${fileOut}
 
|-
 
|-
| [[Cuneiform]] || com.openkm.extractor.CuneiformTextExtractor || TIFF PNG JPG GIF || Config.SYSTEM_OCR ${fileIn} -o ${fileOut}
+
| [[Cuneiform]] || com.openkm.extractor.CuneiformTextExtractor || TIFF PNG JPG GIF || /path/to/cuneiform ${fileIn} -o ${fileOut}
 
|-
 
|-
| Abby || com.openkm.extractor.AbbyTextExtractor || TIFF PNG JPG GIF || Config.SYSTEM_OCR ${fileIn} -o ${fileOut}
+
| Abby || com.openkm.extractor.AbbyTextExtractor || TIFF PNG JPG GIF || /path/to/abby ${fileIn} -o ${fileOut}
 
|-
 
|-
 
|}
 
|}
  
  
{{Note|Starting from OpenKM 5.1.8 Cuneiform configuration has changed and the parameters are, set in '''system.ocr''' configuration. Should be set to "/usr/bin/cuneiform ${fileIn} -o ${fileOut}". See [[Migration from 5.1.7 to 5.1.8]] for more info.}}
+
{{Note|Starting from OpenKM 5.1.8 Cuneiform configuration was changed and the parameters are, set in '''system.ocr''' configuration. Should be set to "/usr/bin/cuneiform ${fileIn} -o ${fileOut}". See [[Migration from 5.1.7 to 5.1.8]] for more info. In older OpenKM releases the right configuration was "/usr/bin/cuneiform".}}
  
{{Note|Starting from OpenKM 5.1.9 Tesseract configuration has changed and the parameters are, set in '''system.ocr''' configuration. Should be set to "/usr/bin/tesseract ${fileIn} ${fileOut}". See [[Migration from 5.1.8 to 5.1.9]] for more info.}}
+
{{Note|Starting from OpenKM 5.1.9 Tesseract configuration has changed and the parameters are, set in '''system.ocr''' configuration. Should be set to "/usr/bin/tesseract ${fileIn} ${fileOut}". See [[Migration from 5.1.8 to 5.1.9]] for more info. In older OpenKM releases the right configuration was "/usr/bin/tesseract".}}
  
 
So, if you want to pass a command line parameter to your tesseract executable, you should use this configuration:
 
So, if you want to pass a command line parameter to your tesseract executable, you should use this configuration:

Revision as of 09:50, 31 March 2012

Starting with OpenKM 5.1.9 you can choose between several OCR engines:


OCR Engine Text Extractor Image Formats Program arguments
Tesseract 2.x com.openkm.extractor.Tesseract2TextExtractor TIFF /path/to/tesseract ${fileIn} ${fileOut}
Tesseract 3.x com.openkm.extractor.Tesseract3TextExtractor TIFF PNG JPG GIF /path/to/tesseract ${fileIn} ${fileOut}
Cuneiform com.openkm.extractor.CuneiformTextExtractor TIFF PNG JPG GIF /path/to/cuneiform ${fileIn} -o ${fileOut}
Abby com.openkm.extractor.AbbyTextExtractor TIFF PNG JPG GIF /path/to/abby ${fileIn} -o ${fileOut}



Nota clasica.png Starting from OpenKM 5.1.8 Cuneiform configuration was changed and the parameters are, set in system.ocr configuration. Should be set to "/usr/bin/cuneiform ${fileIn} -o ${fileOut}". See Migration from 5.1.7 to 5.1.8 for more info. In older OpenKM releases the right configuration was "/usr/bin/cuneiform".


Nota clasica.png Starting from OpenKM 5.1.9 Tesseract configuration has changed and the parameters are, set in system.ocr configuration. Should be set to "/usr/bin/tesseract ${fileIn} ${fileOut}". See Migration from 5.1.8 to 5.1.9 for more info. In older OpenKM releases the right configuration was "/usr/bin/tesseract".

So, if you want to pass a command line parameter to your tesseract executable, you should use this configuration:

system.ocr=/usr/bin/tesseract -l esp

In this OpenKM version you can also use an OpenOffice.org dictionary to enhance the OCR process. You can find these language specific dictionaries at OpenOffice.org Dictionary Repository. After download, set this configuration property with the path to the dictorionay file:

system.openoffice.dictionary=/path/to/dictionary.(oxt|zip)

Software required

You can enable any of these text extractors adding it in the textFilterClasses param of the SearchIndex section in your repository.xml file.

Starting with OpenKM 5.1 we offer integration with Cognitive OpenOCR (Cuneiform). This OCR engine make a very good job improving Tesseract conversion ratios.