Content-type: text/html Manpage of VHTML

VHTML

Section: DAISY commands (1)
Updated: 8th February 2005
Index Return to Main Contents
 

NAME


vhtml  DAISY virtual HTML output display driver  

SYNOPSIS

vhtl [ -nice cardinal ][ -argf argument_file ][ -growth_protection ][ -help ][ -usage ][ -version ][ -slots ][ -slotinfo ][ -noprogress ][ -sdir sensitive (unknown image) directory ][ -id VHTML display image I.D. key ][ -browser HTML browser [ -sengine search engine ][ -short file name | stdout | stderr | default ][ -pups_url url ][ -darwin_url url ][ -daisy_url url ]][ -html_dir HTML page directory (path)name ][ -activation classifier activation threshold ][ -show_match_list ][ -vote cluster majority vote threshold ][ -support classifier support threshold ][ -corder cluster order ][ -clorder classification limit order ][ -key image state key for vhtml processing ][ -uid client identification key ][ -in_state computational input state tag ][ -out_state computational output state tag ][ -mlist match list size ][ -immediate matchlist file name ][ -no_browser [ -short filename | stdout | stderr | default ] | [ -full filename | stdout | stderr | default ]] >& <log file>

 

DESCRIPTION

vhtml(1) is a driver which waits until user-tagged unknown images have been classified by the DAISY floret(1) classifier, and then (if possible) displays a virtual page of HTML describing the object which floret(1) has identified. It does this by interrogating images (whose [partial] names) match a user defined id key to see if they have been classified. If they have, the images are further interrogated to find their class object. vhtml(1) then builds a page of HTML describing the class-object on the fly and launches a user-defined web browser (such as netscape(1) ) to display it.

 

OPTIONS


  -help invokes the on-line context help system. This "man" page is displayed. The process then exits.

-growth_protection <retrys> causes the system to retry an sbrk(3) call up to retrys times. This option permits the program to wait until the core that it requires is available rather than simply exiting if sbrk(3) fails.

-usage displays shortform usage string.

-version displays program version number.

-slots displays short form pups(7) library dependencies.

-slotinfo displays long form pups(7) library dependencies.

-argf argument_file tells the filter to take its command line arguments from the specified argument_file. The data format of the argument file is:

# ... optional comment line ...
-argflag [1]
argument_parameter [1,1]
argument_parameter [1,2]

argument_parameter [1,n]

# ... optional comment line ...
-argflag [2]
argument_parameter [1,1]
argument_parameter [1,2]

argument_parameter [1,n]

  -noprogress tells ipm(1) not to output information for the progress(1)

-nice cardinal determimes the niceness at which the filter is scheduled. In keeping with all UNIX user processes, nice must be a cardinal between 0 and 20. The default niceness for floret(1) is 4.

-sdir sensitive directory is used to set the directory in which dfe(1) places images to be classified. This option may also be changed interatively via a PSRP session (dispatch binding is also sdir ). This option is mandatory and must be supplied.

-tdir is used to set the pathname of the directory containing the training images used by floret(1).

-id VHMTL display image I.D. key tells vhtml(1) the I.D> key (which must be matched) before an image is interrogated (for possible VHMTL generation).

-browser browser name tells vhtml(1) which web browser it is to use to display the page of O/P HTML. If no browser is specified vhtml(1) simply writes the generated HTML to <VHMTL display image name>.html in the floret(1) sensitive directory. This option and the -no_browser option are mutually exclusive. If sengine is specified, that search engine is used to do a keyword search in order to find web pages which contain references to the class (or classes) specified in the (short) match list file read by vhtml(1).

-no_browser tells vhtml(1) to output the results of an identification in ASCII text format. This option and the -browser option are mutually exclusive.

-short file name | stdout | stderr | default tells vhtml(1) to output shortform ASCII identification information. Typically this is used when vhtml(1) is being running as part of a slaved pipeline by jack(1) in order to examine the jacknife (leave one out) statisitics of a training set. If filename is specified the output is sent to this named file. If stdout is specified, output is sent to standard output or default If stderr is specified, output is sent to standard error. This option may be specified with either the -browser or -no_browser options. If it is specified with -browser ASCII shortform output is sent to the specified location in addition to the page of (virtual) HTML, so that processing downstream of vhtml(1), for example by voter(1) the voting VHMTL generator is possible. Default output is to standard output.

-full tells vhtml(1) to write full ASCII indentification information to standard ouput. This option is used when an I.D. is required without the overhead of running a web browser. This option is only useable if -no_browser has also been specified. If stdout is specified, output is sent to standard output or default If stderr is specified, output is sent to standard error. This option is only valid if -no_browser has been specified. Default output is to standard output.

-immediate matchlist file name tells vhtml(1) to produce immediate O/P (e.g. not passed via a sensitive directory) using the file matchlist file name. This option is used when vhtml(1) is called in slaved mode by applications such as the training set statistics generator jack(1)

-sengine search engine tells vhtml(1) which search engine it is to use if there is no information available about classified objects on the local host. The search engine may be any Internet search engine, for example, google or yahoo. If the local system has an active Internet connection, the nominated search engine is queried in order to see whether it can supply any information about the classified object. If vhtml(1) is running on a standalone host, the query is aborted.

  -pups_url url sets PUPS website URL. Defaults to http://chassuer.usc.edu/pups which is the primary PUPS website.

-darwin_url url sets Darwin Initiative website URL. Defaults to http://www.research.detr.gov.uk/rep9496/darwin.htm

-daisy_url sets DAISY website URL. Defaults to http://chassuer.usc.edu/pups/projects/daisy.html

-activation classifier activation threshold sets the threshold limit below which a given classfier (e.g. training set image) will not respond. Defaults to 0.1 (unknowns with affinities less than this will fail to excite the classifier).

-show_match_list tells vhtml(1) to display a full ordered match list (up to the co-ordination number limit) of the best possible identities of the unknown.

-vote cluster majority vote threshold set a voting threshold. If cluster majority vote threshold percent of the matchlist ( including the head of the list ) is in class X, then the unknown is also deemed to be in class X. Defaults to 50 percent.

-support classifier support threshold set the classifier support theshold. If the affinity difference between the list head class in the matchlist and the first class not of that type exceeds or equals classifier support threshold then the classifier support threshold is exceeded. Essentially this is a measure of how diffusive a cluster is: the greater the affinity difference, the less diffusive the cluster. Defaults to 0.5.

-corder cluster order sets the cluster order: If the first cluster order items in the matchlist are of the same typei X, the unknown is deemed to be of type X (to that order). Effectively, orders greater than 3-4 imply the unknown is almost certainly of class X. Defaults to 4.

-clorder sets the classification limit order: if the matchlist contains more than classification limit order classes, the unknown is deemed to be unclassifiable. Defaults to 6.

-uid client identification key sets a unique i.d. which tells vhtml(1) which terminal to display VHTML data on. Defaults to users i.d.

-key training set image key list sets key which tells vhtml(1) to process only specified classes on matchlist

-in_state sets computational input state tag (only matchlists associated with unknowns carrying this tag will be processed). Defaults to vhtml.in

-out_state sets computational output state tag. Defaults to vhtml.out

 

SIGNALS

vhtml(1) supports PUPS/PSRP process status request protocol which uses the following signals:
SIGINIT SIGCHAN SIGPSRP: Process status [PSRP] request (protocol 6.01F)
SICLIENT: tell client server is about to segment
SIGALIVE: check for existence of client on signal dispatch host
Additional signals may be required if the process is CKPT enabled.

 

ENVIRONMENTAL VARIABLES

Note environmental variables are ignored if the corresponding command line option is provided.

VHTML_NOPROGRESS do not generate status information for progress(1)

VHTML_SDIR: sensitive directory set vhtml(1) sensitive directory.

VHTML_TDIR set training set directory.

VHTML_ID: key set vhtml(1) display image I.D. key.

VHTML_BROWSER: browser set the browser for interactive VHTML page display for this instance of vhtml(1).

VHTML_SENGINE: search engine set the search engine for interactive VHTML page display for this instance of vhtml(1).

VHTML_ACTIVATION_THRESHOLD set classifier activation threshold.

VHTML_SHOW_MATCHLIST tells vhtml(1) to display a full ordered match list (up to the co-ordination number limit) of the best possible identities of the unknown.

VHTML_VOTE_THRESHOLD set (majority) voting threshold.

VHTML_SUPPORT_THRESHOLD set support threshold.

VHTML_C_ORDER set cluster order.

VHTML_CL_ORDER set cluster limit order.

VHTML_HDIR set HTL (output) directory.

VHTML_INSTATE set input computational state tag.

VHTML_OUTSTATE set output computational state tag.

VHTML_KEY set list of matchlist images which are to be processed.

VHTML_MLIST_SIZE set (upper bound size) of matchlist.

PUP_URL set URL for information about PUPS libraries.

DARWIN_URL set URL for information about UK Govt. Darwin Initiative.

MORPHO_URL set URL for information about Morpho (the developer of the DAISY software suite).

DAISY_URL set URL for information about the DAISY system.

 

PSRP INTERACTIVITY

Supports interactive querying and goal setting while running using Process Status Request Protocol [ PSRP ], see psrp(1).

The following commands may be sent to the running vhtml(1) process from a psrp(1) client:

status display status information for attached vhtml(1) PSRP server process.

activation sets classifier activation threshold.

vote sets majority voting threshold.

support sets classifier support threshold.

cluster sets cluster order.

clorder sets cluster limit order.

deactivate deactivates application. br

reactivate reactivates application

url sets any URL which can be specified via the command line.

key sets matchlist class key.

uid sets browser display i.d.

browser sets VHTML diplay browser type.

sengine set Internet search engine/agent.

mlist sets matchlist size.

instate sets input state tag.

outstate sets output state tag.

hdir sets HTML directory. sets training set directory.

sdir sets sensitive directory.

vhtml generate VHTML from PSRP API supplied matchlist.

 

LIBRARIES

vhtml(1) uses the PUPS libraries, see pups(7)

 

COPYRIGHT

(C) Digital Vision.

 

PROGRAMMER

M.A. O'Neill.

 

SEE ALSO

dfe(1), psrp(1), floret(1), ipm(1), voter(1), daisy(1), progress(1), jack(1), dlllib(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
SIGNALS
ENVIRONMENTAL VARIABLES
PSRP INTERACTIVITY
LIBRARIES
COPYRIGHT
PROGRAMMER
SEE ALSO

This document was created by man2html using the manual pages.
Time: 17:02:23 GMT, February 08, 2005