next up previous contents
Next: w_clean Up: Stage-I scripts Previous: w_fits

w_plot

FUNCTION
	Main script to invoke a quick survey plotting program 
	wqplot for a complete FOT
		 

USAGE
	w_plot -f prefix [-specifier [argument]] ..... [-specifier [argument]]

	Before being able to use the w_proc at least the
	following shell environment variables must be set:
		
		WFC_TOP		e.g. /home/xrayman/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
			
	To store the parameter files In addition a directory in
	your home directory must exist with the following name:
		
		$HOME/pfiles/release
			
	The names of these directories may be site dependent, 
	so when in doubt ask your local ftools manager.
			
	It is advisable to create a single shell source file
	for setting these variables plus others to be used 
	with stage-2 processing.


DESCRIPTION
	Produce a standard set of plots in PostScript format.  They contain 
	ratemeter plots, instrument housekeeping values, pointing information, 
	observation modes, etc.  One sheet is produced per each observation.
	   Per observation one sheet is produced.  Only in case of a very
	long observation will two sheets be made.
	   One sheet plotting contains on top some general info of the
	 observation like FOTnumber OP-ID date of observation, camera 
	 pointing info etc.  The bottom lines contain values extracted
	 of the instrument housekeeping like temperatures of the camera
	 structure and voltages of the dtector electronics.
	   In the middle space is available for plots of threee selctable
	 rate-meters from the science housekeeping.

		
GENERAL OPTION SPECIFIERS
 
-h	
	Display a concise help on the available switches and recognized
	environment settings.  It will not show the switches of possible 
	subsequently invoked scripts however.

-f [string]
	The argument specifies the FOT identifier.  TFor resulting files
	this will become the prefix of all names.  Only when processing 
	directly from tape with the '-fot' action can this switch be omitted,  
	in which case the FOTID is taken from the FOT directory.  But also
	in this case it will be overruled by giving the -f FOT_ID switch.
	
-t [string]
	Specify (top-)directory where input (link)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.
	It will overrle the value of enveironment variable FOT_TOP.
	
-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]
	Argument value regulates the output verbosity volume.  When 0 a 
	minimal (silent) output will occur.  The default is 1 where it 
	will show the programs that were active and some info on files 
	produced.  A larger value will produce more diagnostic info.
	This switch will be passed on to subsequently invoked scripts.
	
-w1
-w2
	Only process the data of one (-w1 or -w2) camera.  
	(not relevant for '-fot' and -fits' actions)
	
-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

-plotall
	Plots all observations.  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 ENVIRONMENT VARIABLES
  
    In addition default values for switches and installed settings 
    can be overruled by the following  shell environment variables.

	WFC_TOP The top directory of the WFC software distribution 
		No default as it is site dependent
 
	WFC_ETC Place where scripts and general selection files are located
		if not present default to $WFC_TOP/etc

	WFC_BIN Place where the program executable binaries are located 
		if not present default to $WFC_TOP/bin

	WFC_CAL Place where calibration and instrument definition files.
		if not present default to $WFC_TOP/cal
		(see also switches '-c1' and '-c2')  
  
	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')

	PLT_MET1  Meter name of upper graph to be plotted
		if not present default to RATE_EVENT
		
	PLT_MET2  Meter name of middle graph to be plotted
		if not present default to RATE_PROC
		
	PLT_MET3  Meter name of lower graph to be plotted
		if not present default to RATE_GUARD 

	
EXAMPLES:

Make standard plots of cleaned files of FOTID OP999 located in directory 
/FITSDIR  and save

  >  w_plot -f OP999 -w2 -t /FITSDIR -d /PLOTSDIR

   or alternatively

  >  w_proc -f OP999 -w2 -t /FITSDIR -d /PLOTSDIR


NOTES
  
    - The destination directory will be created if not present. 
    
    - Throughout a FOT-prefix is used to specify which
      particular WFC-FOT has to be processed.  Presently
      only one FOT can be processed at a time.
    
    - The detector calibration files are created during
	the installment of Stage-2 software package.


SEE ALSO
	w_proc, wqplot



Mark Savenije
Sat Jan 18 15:04:49 MET 1997