NeSDaC
w_proc
<![CDATA[
NAME
w_proc -- Main script to invoke a suite of other scripts that
call into action programs (stage-1) for extracting,
monitoring and processing SAX-WFC FOTs in order to
prepare the data for detecter correlation and X-ray
sources detection (stage-2).
Throughout a FOT-prefix is used to specify which
particular WFC-FOT has to be processed. Presently
only one FOT can be proecessed at a time.
USAGE
w_proc -f prefix [actions] [options]
or
w_proc -fot [actions] [options]
Before being able to use the w_proc at least the
following shell environment variables must be set:
WFC_TOP e.g. /home/sax/wfc
WFC_ETC e.g. $WFC_TOP/etc
WFC_BIN e.g. $WFC_TOP/bin
path e.g. ( $WFC_ETC $WFC_BIN $path )
As in some instances use is made of ftools utilities
also the following environment variable must be set
FTOOLDIR e.g. /home/library/ftools
It is advisable to create a single shell source file
for setting these variables plus others to be used
with stage-2 processing.
ACTION KEYWORDS
The order of actions or options is not fixed.
An option can be either a switch or a keyword
followed by one or more arguments.
At least one of the following actions must be selected:
-fot
Copy FOT data directly from tape onto diskfiles.
Resulting names are of the form 'prefix__nnnn.fot'
where nnnn is a numeric field. If no prefix
is specified by the '-f' switch, the FOT number
as found in the TAPEDIRECTORY (first file) will
be taken.
-fits
Process FOT files previously copied from tape or
retrieved by internet and renamed by w_vaxlink.
Swap bytes if the data is written according the VAX
byte ordering.
Extract the relevant data into files structured
according the FITS standard.
Issue warnings about the instrument status and
out-of-limit situations.
Print an overview of types and times of extracted data.
The resulting files are level 0 processed fits files
and will be of the form Wprefix_*0.fits'.
-clean
Clean and select from level 0 processed FOT files.
The resulting files are level 1 processed fits files
and will be of the form Wprefix_*1.fits'.
Additionally the attitude data is processed and
analyzed to produce information on camera pointings
and earth occultations. Stage-2 processing can
take place on level 1 procesing or higher.
-shift
Process level 1 processed FOT files to produce
drift corrected detector positions. The resulting
files are level 2 processed fits files and will be
of the form Wprefix_*2.fits'
-plot
Produce a standard set of plots in PostScript format.
They contain ratemeter plots, instrument houskeeping
values, pointing information, observation modes, etc.
One sheet is produced per each observation.
-spv
Run a Sensor Performance Verification on level 0 data.
(presently only available at SRON-Utrecht)
GENERAL OPTIONS
-f [string]
The argument specifies a prefix of the FOT. Only when
processing directly from tape with the '-fot' action can
this switch be omitted.
-t [string]
Specify (top-)directory where input files are located.
By default the current directory is taken. This default
can be overruled by setting environment variable $WFC_OBS
Only in case of '-fot' action this will be the destination
directory where the FOT files from tape will be placed to be
used as input for level 0 (-fits) processing.
-d [string]
Force result files under destination top-dir.
By default this will be the input directory.
Already existing result files will be overwritten.
-vv [integer]
Verbosity volume. The higher the number the more diagnostic
output is printed. 0: is minimal output volume
-w1
-w2
Only process the data of one (-w1 or -w2) camera.
(not relevant for '-fot' and -fits' actions)
-save
Force intermediate files to be saved. By default the
lower level files will be discarded.
-n [integer]
-n1 [integer]
-n2 [integer]
Indicates the number (-n) or number range (-n1 and -n2)
of observations to be processed. By default n1 = 1 and
n2 = 999.
-c1 [string]
-c2 [string]
The name of the input FITS file that contains the
coefficients to calculate the physical values of
temperatures and voltages from digitally coded
analog value. By default they are $WFC_CAL/wfc1.det
and $WFC_CAL/wfc1.det respectively. The defaults can
be fixed by setting environment variables W_INSCAL1
and W_INSCAL2 respectively.
-blockio
Allow writing and reading data files in fast block I/O.
This may introduce a non-standerd FITS format that cannot
be used across different computer systems and will not work
with systems using VAX byte order. Presently by default
the blockio option is disabled for OSF1 unix systems and
enabled for all other systems like HPUX.
LEVEL 0 RELATED OPTIONS
-swap
-noswap
Specify whether the data is organized according to VAX
definition and bytes of words and double-words must be
swapped. This will normally case if FOT's were
produced produced by the Science Data Centre.
Presently by default the swap option is disabled for OSF1
unix systems and enabled for all other systems like HPUX.
-tape [string]
specify the device name of the tape-unit. Only relavent
in case of '-fot; action. default: /dev/rmt/0mn.
The default can be preset with environment variable TAPE.
-at [string]
specify the name of an alternative Attitude file.
It will replace the one that is in the FOT.
If not present in the FOT it will be inserted after
the second file of the original FOT.
It is possible to specify the alternative Attitude
file by setting environment variable W_ATTFILE
HIGHER LEVEL RELATED OPTIONS
-fi [string]
Name of the file containing expression for making the
Good Times Intervals from each Instrument Housekeeping file
By default file $WFC_ETC/etc/wfc_sel_ins is used. This
default can be fixed by setting environment variable W_SELINS
-fs [string]
Name of the file containing expression for making the
Good Times Intervals from each Science Housekeeping file
By default file $WFC_ETC/etc/wfc_sel_sci is used. This
default can be fixed by setting environment variable W_SELSCI
-fe [string]
Name of the file containing expression for making the
Good Times Intervals from the Ephemeris file.
By default file $WFC_ETC/etc/wfc_sel_eph is used. This
default can be fixed by setting environment variable W_SELEPH
-plotall
Plots all observatations. By default only the observations
having instrument housekeeping plus instrument and science
data will result in a plotting sheet.
-plotslew
Plots also obsrvations in slew mode. By default these
observations will not be plotted
-spvslew
Also perform SPV on slew observations. By default
this will not be done.
RECOGNIZED SHELL VARIABLES
In addition default values for switches and installed settings
can be overruled by the following shell environment variables.
WFC_TOP
No default as it is site dependent
WFC_ETC
if not present default to $WFC_TOP/etc
WFC_BIN
if not present default to $WFC_TOP/bin
WFC_CAL
if not present default to $WFC_TOP/cal
(see also switches '-c1' and '-c2')
WFC_OBS
if not present default to current direct
(see also switch '-d')
W_INSCAL1
if not present default to $WFC_CAL/wfc1.det
(see also switch '-c1')
W_INSCAL2
if not present default to $WFC_CAL/wfc2.det
(see also switch '-c2')
W_ATTFILE
if not present default to "-"
(see also switch '-at')
W_SELEPH
if not present default to $WFC_ETC/wfc_sel_eph
(see also switch '-fe')
W_SELINS
if not present default to $WFC_ETC/wfc_sel_ins
(see also switch '-fi')
W_SELSCI
if not present default to $WFC_ETC/wfc_sel_sci
(see also switch '-fs')
PLT_MET1
if not present default to RATE_EVENT
PLT_MET2
if not present default to RATE_PROC
PLT_MET3
if not present default to RATE_GUARD
EXAMPLES
1. Process complete FOT from tape in current directory and log the output
the prefix will be the FOTnumber.
--> w_proc -fot -fits -clean -plot > proc.log
2. Process FOT from disk directory in separate directory
--> w_proc -f prefix -t data_dir -d destination_dir -fits -clean -plot
NOTES
- In case a FOT resides on disk its filenaming is not of the
from 'prefix__nnnn.fot' a renaming or namelink is needed
by script w_vaxlink available in $WFC_ETC.
- Presently '-shift' option is not operational as insufficient
analysis has been perfumed due to unreliable attitudes
- The detector calibration files are created during
the installment of Stage-2 software package.
- Unspecified options exist fot handling cases of incomplete
or corrupt FOTs. They are not adviced for use in general
operations.
]]>
Back to: