STScI Logo

calhsp stsdas.hst_calib.hsp


NAME · USAGE · DESCRIPTION · PARAMETERS · EXAMPLES · BUGS · REFERENCES
SEE_ALSO

NAME

calhsp -- Perform pipeline calibration corrections for HSP data files.

USAGE

calhsp inroot outroot

DESCRIPTION

This task calculates the following High Speed Photometer (HSP) calibration factors: (1) dark signal, (2) pre-amplifier noise, (3) high voltage factor, (4) cathode efficiency, (5) gain factor, (6) current-to-voltage converter (CVC) offset, and (7) dead time. The first six factors are third-order polynomial functions of temperature and epoch. This task reads these polynomial coefficients from each of the calibration tables and evaluates the corrections according to the time and temperature at the observation. The last factor (dead time) is a function of detector ID, pulse discriminator threshold setting, detector temperature (linear dependency), and high voltage setting.

PARAMETERS

inroot [string]
Root name of the input files. Input files include the Standard Header Packet (SHP) file (root name plus the extension .shh), the Unique Data Log (UDL) file (extension .ulh), the data files (extension .d0h, .d1h, etc.), and the corresponding data quality mask files (extension .q0h, .q1h, etc.). This task copies the .dXh or .dXd file(s) to .cXh or .cXd files in the same directory, so make sure you have write privileges in the directory containing these files. The data file header (of both the area scan file and the non-area scan files) should contain the following keywords and group parameters:

(keywords)

'ROOTNAME'	Observation ID (char*10).
'DATA_TYP'	Data type (char*8).
'DATA_SRC'	Data source (char*4).
'SAMPTIME'	Sample time (real).

(group parameters)

'FPKTTIME'	First packet time (char*24).
'LPKTTIME'	Last packet time (char*24).

Non-area scan files should also have the following keywords:

(science file)

'PTSRCFLG'      Point source flag (point or extended) (char*1).
'DET_CHR'	Detector characteristics switch (char*8).
'DEADTIME'	Dead time switch (char*8).
'TRUE_CNT'	True count rate switch (char*8).
'TRUE_PHC'	True photocurrent switch (char*8).
'DETECTOR'	Detector of the current file (int).
'APERTURE'      Aperture name of the current file (char*10).
'APERAREA'	Aperture area (in square arc seconds) (real).
'BUNIT'		Unit of the data (e.g., counts/seconds) (char*16).
'DARKRATE'	Scaled dark rate (real).
'PRE_AMP'	Scaled pre-amp contribution (real).
'HIGHVOLT'	Scaled high voltage factor (real).
'TUBEGAIN'      Scaled gain factor (real).
'CVCOFSET'      Scaled CVC offset (real).
'PT_EFFIC'	Scaled point source cathode efficiency (real).
'EX_EFFIC'	Scaled extended source cathode efficiency (real).
'DEADTM'      	Dead time (real).

(SHP file)

'VTPDEAi'      	DEA temperature ("i" is an integer between 1 
		and 5) (real).
'VTPDETi'      	Detector temperature ("i" is an integer between
		1 and 5) (real).

(UDL file)

'VGAINDi'       Gain setting ("i" is an integer between 1 
		and 5) (real).
'VHIVOLTi'      High voltage setting ("i" is an integer between
		1 and 5) (real).
'VPADTHR'       Discriminator threshold setting ("i" is an
		integer between 1 and 5) (real).
Calibration table names must be in the science file header, they are:

CCP0 - Name of the aperture size table, which has the following columns:

'APER_NAME'     The "regular" aperture name (char*10).
'APER_SIZE'     Area of aperture in square arc seconds (real).

CCP1 - High voltage factor calibration table, which has the following columns:

'DET_NUM'       Detector ID (int).
'TYPE'          Data type (char*7).
'VOLTAGE'       High voltage setting (real).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE'    Base value of the calibration (real).

CCP2 - Gain factor calibration table, which has the following columns:

'DET_NUM'       Detector ID (int).
'VGAIND'        Gain setting (real).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE'    Base value of the calibration (real).

CCP3 - Pre-amplifier noise calibration table, which has the following columns:

'DET_NUM'       Detector ID (int).
'TYPE'          Data type (char*7).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE'    Base value of the calibration (real).

CCP4 - Relative sensitivity calibration table, which has the following columns:

'APER_NAME'     Aperture name (char*10).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE_P'  Base value of the point source relative 
                sensitivity (real).
'BASE_VALUE_E'  Base value of the extended source relative 
                sensitivity (real).

CCP5 - Dark signal calibration table, which has the following columns:

'APER_NAME'     Aperture name (char*10).
'TYPE'          Data type (char*7).
'VOLTAGE'       High voltage setting (real).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE'    Base value of the calibration (real).

CCP7 - CVC offset calibration table, which has the following columns:

'DET_NUM'       Detector ID (int).
'VGAIND'        Gain setting (real).
'A00', 'A01', ..., 'A33'
                Calibration polynomial coefficients (real).
'BASE_TIME'     Reference epoch in modified Julian date (double).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).
'BASE_VALUE'    Base value of the calibration (real).

CCP8 - Dead time calibration table, which has the following columns:

'DET_NUM'       Detector ID (int).
'VOLTAGE'       High voltage setting (real).
'THRESH'        Pulse discriminator threshold setting (real).
'BASE_VALUE'    Base value of the calibration (real).
'A1'            Temperature dependent coefficient (real).
'BASE_TEMP'     Reference temperature in degrees Celsius (real).

CCP9 - Dark aperture translation table, which has the following columns:

'APER_NAME'     The "regular" aperture name (char*10).
'DARK_APER'     The "dark aperture" name (char*10).
outroot [string]
Root name of the output file(s).

EXAMPLES

1. Perform pipeline calibration corrections for input files with the root name yparthitv$v00ya103r. Output files have the same root name as input. (Don't forget the null second argument!)

  hs> calhsp "yparthitv$v00ya103r" ""

2. Perform pipeline calibration corrections for input files with the root name yparthitv$v00ya103r, and output file(s) (the .c* files) has a root name of test.

  hs> calhsp "yparthitv$v00ya103r" "test"

BUGS

REFERENCES

SEE ALSO


Source Code · Package Help · Search Form · STSDAS