NAME

ahtrendtemp - Calculate the quartz clock frequency vs temperature relation for the on-board clock

USAGE

ahtrendtemp infile frqtemfile outtemp outfile

DESCRIPTION

'ahtrendtemp' calculates the quartz clock frequency vs. temperature relation using the in-flight data. The output of this task is used to monitor any deviation of the same relation derived from ground data and stored in CALDB. The input files are : a) the general HK file (see parameter 'infile', single or list of files are accepted), b) the CALDB clock frequency vs temperature file (see parameter 'frqtemfile'). The freq vs temperature is obtained by reading the frequencies corresponding to a temperature variation (see parameter 'tempresol') at a given time and averaging the frequencies in the delta temperature interval. The frequencies and the temperature are located in two separate extensions on the HK file and may be specified by the parameters 'quartzext' and 'tempext' respectively. The extension names for the GPS and Temperature as well as the column names depend on which on board computer , SMU (A or B), is disseminating the timing information. The timing information associated to the frequency and temperature are read for columns that may be specified in the parameters 'stimecol', 'l32ticol' and 'u32ticol'. The FITS output file (see parameter 'outfile') is created by cloning the format of the CALDB frequency vs temperature file and contains the following columns: TEMP (the clock temperature in Celsius), FREQ (the average frequency of the clock in Hz) and NPTTEMP (number of frequency points per temperature). 'ahtrendtemp' also outputs an ASCII temporary file (see parameter 'outtemp') where all frequencies (not averaged) and temperatures are written.

PARAMETERS

infile [filename]
Name of the general HK file that contains the quartz clock and temperature extensions. This file is named ahgen_a0.hk1. The task accepts either a string corresponding to a single FITS file or a string preceding by '@' corresponding to a text file containing a list of FITS file.

frqtemfile [filename]
Name of the calibration file containing the freq vs. temp relation. The parameter is set by default to CALDB.

outtemp [filename]
Name of the output file where all the frequencies , not averaged, and temperatures are written. This is an ASCII file.

outfile [filename]
Name of output file with the averaged frequencies and temperature are written. This is a FITS with the same format of the frqtempfile.

(starttime = ALL) [string]
Start time to start including data in the calculation. The time format should be entered as YYYY-MM-DDThh:mm:ss.

(stoptime = ALL) [string]
Stop time to stop including data in the calculation. The time format should be entered as YYYY-MM-DDThh:mm:ss.

(quartzext = HK_TIMNG) [string]
Name of extension in the general HK file (see 'infile') with the frequency information (quartz clock).
This is HK_SMU_A_DHFS_TI_MNG_block_get_ti_mng and HK_SMU_B_DHFS_TI_MNG_block_get_ti_mng for the SMUA and SMUB respectively. The default is for the SMUA.

(tempext = HK_HCE) [string]
Name of extension in the general HK file (see 'infile') with the temperature information. This is HK_SMU_A_AUX_HCE_HK2 and HK_SMU_B_AUX_HCE_HK3 for the SMUA and SMUB respectively. The default is for the SMUA.

(quartzcol = RAW_QUARTZ_CLOCK) [string]
Name of the column with frequency information (quartz clock count) in the frequency extension. This is SMU_A_DHFS_TI_MNG_TIM_TCAL_INF and SMU_B_DHFS_TI_MNG_TIM_TCAL_INF for the SMUA and SMUB respectively. The default is for the SMUA.

(l32ticol = L32TI) [string]
Name of the column with the L32TI times in the frequency extension.

(u32ticol = Quartz_U32TI) [string]
Name of the column with the U32TI times in the frequency extension. This is SMU_A_DHFS_TI_MNG_TIM_TCAL_TIME and SMU_B_DHFS_TI_MNG_TIM_TCAL_TIME for the SMUA and SMUB respectively. The default is for the SMUA.

(tempcol = TEMP_CALC) [string]
Name of the column containing quartz temperature in the temperature extension. This is HCE_A_SENS_SMU_A_TEMP_CAL or HCE_B_SENS_SMU_B_TEMP_CAL for SMUA or SMUB respectively.
The default is for the SMUA.

(stimecol = S_TIME) [string]
Name of the column containing the S_TIME times present in both frequency and temperature extensions.

(leapsecfile = REFDATA) [string]
Name of the input leap second file. If set to CALDB or REFDATA uses the leapsecond file in either CALDB or REFDATA area.

(tempresol = 1.0) [real]
Delta temperature, in unit of Celsius, over which the frequencies are averaged.

(stimemax = 500.) [real]
Maximum value of delta S_TIME where to search the temperature.

(averagemode = 1) [integer]
Mode to average frequencies. Support only 1) simple average

(buffer = -1) [integer]
Rows to buffer (-1=auto, 0=none, >0=numrows).

(clobber = no) [boolean]
Overwrites the existing output file if set to yes (yes/[no]).

(chatter = 1) [integer]
Chatter level for output. Set to 0 to suppress output, or to 1, 2, or 3 for increasing the chatter of the output.

(logfile = !DEFAULT) [string]
Log filename. If set to DEFAULT uses the name of the task and, if preceded by '!', overwrite the file if it exists. If set to NONE no log file is created.

(debug = no) [boolean]
Diagnostic output is printed out on the screen if set to yes (yes/[no]).

(history = yes) [boolean]
Records tool parameters in HISTORY ([yes]/no).

(mode = ql) [string ql|hl|q]
Mode to query the parameter file. Acceptable values include: 'ql' (query and learn/remember), 'hl' (hidden and learn/remember), 'q' (query but don't remember), 'h' (hidden).

EXAMPLES

1. Calculate the freq vs temperature using the HK file gen.hk and the CALDB file for the frequency vs temperature. The outputs are written in the FITS file freqtemp.caldb.out and in the ASCII file dat.out.

ahtrendtemp infile=gen.hk frqtemfile=CALDB outfile=freqtemp.caldb.out outtemp=dat.out

SEE ALSO

LAST MODIFIED

February 2, 2016