TrueViz Version 1.02 TrueViz (ground TRUth/metadata Editing & VIsualiZing Toolkit) is a tool for visualizing and editing groundtruth and metadata for OCR. TrueViz is developed in Java programming language which is executable in various platforms. TrueViz reads/stores groundtruth and meta data in XML format, and reads a corresponding image stored in tif image file format. ======== CONTENTS ======== README This file. INSTALL The installation guide. Makefile Makefile to compile the source codes. bin/ TrueViz binary files. src/ TrueViz source files. software/ Software packages needed to run TrueViz. font/ Unicode fonts and configuration files. dafs/ DAFS library for compilation of tools. tools/ Converters to convert other data formats into our XML format. =================== ENVIRONMENT SETTING =================== To run TrueViz or compile Java code, the directory where Java executable files are installed must be in your path. To do this, two environment variable must be changed. First, set JAVA_HOME as the path to the Java home directory, and Second, add the Java bin directory to the path. Solaris ------- Add the following lines to the '.cshrc' file in your home directory. setenv JAVA_HOME set path=($JAVA_HOME/bin $path) For example, if the Java home directory is /usr/imports/jdk-1.2.2, setenv JAVA_HOME /usr/imports/jdk-1.2.2 set path=($JAVA_HOME/bin $path) MS Windows ---------- Add the following lines to the 'autoexec.bat' file in the root directory. set JAVA_HOME= set PATH=C:\jdk1.2.2;%PATH% For example, if the Java home directory is C:\jdk1.2.2, set JAVA_HOME=C:\jdk1.2.2 set PATH=C:\jdk1.2.2;%PATH% =============== RUNNING TRUEVIZ =============== To run TrueViz, Java 2 Runtime Environment(JRE 1.2.2 or JDK 1.2.2, or higher) must be installed in your system. Refer "ENVIRONMENT SETTING" above to set the environment after installation. For multilingual support, a Unicode font must be installed so that java can display multilingual characters. To install JRE and a Unicode font, refer INSTALL file. Solaris ------- cd /bin trueviz MS Windows ---------- cd \bin trueviz.bat ================== RUNNING CONVERTERS ================== - dafs2xml : dafs2xml converts DAFS format data files into our XML data format files. Usage: % dafs2xml ex) % dafs2xml A001.DAF =========== COMPILATION =========== To compile the Java source codes, JDK 1.2.2 or higher must be installed in your system. You can download JDK 1.2.2 in "http://java.sun.com/products/jdk/1.2/". Refer "ENVIRONMENT SETTING" above to set the environment for JDK 1.2.2 after installation. Solaris ------- To recompile the Java source codes and make new JAR file in the Unix system, just run make in the TrueViz root directory. ex) % cd % make Also, there are other Makefile options. +------------+--------------------------------+ | command | function | +============+================================+ | make jar | make the JAR file(default) | +------------+--------------------------------+ | make class | make class files | +------------+--------------------------------+ | make doc | make TrueViz API documentation | +------------+--------------------------------+ | make tools | build the converters in tools/ | +------------+--------------------------------+ | make clean | remove all class files | +------------+--------------------------------+ MS Windows ---------- To compile the TrueViz source codes, use the included 'make.bat' script that simulates the Unix make program. Options are same as the Solaris options except 'make tools'. Converters works only in the Unix system. ex) C:\> cd C:\trueviz-1_02> make ============= SPECIAL FILES ============= The files contained in this directory are crucial to the proper operation of this application. DO NOT change them without first consulting this file and the accompanying documentation. Files: * Trueviz.dtd - This file is the data type definition that governs the entire application. It is responsible for enforcing the structure of the XML used in this application. Changing Trueviz.dtd can adversely impact the application's ability to function properly. Do so with extreme caution! Note: If in the future it is necessary to alter the structure of the data for this application then this file must update to reflect the new structure. Also, all XML files must be updated to the new structure as well. * Trueviz.properties - This file contains all the application settings. They are as follows: ZoneColor, LineColor, WordColor, CharacterColor : These properties are used to specify the colors that represent Zones, Lines, Words and Characters in the application. Giving the property a new RGB value in the following format will change the corresponding color. (###,###,### where ### is a integer between 0 and 255) ZoneCoordinates, LineCoordinates, WordCoordinates, CharacterCoordinates : These properties are used to determine if coordinate information is displayed next to each vertex. If the property's value is 'true' then the information will be displayed. X_OFFSET, Y_OFFSET : Used in the construction of the rectangles that bound an ROI's vertices. Specifies the origin of each rectangle in relation to the coordinates of the vertex. CORNER_HEIGHT, CORNER_WIDTH : Used in the construction of the rectangles that bound an ROI's vertices. Specifies the height and width of each rectangle in relation to the coordinates of the vertex. * Page.xml, Zone.xml, Line.xml, Word.xml, Character.xml, Vertex.xml - These files serve as well formed canned pieces of XML specific to this application. Each file represents a specific portion of the overall data structure and is validated against the DTD (Trueviz.dtd). If the overall structure ever changes then these files must be update. See DIDDefaultTreeModel portion of the API documentation for further explanation.