Content-type: text/html Manpage of JACK

JACK

Section: DAISY tools (1)
Updated: 24th August
Index Return to Main Contents

 

NAME

JACK - generate training set statisitics

 

SYNOPSIS

jack [ -usage | -help ][ -nice nice level ][ -prompt prompt string ] | [ -interactive prompt string ][ -html_dir HTML directory ][ -browser HTML browser ][ -tdir training set directory ][ -udir unknown images directory ][ -classes ][ -class class name | all ][ -silent ][ -script statistics gathering script ][ -read_macros macro definition file name ][ -file file name ] >& <log file>

 

DESCRIPTION

jack(1) is used to gather training set statistics for the DAISY pattern recogntion system. These statisitics can be used to tune the system and thereby increase the accuracy of the system in terms of both accuracy and throughput. jack(1) may be run in both non-interacive and interactive modes. In interactive mode, the user is prompted by a command line interpreter for the information required to generate statistics for a given class or training set, using an interface which supports readline(3) semantics, full interrupt control, and the ability to background statisitics generation (which may be useful when overall statisitics are required for large training sets). The jack(1) application is designed to be run as an EPS script from the programmable buttonbox of the DAISY dfe(1) tool. The task of statisitics gathering is actually done using a user defined script which is called by jack(1). This confers considerable flexibilty: for example different scripts can be used by the system when gathering statistics from partitioned and non-partitioned training sets. Statistical output either written to standard output or to a virtual HTML page, which is then displayed by an appropriate browser, for example, konqueror(1), lynx(1) or netscape(1). An example (ASCII) output file is given below.

 

EXAMPLE OUTPUT FILE

The terms co-ord, sill, vote etc., are explained in the The DAISY Users Manual.

Statistics for training class "acrus"

Co-ordination
Mean pass co-ordination: 5.10
Min pass co-ordination: 3
Pass: 50.00 percent

Sill
Mean pass sill: 1.83
Min pass sill: 1,80
Pass: 10.00 percent
Mean fail sill: 1.21
Max fail sill: 1.21
Fail: 5.00 percent

Vote
Mean fail vote: 50.00
Max fail vote: 50.00
Fail: 5.00 percent

Overall pass/fail statistics
Pass (raw FPTP): 85.00 percent
Pass: 60.00 percent
Fail (detected): 30.00 percent
Fail (undetected): 10.00 percent

 

OPTIONS

-usage | -help display help and copyright information for jack(1).

-nice nice level specifies the process priority which is set using the nice(2) system call. Defaults to 15 (so jack(1) runs at a lower priority than the rest of the DAISY system.

-prompt | -interactive prompt string tell jack(1) to enter interactive mode with optional prompt prompt string. If no prompt string is supplied by the user it defaults to jack>.

-html_dir HTML directory specifies the HTML directory to be used by the HTML browsers launched by jack(1). Pages of virtual HTML generated by jack(1) are also (termporarily) stored in this directory. Defaults to html.

-browser web browser specifies the web browser to be launched by jack(1) when (virtual) HTML output has been requested. Default to konqueror which is the browser associated with the KDE desktop. If web browser is set to ,B none or stdout output is sent to standard output.

-tdir training set directory specifies the training set directory to be analysed.

-udir unknown images directory specifies the name of the directory which contains the unknown imagery. If -udir is not specified the training set directory is used (and jack(1) executes a true jacknife test of the imagery in that directory.

class class name specifies the class (within training set directory ) for which statistics are required. If all is specified aggregate statistics for all classes in training set directory will be generated.

-silent tells jack(1) not to log status to standard error as it generates statistics.

classes key tells jack(1) to display the classes in the current training set which match key. Where this data is to be displayed (e.g. a file, standard output or as HTML can be slected using the browser and file interactive commands.

-script statisics script specifies the script which will be used to gather statitics. Defaults to JACKSCRIPT.

 

EXAMPLE STATISTICS SCRIPT

#!/bin/csh
#-----------------------------------------------------------------------------------
# Script used by the jack training set tester to generate
# training set statistics.
# (C) M.A. O'Neill, Digital Vision, Didcot
# 19/05/2003
#
# $1 is the name of the training set image to be tested.
# $2 is the name of the training set directory.
#-----------------------------------------------------------------------------------

p $2/$1 .
ftag -tiff_name $1 -ftype unknown
floret -tdir $2 -identify $1 -mlst jackscript.$$.vhtml_in.tmp -no_output
vhtml -corder 3 -clorder 3 -no_browser -short -immediate jackscript.$$.vhtml_in.tmp

m jackscript.$$.vhtml_in.tmp
m $1

exit 0

 

INTERACTIVE COMMANDS

jack(1) supports the following interactive commands. In addition to atomic commands, jack(1) also supports a full recursive macro capability, with both mandatory and advisory parameter support. A typical jack(1) macro definition is of the form:
macro <name> [ <c1>; <c2> ] where name is the name (used to call the macro) and the commands inside the square brackets are the commands executed when the macro is run. The macro facility supports two kinds of parameter, $ for i mandatory parameters (required by one or more of the commands within the macro, and % for defaultable parameters (which may be ommited). An example macro with mandatory parameters is:

macro pf [ browser none; test $; browser default; partition ]

which runs a sequence of interactive commands to generate a DAISY partition function. If the argument to the test command is ommited when the macro is called (e.g. pf rather than pf tersa) the macro exits. As test can default its argument, the macro could have been specified with a defaultable parameter:

macro pf [ browser none; test %; browser default; partition ].

In this case if the parameter is not supplied when the macro is executed, the test command defaults the class to be tested to the current contents of the class name register.

hdir HTML directory sets current HTML directory name.

browser HTML browser sets HTML browser name.

class class name sets class name.

classes key displays the classes within the specified training set which match key.

tdir training set directory. sets training set directory name.

udir unknown images directory specifies the directory containing unknown images.

fg launches VHTML browser on the same thread of execution as the jack(1) process.

bg launches VHTML browser on its own thread of execution (which is separate to that of the jack(1) process).

script script file sets statistics gathering script.

pscript script file sets the (training image) prior probabilities tagging script.

tscript script file Set (training image) threshold tagging script. This script computes the training image thresholds which are used to tag the images (in a given class) with the threshold values (co-ordinate, vote and sill) required to minimally excite that class.

failures [off] tells jack(1) to produce a list of all images which have not been assigned to the correct class (as previously determined by an expert). The list is set to either standard output or viewed as virtual HTML as dictated by the browser and/or file settings.

breakdown tells jack(1) to do a full statistical breakdown of a jacknife test. If the test has been conducted on multiple classes, statistics are produced for each of these classes. This output is sent to standard output or to an HTML browser depending on the settings of browser and/or file.

mco co-ordinate count sets the minimum co-ordinate threshold for image activation within jack(1). This threshold is local to jack(1) and does not effect image activation thresholding in the DAISY system as a whole.

msill sill threshold sets minimum sill threshold within jack(1). This threshold is local to jack(1) and does not effect image activation thresholding in the DAISY system as a whole.

mvote vote threshold Set minimum vote threshold within jack(1). This threshold is local to jack(1) and does not effect image activation thresholding in the DAISY system as a whole.

maff affinity threshold sets minimum activation affinity threshold within jack(1). This threshold is local to jack(1) and does not effect image activation thresholding in the DAISY system as a whole.

test class generates statistics. This command will only proceed if the class, tdir and script varibles have been assigned sensible values. If class is given, the the current class parameter is updated before testing is started.

frate class | all Compute failure rate [for class or all classes in training set]. This option is usually used when jack(1) is called by a DAISY stochastic optimiser subsystem for example mopt(1) or topt(1)

file file name sets the file name to which ASCII output is to be written. If browser none or browser stdout or file stdout is selected, output is written to standard output.

partition n components tells jack(1) to compute the partition function (and to write out the n most significant components. If a file name has been set via the file command, output is written there. In addition, the file and browser commands can be used to send the partition function to standard output. Additionally, the browser command can be used to display the partition function via an HTML browser such as netscape(1) or konqueror(1). An example of a partition function is shown below:

Partition for class "acrus" in training set "xylophanes.ipm.fovea"

acrus: PASS 91.89 (percent)
amadis: FAIL 5.41 (percent)
staudingeri: FAIL 2.70 (percent)

ptype type adds the type to the list of match types used to generate a partition function.

read macro definition file name reads the macro definition file macro definition file name into the jack(1) macro definition space. The original contents of the macro definition space are overwritten.

write macro definition file name writes the current macro definition space to a file. The file format is:

#----------------------------------------------------------------------------------------
# Jack (version 1.04) macro definition file
# (C) M.A. O'Neill, Digital Vision, 2003
#----------------------------------------------------------------------------------------

# Macro "example""
example
ihelp

# Macro "pf"
pf
browser none; test %; browser default; partition

macro <name> [ <command list> ] adds macro name with body [ <command list> ] to the macro definition space. The macro may then be invoked by typing <name> together with any argument required by the macro.

macros displays the current contents of the macro definition space (to standard output).

delete <name> | all deletes either the macro <name> from the macro definitions space, or clears the entire space if all has been specified.

show shows key jack(1) variables:

Current parameters for Jacknife trainer

class : all
training set directory : xylophanes.ipm.fovea
script : JACKSCRIPT (default)
HTML directory : html
HTML browser : konqueror (default)

ptag [off] tells jack(1) to tag images in the training set with computed prior classification probabilities. These probabilities are used by the vhtml(1) and voter(1) classifiers when displaying the probable identification of an unknown. If off is specified this feature is turned off.

ttag [off] tells jack(1) to tag images with compute prior activation thresholds. These are used by the floret(1) classifier in order to threshold classifier activation when classifying an unknown.

[off] ihelp displays help on interactive commands.

exit | quit | bye exits jack(1) when in interactive mode.

When statistics are being gathered in the foreground pressing CNTL-C will cause jack(1) to return to the interactive command prompt.

 

DEDICATION

This program is dedicated to the memory of my Father J.W. (Jack) O'Neill (1909-1995), and my Mother, Hilda O'Neill-Eagle (1919-2003).

 

ENVIRONMENT VARIABLES

None.

 

COPYRIGHT

(C) Digital Vision.

 

PROGRAMMER

M.A. O'Neill.

 

SEE ALSO

floret(1), vhtml(1), voter(1), mopt(1), topt(1), netscape(1), konqueror(1), daisy(1), ipm(1), floret(1), vhtml(1)


 

Index

NAME
SYNOPSIS
DESCRIPTION
EXAMPLE OUTPUT FILE
OPTIONS
EXAMPLE STATISTICS SCRIPT
INTERACTIVE COMMANDS
DEDICATION
ENVIRONMENT VARIABLES
COPYRIGHT
PROGRAMMER
SEE ALSO

This document was created by using the manual pages.
Time: 16:21:16 GMT, August 03, 2004