OBSSUM - Produce one-line summary of SCUBA observations

Description:

obssum goes through all the sdf files in the current directory and, optionally, DATADIR (defined in an environment variable) and extracts information from any FITS entries that may be present.

In the absence of the $-$all flag, a numeric range is requested. This range only has an effect on raw data or reduced files which have the run number embedded into the file name. Filenames with no numbers are treated as scan 0.

Usage:

obssum [-h] [-demod] [-reduced] [-mode ??] [-all$\vert$[-begin nn -end nn]]

Parameters:

$-$h[elp]

Return a help message only. More help can be obtained by using `showme sun216' or `scuhelp obssum'.

$-$all

List all files in the current directory and $DATADIR

$-$demod

Only list demodulated data files (signified by _dem_ file name)

$-$reduced

Only list reduced data files (signified by _red_ file name)

$-$begin nn

First scan number to be considered (same as $--$begin==nn)

$-$end nn

Final scan number to be considered (same as $--$end=nn)

$-$mode obs

Select only specified observation modes for listing. The list should be comma separated. (same as $--$mode=obs)

Examples:

obssum

Ask for a range of scan numbers and then give a summary of every sdf file matching this criterion in DATADIR and the current directory.

obssum $-$all

Generate a summary of all sdf files in the current and DATADIR directory.

obssum $--$begin=5 $--$end=100

Generate a summary of all data from scans 5 to 100 inclusive.

obssum $-$all $-$reduced

Produce a one line summary of all reduced (_red_) files.

obssum $-$all $-$reduced $>$ log.txt

Produce a one line summary of all the reduced files and store the output in the text file log.txt (note this example is shell specific).

obssum $-$all $-$reduced $-$demod

Produce a summary of all reduced (_red_) and demodulated (_dem_) data files (ie not files produced during off-line data reduction).

obssum $-$all $-$mode pointing

Produce a one line summary of all pointing observations

obssum $-$reduced $-$begin 100 $-$end 200 $--$mode=photom,skydip

Produce a one line summary of the photom and skydip observations of reduced files with scan numbers 100 to 200. This is similar to photsum except that the signal and signal-to-noise will not be displayed even if reduced files are being listed.

Notes:

• obssum only uses information stored in the FITS header of reduced and raw data files and does not provide summaries of reduced (RO) data such as photometry results (essentially for reasons of clarity). `photsum' must be used to generate a summary of photometry observations that includes reduced data.

• Files are drawn from the current working directory and the directory indicated by the $DATADIR environment variable.

• Data reduced by the off-line system will all be treated as run 0 for the purposes of listing unless numbers are present in the filename.

• The output can be stored in a file by using unix redirection as long as the search range is fully specified (either as `$-$all' or with `$-$begin' and `$-$end').

• Command line options can be abbreviated.

• Options that take values can be used either as `$-$flag option' or as `$--$flag=option'

Related Applications

SURF: sculog, photsum, pointsum, mapsum, skysum