plugins/ocr/README.KADMOS

0001 Kooka and KADMOS integration
0002 ============================
0003
0004 KAMDOS is a commercial OCR/ICR software library produced by the
0005 company reRecognition of Kreuzlingen, Switzerland (www.rerecognition.com).
0006 It is reputed to produce extremely good OCR results, from both printed
0007 and hand written texts.
0008
0009 KADMOS support was originally integrated into Kooka by Klaas Freitag
0010 in the KDE3 version.  In the port to KDE4 and later to KF5, the KADMOS
0011 support was converted as far as possible but left untested, since
0012 neither myself nor anyone else involved in the porting had access to
0013 any KADMOS SDK or development system.
0014
0015 For the same reason, since the reorganisation of the source to
0016 implement OCR as plugins, the KADMOS support has not been ported.  It
0017 currently resides in the plugins/ocr/kadmos source directory, but it
0018 would require access to a KADMOS SDK to be able to port to the new OCR
0019 plugin API.  If there is someone who has access to KADMOS and is
0020 willing to do the (not extensive) OCR plugin porting, then Kooka
0021 will be able to support KADMOS again.
0022
0023 -- Jonathan Marten <jjm@keelhaul.me.uk>
0024
0025 The remainder of this document is the original description for
0026 building and using Kooka with the KADMOS engine, dating from 2003
0027 (with minor corrections).
0028
0029 -----------------------------------------------------------------------
0030
0031 This file describes how to make Kooka working with the KADMOS OCR/ICR
0032 engine.
0033
0034 KADMOS is commercial OCR/ICR software component of the company
0035
0036  reRecognition GmbH
0037  Hafenstr. 50B
0038  8280 Kreuzlingen
0039  Switzerland
0040  Tel.: +41 71 6780000
0041  Fax: +41 71 6780099
0042  www.reRecognition.com
0043
0044 and Kooka can be built using the Linux version of the component in
0045 order to achieve very good OCR results.
0046
0047 Please contact re Recognition directly if you like to obtain or test
0048 KADMOS. Note that if you are linking against KADMOS, you lose the
0049 permission to use the GPL Qt version, so you need a commercial Qt
0050 version as well.
0051
0052 Configuration
0053 -------------
0054
0055 As Kooka does not require KADMOS, it is necessary to configure
0056 Kooka to use the KADMOS library. This could be done by calling the
0057 configure script of Kooka's source distribution with following
0058 parameter:
0059
0060 ./configure --with-kadmos-dir=/where/kadmos.h/resides/
0061
0062 The configure script tries to locate the file kadmos.h in the
0063 directory that was specified. The KADMOS library is expected in the
0064 same directory.  Build the source after configuring with KADMOS. Kooka
0065 enables the code to work with KADMOS in the source and links the
0066 library.
0067
0068 Installation
0069 ------------
0070
0071 KADMOS is linked statically and thus there is no need for special
0072 installation of the KADMOS library.
0073
0074 Installation of the Classifier Files:
0075
0076 KADMOS needs classifier files for the ocr process which come with
0077 the KADMOS developer's toolkit. The classifier files need to be installed
0078 in the KDE application data directory for Kooka in a subdirectory named
0079 classifiers. If your KDE installation goes to /opt/kde/, this is for
0080 example /opt/kde/share/apps/kooka/classifiers. Kooka picks the
0081 available classifiers up automatically.
0082
0083 The classifiers are named in the following way:
0084
0085 [fontkind][country/region].rec,
0086 where fontkinds are
0087 ttf  -> machine print font
0088 hand -> handprint (isolated)
0089 norm -> OCR norm font
0090
0091 For example the following classifier names are used:
0092
0093 ttfus.rec      US machineprint classifiers
0094 handus.rec     US handwriting classifiers
0095 norm.rec       Special OCR character sets, not localized
0096
0097 ----------------------------------------------------------------------
0098 Klaas Freitag <freitag@suse.de>
0099 $Id$