# File performanceLog.txt, version 1.1, released  96/11/13 at 16:49:44 

Subj: GBES performanceLog Users guide
From: Glen Langston
Date: 96 November 11

	This document describes GBES offline utility program "performanceLog"
for describing the quality of data recorded during the tracking pass.
This log file is intended for use by the space agencies and VLBI correlators.

performanceLog
==============

	The performanceLog program reads through the GBES logs and summarizes
the events during all tracking passes during a specified interval,
usually one tracking pass.  Inspection performanceLog output should 
allow diagnosis of Space VLBI problems due to the link between space craft
and tracking station.
 
	The output is to a performanceLog file with the same name as
the input phase residual file name, but with extension ".kpg".
The times of change of the link status are written to the terminal.
Like all GBES offline programs, performanceLog also produces a short help
message if executed without arguments.  Ie:

/s3/ovlbi/bin/performanceLog

performanceLog: Creates text summary of a tracking pass link status.
performanceLog: usage
performanceLog [<time>] [-I] [-o <outFile>] <phaseFile> [<infileN> ...] 
where  -I        Ignore link status and output all entries
    -o <outFile> Optional Name of output performance Log File
     <phasefile> Input Phase Residual file name 
Only the time interval in <phasefile> is summarized
       <infile1> is first input log file name (optional) 
[<infileN>]      Optional additional input log file name(s)
       where <times> can be one or more of:
      -b[egin] <mjd> [<time>] first date and time to examine
      -e[nd]   <mjd> [<time>] last  date and time to examine
      -s[ingle] <mjd>         process a single day of files
      -t                      todays files (UTC date)
      -y                      yesterdays files (UTC date)
<times> must have the date (ie 96Oct31), but hours are optional
ie: -b 96Jun23                start at beginning of day (0 hours)
ie: -e 96Jun23 13h30m15s      specify fixed end time

Inputs/Outputs
==============

	The inputs to performanceLog are a phase Residual file from
the tracking pass of interest and the GBES real time log files in the 
standard offline ovlbi area.  The performanceLog output is written to
an ascii output file, with default name based on the input phase
residual file name.  A new extension is given to the output file name,
".kpg".  If the output file name already exists, then a file with a 
revision code is created (ie ".kpg.a").  The default output file name


	The usual way in which performanceLog will be used is to generate a
log for a particular tracking pass.  The arguments to performanceLog
for this mode are rather simple, only the phase residual file must be
specified:

performanceLog /s3/ovlbi/out/9611102047.phr

	Which produces the following output on the terminal.

performanceLog -b 1995OCT10 -e 2023FEB25 24h00m00s
OPEN PHASE  FILE : /s3/ovlbi/out/9611102047.phr
OPEN OUTPUT FILE : /s3/ftp/ovlbi/out/9611102047.kpg.a
Number of Files with data      : 1
OPEN INPUT FILE  : /s3/ovlbi/out/961110.log..OK
Link  OK  at 1996NOV10, 20h48m00s 
Link Lost at 1996NOV10, 20h54m50s 
DONE

	Note that the times when the link is good are listed 
on the terminal.  The execution performanceLog ends when the time
range in the log files is passed, or end of file in the phase residual file.

Contents of the performanceLog Output
=====================================

	The output of the performance file is described in the
interface specification, entitled "Spacecraft/Station Performance Log 
Interface", by L. D'Addario and dated 95 November 21.  This
specification is kept on-line in the ovlbi documentation area.  The
specification file name is "/s3/ovlbi/doc/perf-interface.spe".