Totaliser Log File Format

This page details the format of a Jim Totaliser log file in Backus -Naur Form (BNF) notation. This is intended for those who wish to build their own syntactically correct parser to interpret Totaliser log files. A Totaliser log entry is written by the Totaliser in the ROI Toolkit frame.

A Totaliser log file is a plain text file, consisting of a list (<totals-list>) of Totaliser results. One result is generated each time the Totaliser is invoked. In the Totaliser log file, white space is used to separate the elements within an entry. White space may consist of space characters, tab characters or new-line characters. The amount of white space is not significant. Individual elements that may contain white space are enclosed in double quotes ("). Literal string elements are shown in non-italic font below.

<totals-list> ::= <total-spec>|<totals-list><total-spec>
<total-spec> ::=
Begin Entry
Totaliser log written on <date-time-spec> by Operator ID=<string-spec>
Build version=<version-spec>
Image source=<string-spec>
Pixel width=<num-spec> mm
Pixel height=<num-spec> mm
Pixel depth=<num-spec> mm
Total ROI area=<num-spec> square mm
Total ROI volume=<num-spec> cubic mm
End Entry
<date-time-spec> ::= "dd mmm yyyy hh:mm:ss.SSS zzzz"

<version-spec> is a string of ASCII text characters enclosed in double quotation marks (") giving the build version of Jim. The build version is of the form "MajorVersion_MinorVersion", e.g., "4.0_a"

<string-spec> is a string of ASCII text characters enclosed in double quotation marks (");

<num-spec> is a numerical value that may be either in integer or floating point format, depending on the context.

The totalised area and volume are written with four decimal places. Below is an example Totaliser log entry for ROIs defined on an image "TEST_1" in the directory "/home/xinapse".

Begin Entry
  Totaliser log written on "21 Dec 2005 14:31:21.461 GMT+00:00" by Operator ID="xinapse"
  Build version="4.0_a"
  Image source= "/home/xinapse/TEST_1"
  Pixel width=0.9375 mm
  Pixel height=0.9375 mm
  Pixel depth=10 mm
  Total ROI area=3216.9678 square mm
  Total ROI volume=32169.6785 cubic mm
End Entry
    
Google
WWW Xinapse Web Site

Jim Home