QL_DAY_PLOT $SSW/cgro/batse/idl/ql_day_plot.pro
[Previous] [Next]

 NAME: 
       QL_DAY_PLOT

 PURPOSE:
 Generate quicklook orbital plot from quicklook archive file.


 CATEGORY:
       BATSE

 CALLING SEQUENCE:
	ql_day_plot, which, seconds, arrays, cos_det, daymarks, nightmarks

 CALLS: ***
	ATIME [1], ATIME [2], AVG [1], AVG [2], CHECKVAR [1], FCOLOR [1], GETUT [1], GETUT [2]
	SETUTBASE [1], SETUTBASE [2], SETUTEND [1], SETUTEND [2], SETUTSTART [1]
	SETUTSTART [2], SET_GRAPHICS [1], SET_GRAPHICS [2], SET_UTLABEL, SYS2UT
	TEK_END [1], TEK_END [2], TEK_INIT [1], TEK_INIT [2], TJD2YMD, UTPLOT [1]
	UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], VERT_LINE, anytim [1]
	anytim [2], anytim [3], anytim [4], anytim [5], checkvar [2], fcolor [2]
	linecolors [1], linecolors [2]
 INPUTS:
       which- orbit number
	seconds
	arrays
	cos_det

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 CALLED BY:
	QL_PLOTTER
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:

 Mod 14-jun-94 KT.  removed setting ps plot to landscape.  Now qldisplay
 main routine initializes ps orientation to landscape, and user can change
 orientation in  selectdevices.
 Mod 08-jun-94 by Amy Skowronek  Changed labels at bottom of plot, so
 now channels read start 0 instead of 1.
 Mod.18-aug-94 by AES to use getenv instead of trnlog
	Version 5, richard.schwartz@gsfc.nasa.gov, 2-feb-1998 check windows using have_windows().


QL_ORBIT_PLOT $SSW/cgro/batse/idl/ql_orbit_plot.pro
[Previous] [Next]

 NAME: 
       QL_ORBIT_PLOT

 PURPOSE:
	This procedure generates quicklook orbital plots from quicklook archive file.

 CATEGORY:
 	BATSE

 CALLING SEQUENCE:

	From Ql_plotter:

         ql_orbit_plot, seconds(q), arrays(q,*), cos_det(*,i), midnights(i), $
            midnights(i)+period(i), daymark, nightmark, plotfile=plotfile, $
            saveplots=saveplots


 CALLS: ***
	ATIME [1], ATIME [2], AVG [1], AVG [2], CHECKVAR [1], CHKLOG [1], CHKLOG [2], CH_SCALE
	CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], PARSE_ATIME [1], PL_SCALE
	SCAL_FCTR, SETUTBASE [1], SETUTBASE [2], SETUTEND [1], SETUTEND [2]
	SETUTSTART [1], SETUTSTART [2], SET_GRAPHICS [1], SET_GRAPHICS [2], SET_UTLABEL
	SYS2UT, TEK_END [1], TEK_END [2], TEK_INIT [1], TEK_INIT [2], TJD2YMD, UTPLOT [1]
	UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], VERT_LINE, anytim [1]
	anytim [2], anytim [3], anytim [4], anytim [5], checkvar [2], concat_dir [4]
	parse_atime [2]
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 CALLED BY:
	QL_PLOTTER
 COMMON BLOCKS:
	flare_catalog

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:

 Mod 14-jun-94 KT.  removed setting ps plot to landscape.  Now qldisplay
 main routine initializes ps orientation to landscape, and user can change
 orientation in  selectdevices.
 
 mod 94/07/11 by Amy Skowronek to reflect changes in numbering of detectors
 and channels.  Both now start at 0 rather than 1.  order remains the same.
 mod 94/08/18 by AES to use getenv instead of trnlog
 mod 95/06/28 by AES make plotfile name lowercase
 Version 5, richard.schwartz@gsfc.nasa.gov, 2-sep-1997, cleared utplot label
	using /nolabel
	Version 6, richard.schwartz@gsfc.nasa.gov, 2-feb-1998 check windows using have_windows().


QL_PLOTTER $SSW/cgro/batse/idl/ql_plotter.pro
[Previous] [Next]
 PROJECT: 
	SDAC

 NAME: 
       QL_PLOTTER

 PURPOSE:
 ql_plotter restores the quicklook save file for the day requested, 
 and plot 24-hour plot, all orbits for the day, or the orbit requested
 (either by time or orbit number).


 CATEGORY:
       BATSE

 CALLING SEQUENCE:
         ql_plotter, time=time, orbtime=time, plotfile=not(noplotfile), $
            norbits, period, midnights, days, cosines, $
            xrange, yrange, seconds, arrays


 CALLS: ***
	CHECKVAR [1], LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], PARSE_ATIME [1]
	QL_DAY_PLOT, QL_ORBIT_PLOT, anytim [1], anytim [2], anytim [3], anytim [4]
	anytim [5], batse_read_cat, checkvar [2], parse_atime [2]
 INPUTS:
       

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       norbits
	period
	midnights
	days
	cosines
	xrange
	yrange
	seconds
	arrays

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	full_day
	all_orbits
	time - Input the time for the plot, indicate day or time in orb
	orbtime
	orbit- Use orbit number to override time of day.
	plotfile
	saveplots
	error
 CALLED BY:
	QLDISPLAY
 COMMON BLOCKS:
	qlarchive_file

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:
  Kim Tolbert
  Mod. 9/23/92. When plotting all orbits for a day, if entire orbit had no
  data, tried to plot an empty plot, but wasn't working, so, since don't
  need the empty plot anyway, changed to just print a message saying no data.

  Mod. 9/24/92 Starting ~9/24/92 qlarchive saves an array of periods,
  one for each orbit, rather than a scalar for the entire day).  After 
  restoring save file, if period is a scalar, create an array from it
  so the rest of the code will look the same for either kind of file.
  Changed all references to period to include (element #) when appropriate.
 Version 4, richard.schwartz@gsfc.nasa.gov, 2-sep-1997, fixed a bug
	in the creation of the time array.  Added documentation.
	Cleaned up the file naming using SSW routines.
	changed the time compression/restore algorithm.	
 	time and data arrays were stored scaled down as i*2.  
 	Old style compressed with digitization error.  The new restore (2-sep-1997) maps the
 	times onto packet times (multiples of 2.048 sec from xrange(0)) with the
 	only error being daily clock drift.
 Version 5, richard.schwartz@gsfc.nasa.gov, 14-may-1998, protect against out of range times looking 
	for non-existent (non-resident) files.


QL_READBDB $SSW/cgro/batse/idl/ql_readbdb.pro
[Previous] [Next]
 Project     : SDAC
                   
 Name        : QL_READBDB
               
 Purpose     : This procedure reads records from the bdb or fdb file into the array of structures
 		passed in the argument bdb.  
               
 Category    : BATSE
               
 Explanation : 
 ql_readbdb reads records from the bdb or fdb file into the array of structures
 passed in the argument bdb.  bdb is defined in the calling routine to be
 big enough to hold the maximum number of records needed, and in this routine
 we fill it in 1000 elements at a time.  This is so that we use the same
 space over and over instead of creating a new array every time we read in 
 a new set of data.  It reads records between start time (startt) and end 
 time (endt). maxindex is the maximum index in the array returned in bdb. 
 If the times requested are not in the file, maxindex is returned as 0.
 
               
 Use         : ql_readbdb, dd_open, bdb, startt, endt, maxindex
    
 Inputs      : dd_open - structure containing information and data structures
		for open bdb file.
		startt  - start time for reading from file, in seconds from 1-jan-1979.
		endt    - end time.	
               
 Opt. Inputs : None
               
 Outputs     : bdb - structure containing read file data, housekeeping and science.
		maxindex - the maximum index in the array returned in bdb. 

 Opt. Outputs: None
               
 Keywords    : 

 Calls       : ***
	CONV_VAX_UNIX, FIND_PACKET, SC_SECONDS_ED, SIZE_STRUCT, anytim [1], anytim [2]
	anytim [3], anytim [4], anytim [5], load_struct
 CALLED BY:
	QLARCHIVE
 Common      : None
               
 Restrictions: 
               
 Side effects: None.
               
 Prev. Hist  :

 Modified    : 
 	Kim Tolbert  4/91

 	Modified 4/17/95 by AES - fixed end of loop checking for instance in which
		last point is on a repetition boundary - i.e. 2099,2199.
  
	 Version 3, richard.schwartz@gsfc.nasa.gov, rename to batse_out_arr, 22-aug-1997
		and convert data buffer for Unix from Vax.
	Version 4, richard.schwartz@gsfc.nasa.gov, 4-sep-1997,  check for pad_byte


QLARCHIVE $SSW/cgro/batse/idl/qlarchive.pro
[Previous] [Next]
 PROJECT:
	SDAC
 NAME: 
       QLARCHIVE

 PURPOSE:
	This procedure creates the daily archive file, IDL save file.
 	Generate archive quicklook plot files from BATSE data base (BDB) files.

 CATEGORY:
       BATSE

 CALLING SEQUENCE:
	qlarchive, file

 CALLS: ***
	ATIME [1], ATIME [2], BATSE_OUT_ARR, BREAK_FILE [1], BREAK_FILE [2]
	BREAK_FILE [3], CHECKVAR [1], DET_POINT, DN_TRANS, FORM_FILENAME [1]
	FORM_FILENAME [2], FS_OPEN [1], FS_OPEN [2], ORBIT, QLRADEC_FILL, QL_READBDB
	SC_SECONDS_ED, YOHKOH_FORMAT [1], YOHKOH_FORMAT [2], break_file [4]
	checkvar [2], hxrbs_format, yohkoh_format [3]
 INPUTS:
       bdbfile -  file name of batse bdb file, discla+housekeeping merge file. Only file+ext,
	not the full path.

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	PATH - Path for save file other than $BATSE_QLOOK (def).

 CALLED BY:
	DO_QLARCHIVE
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:

 Kim Tolbert  6/9/92
 Mod KT 3/93 to handle omni data.  Calls qlradec_fill
 Mod KT 3/94 to use new compression scheme.  We were scaling everything
 to i*2's (between 1 and 20000).  Now scale the arrays (except the times)
 to bytes (between 1 and 255).  Also now scales logarithmically instead
 of linearly.  Times (seconds array) are still scaled to i*2's between
 1 and 20000.
 Mod AES 7/94 to refer to old channel 1 as channel 0 - only affects
 comments, not code
 Mod AES 9/7/94 to save qlook files in XDR format

Version 5, richard.schwartz@gsfc.nasa.gov 2-sep-1997
	changed output file name extraction, now use break_file on bdbfile.
	changed out_arr call to batse_out_arr	
 	time and data arrays were stored scaled down as i*2.  
 	Old style compressed with digitization error.  The new restore (2-sep-1997) maps the
 	times onto packet times (multiples of 2.048 sec from xrange(0)) with the
 	only error being daily clock drift.


QLDISPLAY $SSW/cgro/batse/idl/qldisplay.pro
[Previous] [Next]
 PROJECT:
	SDAC
 NAME: 
	QLDISPLAY

 PURPOSE:
 Main procedure for display of BATSE quicklook plots.  Provides menu to
 let user choose time and plot either orbital or 24-hour quicklook plots.


 CATEGORY:
	CGRO/BATSE

 CALLING SEQUENCE:
	QLDISPLAY


 CALLS: ***
	ALPHA_PAGE [1], ALPHA_PAGE [2], ATIME [1], ATIME [2], BATSE_TIME_INPUT
	CHECKVAR [1], DEL_PLOTFILE, FSELECT, GETUT [1], GETUT [2], LOC_FILE [1]
	LOC_FILE [2], LOC_FILE [3], MAILPLOT, MORE [1], MORE [2], Mailfile, PATH_DIR
	QL_PLOTTER, READ_SEQFILE, SELECT_DEV, SETUT [1], SETUT [2], SET_GRAPHICS [1]
	SET_GRAPHICS [2], SET_X [1], SET_X [2], SPS, TEK_PRINT [1], TEK_PRINT [2], UTIME [1]
	UTIME [2], XDEVICE, YOHKOH_FORMAT [1], YOHKOH_FORMAT [2], checkvar [2], curdir [1]
	curdir [2], fix_Mailaddr, hxrbs_format, yohkoh_format [3]
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 CALLED BY:
	batse_menu
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:

 Kim Tolbert  July, 1992

 Modified 9/3/92 to add SequentialPlots command to allow user to autmatically
 make lots of plots easily.  Prompts for orbital or full-day, end time,
 screen, mail, or print plot, and mail address, and then loops through from
 TIME to the end time requested.
 Mod 4-jun-94 KT. Initialize PostScript device to landscape.  Also
 changed ql_day_plot and ql_orbit_plot to not set device on each plot.
 User can now select orientation in selectdevices.
 Mod 23-sep-94 AES.  Use menu format for sequentialplot questions, 
 rather than asking questions one at a time.
 Mod 13-oct-94 by AES.  Check for long window when entering procedure -
 if one exists, replace it with a standard size window.  Otherwise do
 nothing.
 Mod 28-jun-95 by AES use lowercase filenames
 VERSION 7, richard.schwartz@gsfc.nasa.gov, 26-aug-1997,
 used loc_file with path_dir('batse') to locate help files.
 Version 8, richard.schwartz@gsfc.nasa.gov, 2-feb-1998, use have_windows and sps. 
 Version 9, richard.schwartz@gsfc.nasa.gov, 18-mar-1998, specify window number from current. 
 Version 9, richard.schwartz@gsfc.nasa.gov, now accepts all ANYTIM compatible time strings for
       time parameters TIME, START, and END.


QLPRINT $SSW/cgro/batse/idl/qlprint.pro
[Previous] [Next]

 NAME: 
       QLPRINT

 PURPOSE:


 CATEGORY:
       BATSE

 CALLING SEQUENCE:


 CALLS: ***
	CHKLOG [1], CHKLOG [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
	PARSE_ATIME [1], concat_dir [4], parse_atime [2]
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:


QLRADEC_FILL $SSW/cgro/batse/idl/qlradec_fill.pro
[Previous] [Next]
 qlradec_fill looks for gaps in the  pointing data (value is 0 in gaps) for
  Name:
       QLRADEC_FILL
 the qlarchive program.
 (There are gaps in the pointing data when the data was sent using the
 omni directional antenna and a compressed data format was used.)
 If there was any good data passed into radec_fill, it will perform a
 linear fit to determine the values to insert into the arrays to fill the
 gaps.  It then saves the latest pointing data and time in radec_save.
 The next time it is called, if there is no good
 pointing data in the entire passed interval, it will insert the values
 that were stored in radec_save in the xra,xdec,zra,zdec arrays.

Similar to radec_fill which is used in fsplot.  Difference is that pointing
 arrays are passed in in structure bdb here (can't pass in just the subarrays
 because then can't change the values), and here don't look how close time
 is when restoring radec_save, because assume in quicklook that times are
 continuous from start of day.

 K. Tolbert 3/93

 CALLS:
 CALLED BY
	QLARCHIVE


QUAL_HDR_STRUCT $SSW/cgro/batse/idl/qual_hdr_struct.pro
[Previous] [Next]

 NAME: 
       QUAL_HDR_STRUCT

 PURPOSE:


 CATEGORY:
       BATSE

 CALLING SEQUENCE:


 CALLS:
	none
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:


QUAL_STRUCT $SSW/cgro/batse/idl/qual_struct.pro
[Previous] [Next]

 NAME: 
       QUAL_STRUCT

 PURPOSE:


 CATEGORY:
       BATSE

 CALLING SEQUENCE:


 CALLS:
	none
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY: