SCUQUICK - automate the basic SCUBA data reduction

Description:

This script attempts to automate the first 3 steps of scuba data reduction. This script runs reduce_switch, change_flat (if requested), flatfield on the data. Then for each sub-instrument extinction, scuphot (if a photometry observation), remsky (if requested) and rebin (if requested) are used. The output name for each task is related to the task and current sub-instrument (see Notes).

Usage:

scuquick [-quick] [-tau$\vert$notau] NDF [PARAM=value]

Parameters:

$-$help

Print the help message.

$-$quick

This flag makes all of the SURF tasks run with the `accept' flag (see SUN/95) so that default values are accepted for all parameters unless specified on the command line.

$-$quiet

Hide all messages generated by the script (note this is not the same as using MSG_FILTER=quiet which hides messages from the tasks)

$-$tau value

Run extinction with a tau of `value'. (the LST range is set automatically since we are using a constant tau) Note that this is dangerous when processing multiple sub-instruments. (Same as $--$tau=value).

$-$notau

Run extinction with a zero value of tau (the LST range is set for you). This is equivalent to using the $--$tau=0.0 option.

$-$sub sub_instrument

Only process the specified sub instrument. This is equivalent to setting the SUB_INSTRUMENT parameter explicitly. (same as $--$sub=sub_instrument)

$-$change_flat

Invoke the change_flat task after reduce_switch.

$-$clip

Invoke the scuclip task after extinction.

$-$remsky

Invoke the remsky task after extinction (or scuclip).

$-$rebin

Invoke the rebin package after extinction (or remsky)

NDF

The required dataset. This parameter is optional - reduce_switch will ask for an input file if no value is given.

ADAM parameters = Any

Any parameters accepted by the individual routines as long as they use PARAM=VALUE format.

Examples:

scuquick

When run this way, reduce_switch will ask for the input file name and for the output root name. flatfield will then run followed by extinction on each sub-instrument. Each task will ask questions as needed.

scuquick $-$quick

Same as scuquick except that defaults will be assumed for all parameters that have defaults.

scuquick $-$rebin

Process as for scuquick except that rebin is run on each sub-instrument.

scuquick $-$quick jun02_dem_0002

Process the input file jun02_dem_0002.sdf, accepting all defaults.

scuquick $-$quick jun02_dem_0003 MSG_FILTER=QUIET

Process jun02_dem_0003.sdf, accepting all defaults and turning off all but the most important messages from the SURF tasks.

scuquick $-$quick $-$notau $-$rebin temp OUT=root

Process temp.sdf with zero extinction correction, accept all defaults, use `root' as the default filename and regrid.

scuquick $-$remsky $-$change_flat $--$sub=long

Run the remsky and change_flat tasks in addition to the standard tasks but only process the LONG sub-instrument.

scuquick $-$rebin $-$quick MSG_FILTER=QUIET PIXSIZE_OUT=1 test OUT=temp

Process test.sdf. Accept all defaults. Use `temp' as the filename root. Regrid all data onto a 1 arcsecond grid. Hide all messages from the SURF tasks.

Notes:

Given a rootname (specified with OUT=root or by accepting the default value offered by reduce_switch) SCUQUICK produces the following files (identical to the files produced with SCUBA_SUFFIX=long):

• root.sdf from reduce_switch

• root_flat.sdf from flatfield

• root_$<$sub$>$_ext.sdf from extinction (one for each sub)

• root_$<$sub$>$_sky.sdf from remsky (with the -remsky switch)

• root_$<$sub$>$_reb.sdf from rebin (with the -rebin switch)

• root_$<$sub$>$_pht.sdf from scuphot (if processing a PHOTOM observation)

• root_$<$sub$>$_pht.dat from scuphot (if processing a PHOTOM observation)

Where $<$sub$>$ is the first three letters of the sub-instrument name. Using the $-$tau switch is dangerous when processing multiple sub-instruments since the extinction changes with wavelength.

• Command line options can be abbreviated.

• Skydip observations are recognised.

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

Prior requirements

• The NDF perl module must exist (this should be installed by your system administrator if it is missing).

Related Applications

SURF: reduce_switch, change_flat, flatfield, extinction, remsky, rebin, scuphot, scuclip