[Previous]
[Next]
NAME:
RD_DMP
PURPOSE:
read dump file produced by RD_EXB to determine start and end times
CALLING SEQUENCE:
rd_dmp,file,tstart,tend
INPUTS:
file = dumpfile name (default is DMPFL1.DAT')
OUTPUTS:
tstart,tend = start and end times of file
CALLS: ***
ATIME [1], ATIME [2], CHKLOG [1], CHKLOG [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FETCH, MKLOG, PRTHDR
CALLED BY:
mksort
HISTORY:
written DMZ (ARC Mar'93)
[Previous]
[Next]
NAME:
RD_EXB
PURPOSE:
read XRP raw data exabytes
CALLING SEQUENCE:
rd_exb,tunit,tstart,tend
INPUTS:
tunit = tape unit number (assumed mounted)
OUTPUTS:
data is dumped into file DMPFL1.DAT
tstart,tend = start and end times to extract
CALLS: ***
ATIME [1], ATIME [2], I2VAL, MKLOG, PRTHDR, REWIND [1], REWIND [2], SKIPF [1], SKIPF [2]
TAPRD [1], TAPRD [2], UTIME [1], UTIME [2], YYDOY_2_UT, get_utrange
RESTRICTIONS:
input times must be in UT format YY/MM/DD, HHMM:SS.MSEC
(date is optional, and defaults to date of first file on tape)
HISTORY:
written DMZ (ARC Mar'93)
[Previous]
[Next]
NAME:
RD_HXRBS_FITS
PURPOSE:
Read hxrbs fits files into idl
CATEGORY:
HXRBS
CALLING SEQUENCE:
RD_HXRBS_FITS, Filename, Ut, Counts, Livetime, Edges, Deltat
CALLS: ***
FXPAR [1], FXPAR [2], READFITS [1], READFITS [2], READFITS [3], TJD2YMD
INPUTS:
Filename: Hxrbs fits file name
OUTPUTS:
Ut: Time in seconds since 1-jan-1979, middle of datapoint,
dblarr(nbin)
Counts: Number of counts in each of 15 energy channels,
fltarr(15,nbin)
Livetime: Livetime in each sample, fltarr(nbin)
Edges: Output energy loss bands in keV, fltarr(2,15)
Deltat: Accumulation interval, scalar, in seconds
OPTIONAL OUTPUTS:
H0: Primary header (string array)
H1: Header from first (time) extension (string array)
H2: Header from second (energy edges) extension
(string array)
Res_coef: Hxrbs resolution coefficient, varied from .75 to
1.3 over the mission
Error: Returns 1 on problem.
CALLED BY:
GET_HXRBS_FITS, HXFITS
COMMON BLOCKS:
HXRBS_RESPONSE
PROCEDURE:
Calls readfits three times for the counts, times, and edges.
The resolution coefficient is passed through the common to
hxrbs_response.pro. This is done in the background to serve the
SPEX procedures, although it may also be done explicitly.
MODIFICATION HISTORY:
RAS, 08/26/94
Mod. 09/06/94 by RAS. Removed extra call to readfits for edges.
Mod. 09/07/94 by AKT. Added 3 keywords to return 3 headers
Also removed call to transpose edges and counts array -
fits files were changed to store in correct order
Mod. 08/04/95 by RAS. Added common hxrbs_response.
Mod. 05/08/96 by RCJ. Added documentation.
[Previous]
[Next]
NAME:
rd_idb
PURPOSE:
interrogate image structure IDB for image information
CATEGORY:
FIS handling
CALLING SEQUENCE:
rd_idb,idb,imnum,chnum,ion,ut,add
INPUTS:
idb=FIS image structure
OUTPUTS:
imnum= selected image number
chnum=selected channel number
ut= UT time of image
ion = selected ion
add = selected address
CALLED BY:
RDFIS
RESTRICTIONS:
IDB must exist
PROCEDURE:
interrogate IDB structure
MODIFICATION HISTORY:
written DMZ (ARC) Nov'90
[Previous]
[Next]
NAME:
rd_sdb
PURPOSE:
interrogate spectrum structure SDB for spectrum information
CATEGORY:
FIS handling
CALLING SEQUENCE:
rd_sdb,sdb,spcnum,chnum,ut
INPUTS:
sdb=FIS spectral structure
OUTPUTS:
spcnum= selected spectrum number
chnum=selected channel number
ut= UT times of spectrum
CALLED BY:
plotfis
RESTRICTIONS:
SDB must exist
PROCEDURE:
interrogate SDB structure
MODIFICATION HISTORY:
written DMZ (ARC) Jan'91
[Previous]
[Next]
NAME:
RD_UVCAT
PURPOSE:
read UVSP CATALOG.CAT file
CALLING SEQUENCE:
output=rd_uvcat(expno)
INPUTS:
expno = UVSP experiment number
OUTPUTS:
output = structure with .XC, .YC, .TIME, .PITCH, .YAW, .ROLL.
xc = x-coord of image center (arcsecs west of solar center).
yc = y-coord of image center (arcsecs north of solar center).
CALLS: ***
ATIME [1], ATIME [2], GET_UVBOR, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3]
YYDOY_2_UT
CALLED BY:
GET_UVSP
PROCEDURE:
reads UVSP CATALOG.CAT for image information
MODIFICATION HISTORY:
written - DMZ (ARC) Nov'92
[Previous]
[Next]
NAME:
RDBDA
PURPOSE:
read BDA files
CALLING SEQUENCE:
rdbda,file,chan,accum,times,ltc,utbase,spectra,bins,sdgi,ion,w0,dw,rock,ierr
INPUTS:
file = BDA file name
chan = array of channel numbers to select e.g [1,3,4]
accum = mean accumulation time (secs)
OUTPUTS:
times = time array of spectra (seconds since 00 UT)
ltc = lightcurve array (counts/sec) per channel
spectra(nbin,nspec,nchn) = spectra (counts per bin per second)
bins = detector address per channel
sdgi = integration times of individual spectra
utbase = date of spectra
ion = ion(s) in selected channel
w0 = start wavelength per channel
dw = dispersion per channel (Ang/address)
rock = rocking width (Ang: FWHM)
CALLS: ***
ATIME [1], ATIME [2], FETCH, rdbda_smm
CALLED BY:
plot_bda
MODIFICATION HISTORY:
Written by DMZ (ARC, Jan'92)
[Previous]
[Next]
NAME:
rdbda_smm
PURPOSE:
read SMM BCS BDA file, accumulate, and produce BSC index, data structs
CALLING SEQUENCE:
rdbda_smm,file,index,data,verbose=verbose,$
chan=chan,accum=accum,tstart=tstart,tend=tend,ierr=ierr
INPUTS:
file = string BDA file name
OUTPUTS:
index,data = BSC index and data array structures (Yohkoh format)
KEYWORDS:
chan (in) = channel to process [def =1]
accum (in) = accumulation time (secs) [def=20]
tstart,tend (in) = start,end times to process (e.g. 0700:30) [def=all times]
verbose (in) = on, for verbose output
ierr (out) = 0/1 for success/failure
CALLED BY:
BCS, RDBDA
PROCEDURE:
Based on D. Mathur's fortran BDA_SPECTRA
CALLS: ***
ARR2STR [1], Arr2Str [2], BDA_STRUCTURE, Ex2Int [1], Ex2Int [2], GET_LIB, Int2Ex [1]
Int2Ex [2], LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], MKLOG, MK_BSC_STR [1]
MK_BSC_STR [2], PNT_STRUCTURE, anytim [1], anytim [2], anytim [3], anytim [4]
anytim [5], bda_bcchfm, bda_bcdabl, bda_bixrcs, bda_degrp, bda_expand, bda_nxtbdaixr
RESTRICTIONS:
Requires following logical/environment variable definitions:
BCSBINLST = bcsbinlst.idl (BCS bin list id file)
BCSFMTLST = bcsfmtlst.idl (BCS format id file)
MODIFICATION HISTORY:
31 Jan 1994, written DMZ (ARC)
[Previous]
[Next]
NAME:
RDFCS
PURPOSE:
read FCS FIS image files
CALLING SEQUENCE:
rdfcs,img,chnum,lines=lines,select=select,/nowhite,/bkg
INPUTS:
FIS image filename
KEYWORDS:
select = no of ions user is prompted for [def=1]
lines = ions (string array) included in menu selection [def = all]
nowhite = inhibit white light selection [def = no inhibit]
bkg = subtract background
OUTPUTS:
IMG=array of structures with selected images
OPTIONAL OUTPUTS:
chnum=FCS channel numbers
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], FETCH, UTIME [1], UTIME [2], XRPOFF
break_file [4], getfisblk, rdmap, st_img, stcname
CALLED BY:
FTEMAP
MODIFICATION HISTORY:
DMZ (ARC) Jan'91
[Previous]
[Next]
NAME:
RDFDA
PURPOSE:
to extract spectra from FCS FDA files
CALLING SEQUENCE:
rdfda,file,chan,time,data,pointing
INPUTS:
file = FDA filename
chan = FCS channel number
OUTPUTS:
time = vector of start times (secs since 1/1/79)
data = vector [time,no_points_spectrum,address,count_rates]
theta_id = vector of theta_id's for each spectrum
pointing = [pitch,yaw,roll]
CALLS: ***
CONV_VAX_UNIX2, EXPCNT, FETCH, THETA
CALLED BY:
plotfda
PROCEDURE:
uses EXPCNT
MODIFICATION HISTORY:
- Written by DMZ (ARC, Nov'91)
[Previous]
[Next]
NAME:
RDFIS
PURPOSE:
read FIS files and return image attributes in a structure
CALLING SEQUENCE:
rdfis,img,chnum,back,/nobkg
INPUTS:
prompts for FIS image filename
OUTPUTS:
IMG= structure with image parameters
img.data = 1-d array containing count rates
img.nx,ny = 2-d dimensions of image
img.xp,yp = coordinates of image pixels (arcecs) relative to solar origin
img.id = string name identifying image
img.time = string time of data (e.g. 87/11/12 1235:00)
img.exps = exposure time per pixel (secs)
img.pitch,yaw,roll = spacecraft pitch, yaw (arcsecs) and roll (deg)
img.add = address or wavelength
OPTIONAL OUTPUT:
chnum = channel number of selected image
back = background array
KEYWORDS:
/nobkg = do not subtract background from data (def is to subtract)
OPTIONAL OUTPUTS:
FCS channel number
CALLS: ***
ATIME [1], ATIME [2], DECHECK, FETCH, UTIME [1], UTIME [2], XRPOFF, getfisblk, rd_idb
rdmap, st_img
CALLED BY:
plotfis, rdimg
MODIFICATION HISTORY:
written - DMZ (ARC) Oct'91
modified to renormalize background arrays by DGI factor -- DMZ Mar'92
[Previous]
[Next]
NAME:
rdfis_img
PURPOSE:
read FIS image structure
CALLING SEQUENCE:
rdfis_img,idb,detno,img,bkg,bimg
INPUTS:
idb=FIS image structure
detno= detector number
OPTIONAL INPUT:
bkg= 1 to remove background [def], 0 to keep it
OUTPUTS:
img= image structure
OPTIONAL OUTPUT:
bimg= background image structure
CALLS: ***
ATIME [1], ATIME [2], DECHECK, UTIME [1], UTIME [2], XRPOFF, st_img
CALLED BY:
FCS
MODIFICATION HISTORY:
written DMZ (ARC) Nov'91
[Previous]
[Next]
NAME:
RDFIS_SPEC
PURPOSE:
read FIS spectral data files
CALLING SEQUENCE:
rdfis_spec,sdb,detno,x,y,step
INPUTS:
sdb = FIS spectral structure
detno = FCS channel number
OUTPUTS:
x = address (or wavelength) array
y = counts per sec per step
step = step size
KEYWORDS:
/wave : convert address to wavelength in Angstrom (def = address)
/flux : flux calibrate spectrum
plabels: string information label
CALLS: ***
ATIME [1], ATIME [2], UTIME [1], UTIME [2], WLFCS, fluxcon
CALLED BY:
FCS, plotfis
MODIFICATION HISTORY:
DMZ (ARC) Jan'92
[Previous]
[Next]
NAME: RDFISDataBlk.pro
Purpose: read and return requested FIS data-block(s).
The list is defined by the roadMap.
Parameters:
filunit unit # of FIS file
roadmap pointer to the data-block.
qbkgsub 0 for no bkg subtraction
1 for bkg subtraction
idb complete FCS image data-block
sdb complete FCS spectra data-block
Other Important Procedure Calls:
DefIdxStr, ix, ix2
Purpose: Define "data-block" Index Structure
where:
ix part I of data-block index
ix2 part II of data-block index
CALLS: ***
DefIdxStr, GETDIdx, GETFIS_1BLK
CALLED BY:
getfisblk
History:
written 1-Aug-90, by GAL
[Previous]
[Next]
NAME:
RDFIT
PURPOSE:
read FIT files created by SPCFIT
CALLING SEQUENCE:
rdfit,file,chan=chan,x,y,e,utbase,param=param,xtitle,ytitle,plabels
INPUTS:
file= fit filename
chan = BCS channel
OUTPUTS:
x = time array (secs since UTBASE)
y = fitted parameter
e = error y
utbase = string base time of file
KEYWORDS:
param= 'emiss', 'temp', 'blue', 'vturb', or 'ratio'
xtitle,ytitle,plabels = plot labels (outputs)
CALLS: ***
FETCH, INTERPOL, mewe
CALLED BY:
PLOTFIT
PROCEDURE:
based on MEGAPLOT
MODIFICATION HISTORY:
DMZ (ARC) FEB'92
[Previous]
[Next]
NAME:
RDFPLOT
PURPOSE:
This procedure reads output files written by FPLOT.
CATEGORY:
HXRBS
CALLING SEQUENCE:
RDFPLOT, File_name, Arr1, Arr2, Arr3, Arr4
INPUTS:
FILE_NAME: Character string containing the specification of the
file to read.
OUTPUTS:
ARR1 - ARR4: Arrays containing the output data. The values in these
arrays depend on whether the data is histogram or point
plot data. See FPLOT documentation for further
information. All arrays have dimensions of NPNT (See
common block below).
HEADER_RECORD: A common block containing the information in the
header record. This information can be written to the
screen in a nice format by using the procedure
PRINT_HEADER_RECORD above.
CALLS: ***
PRINT_HEADER_RECORD
CALLED BY:
PRINT_HEADER_RECORD
COMMON BLOCKS:
HEADER_RECORD
RESTRICTIONS:
Calling sequence for Histogram data:
RDFPLOT, FILE_NAME, XLO, XHI, YVAL
Calling sequence for Point plot data:
RDFPLOT, FILE_NAME, XVAL, YVAL, IFLAR, IENTRY
MODIFICATION HISTORY:
Written by J.M. Repace 03/31/89.
Mod. 04/02/91 by AKT. Max was reading entry numbers from a separate
record. FPLOT is writing flare numbers and entry numbers
(ARR3 and ARR4) in the same record.
Mod. 02/26/93 by AKT. Made changes to follow IDL V2 rules.
Deleted unformatted keyword, changed /segmented to not be
part of filename string, but a keyword argument.
Changed FORRD to READU.
Mod. 12/08/94. Put print_header_record.pro at top of file so everything
would compile when calling rdfplot
Mod. 05/07/96 by RCJ. Added documentation.
[Previous]
[Next]
NAME:
RDFTE
PURPOSE:
read FTE image files
CATEGORY:
I/O
CALLING SEQUENCE:
rdfte,img
INPUTS:
FTE image filename
OUTPUTS:
img=structure
CALLS: ***
FETCH
CALLED BY:
PLOTFTE, rdimg
PROCEDURE:
see code
MODIFICATION HISTORY:
DMZ (ARC) Sept 90
[Previous]
[Next]
NAME:
rdimg
PURPOSE:
read image array from specified file types
CATEGORY:
I/O
CALLING SEQUENCE:
rdimg,img
INPUTS:
prompts for filename
OUTPUTS:
img = structure containing image attributes (size,time,pointing etc)
CALLS: ***
EMENU, GET_UVSP, RDFIS, RDFTE
PROCEDURE:
user supplies appropriate interface function
MODIFICATION HISTORY:
DMZ (ARC) Sept. 90
[Previous]
[Next]
NAME:
rdmap
PURPOSE:
read FIS roadmap structure
CALLING SEQUENCE:
rdmap,file,modes,stimes,chans
INPUTS:
file = FIS file
OUTPUTS:
modes = string vector of modes
stimes= string vector of times in UTPLOT format
OPTIONAL OUTPUTS
chans = vector of available channels per mode
CALLS: ***
ATIME [1], ATIME [2], FETCH, GetHeader, GetPoint, GetRoMap, UTIME [1], UTIME [2]
CALLED BY:
FCS, RDFCS, RDFIS
MODIFICATION HISTORY:
DMZ (ARC) Dec'91
[Previous]
[Next]
NAME:
rdspc
PURPOSE:
read fitted BRR spectra
CALLING SEQUENCE:
rdspc,file,chan,stime,yf,ftime,pc
INPUTS:
file = SPC file
chan = BCS channel no. (1-7)
stime = time of required spectrum (secs since start of day)
OUTPUTS:
ftime = actual time of fitted spectrum
yf = composite fitted BCS spectrum (counts/bin/sec)
pc = primary component
KEYWORDS:
plabels = string array of useful plot information labels
xtitle = x-axis label
ytitle = y-axis label
CALLS: ***
FETCH, READSPC, REVERSE
CALLED BY:
PLOTFIT
PROCEDURE:
READSPC used to read fitted BCS spectra created by SPCFIT
MODIFICATION HISTORY:
Written by DMZ (ARC) Feb'92
[Previous]
[Next]
NAME:
READ_AUTODIR
PURPOSE:
Reads the catalog of flares on optical disk and stores the
info in common AUTODIR.
CATEGORY:
HXRBS
CALLING SEQUENCE:
READ_AUTODIR
INPUTS:
none.
OUTPUTS:
none explicit, only through commons;
COMMON BLOCKS:
AUTODIR
RESTRICTIONS:
At this time this routine only runs under VMS.
MODIFICATION HISTORY:
Written 03/15/91 by K.T.
Mod. 07/08/93 by K.T. ; This routine was being called by FLARES.
Wrote an IDL save file containing this data to try to speed
things up. So now FLARES just restores the save file instead
of calling this routine. KT 7/8/93
Mod. 05/13/96 by RCJ. Added documentation.
[Previous]
[Next]
NAME:
READ_FLRDIR
PURPOSE:
CATEGORY:
HXRBS
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:
[Previous]
[Next]
NAME:
READ_GOESTABLES
PURPOSE:
Read the IDL save files containing the list of file names and start
and end times for all files on the optical disks GOES0 and GOES1,
and the magnetic disk dua3:[goes].
CATEGORY:
HXRBS
CALLING SEQUENCE:
READ_GOESTABLES
INPUTS:
none explicit, only through commons;
OUTPUTS:
none explicit, only through commons;
COMMON BLOCKS:
GOESCOM
PROCEDURE:
The save files were written by the routine dc_filesummary with a call
that looks like:
dc_filesummary, dir='dua3:[goes]', instr='goe', $
outfile='perm$data:goes0_times.sav'
Note: This routine was called from find_goes_data to determine which
disk a requested time was on. See find_goes_data.pro for more info.
MODIFICATION HISTORY:
Written 03/26/93 by K. T.
Mod. 05/13/96 by RCJ. Added documentation.
[Previous]
[Next]
NAME:
READ_MINICAT
PURPOSE:
Procedure to read the mini version of the flare catalog that contains
only HXRBS information.
CATEGORY:
HXRBS
CALLING SEQUENCE:
READ_MINICAT, fldata, num_flares
INPUTS:
In keyword format.
OUTPUTS:
Fldata: Structure containing info on flare.
Num_flares: Number of flares returned.
KEYWORDS:
FLARE: Flare number, if you want info on that particular flare.
TIME: If this keyword is set, info on all flares on that day
are returned.
BATSE: Set this keyword to use BATSE style tag names in fldata
structure.
ERROR: Will be =1 if error occurs.
CALLS: ***
anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
CALLED BY:
HFLARE, spex_evnt [1], spex_evnt [2]
COMMON BLOCKS:
MINICAT
RESTRICTIONS:
At this time this routine only runs under VMS.
PROCEDURE:
Mini version of the flare catalog is stored in perm$data:autodcp.cat.'
If user passes a flare number in flare keyword, info for that flare is
returned in the structure fldata. If user passes a time, all flares on
that day are returned in the array of structures in fldata.
MODIFICATION HISTORY:
Mod. 08/23/94 by RAS. Pass out the structure using BATSE style tag
names if batse keyword set
Mod. 05/13/96 by RCJ. Added documentation.
Mod. 06/14/96 by RCJ. Cleaned up documentation.
Version 4, RAS, 28-mar-1997, changed rflags to lonarr(2) from 0.0d0
[Previous]
[Next]
NAME:
READ_MINICATALL
PURPOSE:
Procedure to read entire HXRBS mini catalog and return start and
end times for all flares. Flares are sorted by time.
CATEGORY:
HXRBS
CALLING SEQUENCE:
READ_MINICATALL
INPUTS:
none.
OUTPUTS:
Times: Array(12773,2) containing starting and ending times for
each flare.
A: Structure containing complete info on all flares.
RESTRICTIONS:
At this time only runs under VMS.
PROCEDURE:
Can easily be modified to return anything or everything in file.
MODIFICATION HISTORY:
Written 08/93 by AKT.
Mod. 05/13/96 by RCJ. Added documentation.
RAS, 29-may-1996, changed rflags tag to lonarr(2) from 0.0d0
[Previous]
[Next]
NAME:
READBRR
PURPOSE:
procedure to read BRR files which contain BCS data.
CALLING SEQUENCE:
readbrr, filnam, bin, data, tdx, ch_tim, stuff, chan_idx, $
chan_num,buff,block
INPUTS:
filnam = BRR file name
OUTPUTS:
spectra and time arrays
CALLED BY:
GETBRR
PROCEDURE:
BRR files are keyed, indexed files written by MKBRR
MODIFICATION HISTORY:
written by JRL (LPARL), 2-NOV-85.
[Previous]
[Next]
Routine: READSPC
Procedure to read SPCxxxx.xxx files which contain theoretical
spectra corresponding to data in the BRR files.
SPC files are keyed, indexed files (isam).
------------------------------------------------------------------------
SPC file format version = 1.1 ( 10-May-86 )
The version number of the SPC file that this procedure can read
is given by the value of VERSION (defined below).
------------------------------------------------------------------------
J.R. Lemen, MSSL, Nov. 1985, written.
J.R. Lemen, MSSL, May 1986 (New file format)
CALLS:
CALLED BY
rdspc
[Previous]
[Next]
NAME:
READSUM
PURPOSE:
Read and extract parameters from summary file(s). Either reads one
file if FILE is specified in calling arguments, or a group of files
specified in the string array FILEARRAY in SUMFILCOM common. Values
are returned in arrays passed in parameter list - DHEAD, RHEAD, HHEAD,
RINT, HINT.
CALLING SEQUENCE:
READSUM, DHEAD, RHEAD, HHEAD, RINT, HINT, DAY, DSEC [, FILE]
INPUTS:
None.
OPTIONAL INPUT PARAMETERS:
FILE = Name of summary file to read. When this argument is passed, the
FILEARRAY array in the SUMFILCOM common is ignored.
OUTPUTS:
DHEAD = real*8 header array
DHEAD(0) - base time of file in R*8 seconds since 79/1/1,0000
DHEAD(1) - start time of flare in R*8 seconds since 79/1/1,0000
DHEAD(2) - peak time of flare in R*8 seconds since 79/1/1,0000
RHEAD = real*4 header array
RHEAD(0) - 15 element array of low energy channel edges
RHEAD(15) - 15 element array of high energy channel edges
HHEAD = integer*4 header array
HHEAD(0) - Flare number
HHEAD(1) - Duration of flare in seconds
HHEAD(2) - Peak rate of flare in counts / second (no bkgd subtraction)
HHEAD(3) - Total number of counts in flare
HHEAD(4) - Active region number on sun of flare
HHEAD(5) - Number of intervals of data available in this summary file
RINT = real*4 data array containing the following for each interval
(where J is the interval counter):
RINT(0,J) - chi-square for fit
RINT(1,J) - 4 element array of best fit parameters
RINT(5,J) - 4 element array of uncertainties on best fit parameters
RINT(9,J) - Ratio of parameter chosen in DCPSPEX to test for convergence
Ratio of A(n) of last/previous fit
RINT(10,J) - Total live time in seconds of flare interval
RINT(11,J) - 15 element array of Y values (flux in 15 energy channels)
RINT(26,J) - 15 element array of uncertainties on Y
RINT(41,J) - 9 element array of spares
HINT = integer*4 data array containing the following for each interval
(where J is the interval counter):
HINT(0,J) - Method used for subtracting background in DCPACCUM
0 = no background subtracted
1 = one pre-flare background interval used
2 = one post-flare background interval used
3 = pre- and post-flare background intervals used
HINT(1,J) - number of loops through DCPSPEX for this interval
HINT(2,J) - Bit map indicating channels used in fit (bit 0 corresponds
to channel 1, bit = 1 means it was used)
HINT(3,J) - number of degrees of freedom
HINT(4,J) - interval number
HINT(5,J) - start time of interval in msec relative to basetime
HINT(6,J) - end time of interval in msec relative to basetime
HINT(7,J) - pulse pile-up correction flag, 0/1 = disable/enable
HINT(8,J) - fit weighting flag, 1/2/3/4 = stat/none/instr/yfit
HINT(9,J) - function used (1=1POWER; 2=1THERMAL; 3=1GAUSS; 4=G+P;
5=G+T; 6=2G; 7=3G; 8=POLY; 9=2POW; 10=2THERM; 11=T+POW;
12=1EXP; 13=2EXP; 14=DPOW; 15=G+EXP; 16=M(G+T; 17=T+DPOW;
18=VTHERM; 19=2VTH; 20=VTH+POW; 21=VTH+DP; 22=G+VTH; 23=BPOW)
HINT(10,J) - number of fit parameters
HINT(11,J) - 9 element array of spares
DAY = ASCII string of day of start of data in form YY/MM/DD
DSEC = Number of seconds since 79/1/1, 0000 to the start of the day on
which the data starts (double precision)
OPTIONAL OUTPUT PARAMETERS:
None.
KEYWORDS:
ERROR - =1 if an error occurred, 0 otherwise
CALLS: ***
ATIME [1], ATIME [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
CONV_VAX_UNIX, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], OS_FAMILY, concat_dir [4]
curdir [1], curdir [2]
CALLED BY:
GETSUM, HXR_SPEC, Sumf2str
COMMON BLOCKS:
None
SIDE EFFECTS:
None.
RESTRICTIONS:
None.
PROCEDURE:
Read the summary file specified in the string array FILEARRAY
corresponding to the value in the pointer NPNTR. Extract header
and data information from the file and store it in the argument
arrays. Summary files have the data interval J stored in record J
(offset by 2 for 2 header records). i.e., even if intervals
1-10 were not analyzed, interval 11 is in record 11(+2). The arrays
returned by READSUM, on the other hand, have the first interval
analyzed in the first slot in the RINT and HINT arrays, so interval
11 information would be in RINT(i,0) and HINT(i,0). The interval number
is one of the pieces of information in the HINT array.
MODIFICATION HISTORY:
S. Kennard 8 JULY 1988
D. Zarro (ARC) 28 OCT 1988
S. Kennard 23 FEB 1990
S. Kennard 8 MAY 1990
Add pile-up flag, fit weighting flag, best fit function number, and
number of fit parameters. Add 9 spares to both real and integer data
arrays.
S. Kennard 26 JUNE 1990
Modified to run either using summary file names stored in an array
generated by Rinitsum or Finitsum, or it can be called by Readsumname
which prompts the operator for a summary file name and passes it
through the argument list. If the filename is included in the argument
list, Readsum reads that file. If the filename argument is not included,
Readsum reads from the filename array.
D. Zarro (ARC) 5 MARCH 1991
Converted to version 2
K. Tolbert 11 March 1991
Changed way of computing DAY and DSEC to return in calling arguments.
Version 10, RAS, 19-may-1997, support unix, too!
Mod. 05/97 by RCJ to open file as /stream and fix problem related to
conv_vax_unix.
[Previous]
[Next]
NAME:
reformat
PURPOSE:
reformat XRP data from tape (or file on disk)
CALLING SEQUENCE:
reformat
INPUTS:
prompts for tape logical name
OUTPUTS:
BDA, FDA, and FIS files
KEYWORDS:
file : reformat from file instead of tape [def = DMPFL1.DAT]
CALLED BY:
go_get_sirius, yoyo_man2
PROCEDURE:
- lots of VMS spawning
- packed reformatted data is read from tape into file DMPFL1.DAT
(for historical reasons).
- BCS data unpacked into BDA file
- FCS data unpacked into FDA and FIS files
CALLS: ***
REDUCE_MAIN, WRITE_CLOSED
RESTRICTIONS:
VMS only
MODIFICATION HISTORY:
Written DMZ (ARC) May'93
[Previous]
[Next]
NAME:
RESET_XY
PURPOSE:
This procedure resets saved !x, !y, and !p values to enable active switching
and overplotting between graphics windows.
CATEGORY:
GRAPHICS
CALLING SEQUENCE:
RESET_XY, Winsav
or
RESET_XY, Bang_x, Bang_y, P_clip
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
INPUTS:
Winsav: a structure with tags {winsav, x:!x, y:!y, clip:!p.clip}
or
Bang_x: Saved !x
Bang_y: Saved !y
P_clip: Saved !p.clip
OPTIONAL INPUTS:
none
OUTPUTS:
none explicit, only through commons;
OPTIONAL OUTPUTS:
none
KEYWORDS:
none
CALLED BY:
SPEX_THISTORY [1], SPEX_THISTORY [2], spex_spec_plot [1], spex_spec_plot [2]
spex_spec_plot [3], spex_spec_plot [4]
COMMON BLOCKS:
none
SIDE EFFECTS:
The system variables controlling plotting are changed.
RESTRICTIONS:
none
PROCEDURE:
The values are used to construct a plot with /nodata to reset
all the needed system variable elements.
MODIFICATION HISTORY:
RAS, 12-april-1996
[Previous]
[Next]
NAME:
rost
PURPOSE:
rotate image contained within structure created by ST_IMG
CATEGORY:
utility
CALLING SEQUENCE:
rimg=rost(img,angle,xc,yc)
INPUTS:
img = input image structure
angle = angle in degrees (+ for clockwise)
OPTIONAL INPUTS:
xc,yc = center of rotation [def = center of image]
OUTPUTS:
rimg= rotated output structure
CALLS: ***
RUST
PROCEDURE:
uses simple rotation of coordinate arrays for IMG
MODIFICATION HISTORY:
written Aug 1991 (DMZ, ARC)
[Previous]
[Next]
NAME:
RUNFLARES
PURPOSE:
This file is the IDL_STARTUP file for the FLARES procedure. It allows
the IDL routine FLARES to be run from DCL. The command procedure
runflares gets into IDL with this startup file, FLARES is called, user
is asked for input, then when user chooses to QUIT, will exit out of IDL.
FLARES displays flare file locations on the optical disks.
K.T. 7/7/93
CATEGORY:
HXRBS
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:
K.T. 7/7/93
[Previous]
[Next]
NAME:
RUST
PURPOSE:
read and unpack data and pixel coordinate arrays for image
saved in a structure variable created by RDFIS
CATEGORY:
utility
CALLING SEQUENCE:
rust,img,data,xp,yp
INPUTS:
img = image structure
OUTPUTS:
data = 2d image array
xp = cartesian coordinates of image pixels in x-direction (+ W)
yp = cartesian coordinates of image pixels in y-direction (+ N)
OPTIONAL OUTPUTS:
dx,dy = mean spacing between pixels
xc,yc = mean center of image
CALLED BY:
FCS, FTEMAP, PLOTMAP, bust, coreg, drot, rost, st_merge
PROCEDURE:
simple
MODIFICATION HISTORY:
written DMZ (ARC) Aug'91