[Previous]
[Next]
NAME:
HER_COR_STR
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:
[Previous]
[Next]
NAME:
HER_STR
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:
[Previous]
[Next]
Project: SDAC
Name: HKG_DBASE
PURPOSE: extract BATSE SPEC parameters from housekeeping data in batse fdb files.
CATEGORY: BATSE
CALLING SEQUENCE: hkg_dbase, flare
CALLED BY:
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CHKLOG [1], CHKLOG [2]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], HKG_MODULE, LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], READ_FLARE, SETUP_BATSE_ARRAYS, break_file [4]
concat_dir [4], curdir [1], curdir [2], file_list [1], file_list [2], read_dd
strsplit
INPUTS:
nflares - extract new housekeeping for this number of flares
OPTIONAL INPUTS:
none
OUTPUTS:
none explicit, only through commons;
OPTIONAL OUTPUTS:
none
COMMON BLOCKS:
none
SIDE EFFECTS:
The file, perm_data:spec_hsk.txt is opened and updated with the data for each event.
RESTRICTIONS:
runs only on SDAC
PROCEDURE:
The data is extracted from each fdb file sequentially.
MODIFICATION HISTORY:
ras, 18-nov-1995
Version 2, RAS, 25-Jul-1997, changed PERM_DATA to SSWDB_BATSE
[Previous]
[Next]
Project: SDAC
Name: HKG_MODULE
PURPOSE: extract BATSE parameters from module housekeeping data.
CATEGORY: BATSE
CALLING SEQUENCE: out = hkg_module( hkgmod, hseq, sequence_number )
CALLED BY:
CALLS:
INPUTS:
Hkgmod - hkgmod extracted from fdb, bdb, and hkg files using read_dd.
i.e. read_dd, ut, rates, housekeeping, HKGMOD=HKGMOD
Hseq - Housekeeping sequence numbers. Synched with HKGMOD from read_dd.
Sequence_number - sequence number, selects type of data read
Found in Table 2.3-3 on page 13 of BATSE Flight Software Users Manual
Some important ones:
Seq No. Mnemonic Function
4 HV5VLTm Spectroscopy PMT's High Voltage
23 PBPTMPm PMT baseplate temperature
OPTIONAL KEYWORD INPUTS:
hkgmtb - if the HouseKeepingModuleTaBle is input, the slld values are returned.
See page 54 of the BATSE Flight Software Users Manual.
While the L/A LLD is listed as byte 6, and the SLLD byte 7, we're using byte 7 since
the data is encoded as integers on a vms machine. This is a bit dangerous but is expected
to continue to work through the mission.
OUTPUTS:
Returns 8 integer values, one for each detector.
OPTIONAL OUTPUTS:
none
CALLED BY:
EDGES_HVSPEC, HKG_DBASE
COMMON BLOCKS:
none
SIDE EFFECTS:
none.
RESTRICTIONS:
none.
PROCEDURE:
The sequence number is used to decommutate the tabular data.
MODIFICATION HISTORY:
Version 1, Richard.Schwartz@gsfc.nasa.gov, 30-mar-1998.
[Previous]
[Next]
NAME: HKG_STR
PURPOSE: Returns the BATSE housekeeping structure subset
CATEGORY: ephemeris
KEYWORDS:
/FULL - FULL BLOWN HKG STRUCTURE
/MSFC - FULL MSFC HKG STRUCTURE, Abbreviated tags
/COMPACT - COMPACT SDAC HKG STRUCTURE
CALLS: ***
CHECKVAR [1], checkvar [2]
CALLED BY:
READ_OCC_DISCSP, xzchange
MODIFICATION HISTORY:
ras, 19-sep-1996
[Previous]
[Next]
NAME:
HORIZONANGLE
PURPOSE:
Compute the Xray tangent angle as a function of spacecraft altitude
CATEGORY:
MATH, EPHEMERIS, BATSE
CALLING SEQUENCE:
Result = HORIZONANGLE( Sc_rad)
INPUTS:
Sc_rad - the spacecraft radius in km measured from the center of the Earth
OUTPUTS:
The result is the tangle angle for that spacecraft radius.
CALLED BY:
OCCTIME
PROCEDURE:
The horizon angle is the angle formed by the Earth-Spacecraft-Source directions
when the source is just visible in hard X-rays above the horizon.
EXAMPLE:
hangle = HORIZONANGLE( Sc_rad)
MODIFICATION HISTORY:
Version 2, ras, 29-mar-1995 Documented
[Previous]
[Next]
PROJECT:
SDAC
NAME:
HV_FILE
PURPOSE:
HV_FILE creates and updates a file containing all time intervals when
the BATSE high voltage was off. Used with the gap file and the day/night
file, this info gives the BATSE solar observing times.
CATEGORY:
BATSE
CALLING SEQUENCE:
hv_file, endday
CALLS: ***
ATIME [1], ATIME [2], CONV_VAX_UNIX, HV_FINDER, LOC_FILE [1], LOC_FILE [2]
LOC_FILE [3], USE_VAX_FLOAT, UTIME [1], UTIME [2]
INPUTS:
endday- Time to process to. Interpreted by Utime (anytim).
OPTIONAL INPUTS:
none
OUTPUTS:
none explicit, only through commons;
OPTIONAL OUTPUTS:
none
KEYWORDS:
none
COMMON BLOCKS:
none
SIDE EFFECTS:
none
RESTRICTIONS:
This is an SDAC database maintenance procedure and not
intended for general use. VMS specific.
PROCEDURE:
The hv file has the following format:
header record - bytes 0-7: latest time in seconds since 79/1/1,0
bytes 8-11: spare
bytes 12-15: number of data records following header
data records - bytes 0-7: start time of hv off interval
bytes 8-15: end time of hv off interval
HV_FILE reads the header record to determine start time, then opens
each quality DB file from that day up to and including the end day specified
in the calling argument, recording time intervals for which the high voltage
is off.
This hv file must be updated in time order.
Can be killed anytime, and the good intervals from the last quality file
it finished will be recorded (after each quality file, it writes the hv off
intervals, and rewrites the header record).
MODIFICATION HISTORY:
Kim Tolbert 5/20/92
AES 12/17/96 Write hv_file.dat in stream mode. Fixed for unix.
Version 3, richard.schwartz@gsfc.nasa.gov, 24-jun-1998, forced old VAX float format on write.
[Previous]
[Next]
NAME:
HV_FINDER
PURPOSE:
Determine time ranges when BATSE high voltage was off.
CATEGORY:
BATSE
CALLING SEQUENCE:
HV_FINDER, time, offtimes, count
CALLS: ***
ATIME [1], ATIME [2], READQUAL, STR_SEP, YMD2TJD
INPUTS:
time: Date for which one wants to determine when high
voltage was off. String compatible with anytim.
OUTPUTS:
offtimes: Time ranges when high voltage was off (in sec since 79/1/1).
count: Number of time intervals when high voltage was off.
CALLED BY:
HV_FILE
PROCEDURE:
Read quality file using readqual, search and retrieve lines where the
first column element is '50' (indicates high voltage is off), print
only time ranges from requested date.
MODIFICATION HISTORY:
Written by Kim Tolbert 05/20/92.
Mod. by RCJ 12/26/96 to reject data from day before requested and
substitute call to strmid for something more robust.
Also revise documentation.