STScI Logo

scatterv stsdas.hst_calib.hsp


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

NAME

scatterv -- Tabulate scattered flux as a function of angular distance from a point source.

USAGE

scatterv intable outtable ref_obs_id

DESCRIPTION

This task examines the scattered light effect caused by a point source; scatterv tabulates observed flux against the angular distance from the source. The input data set must contain an observation toward the point source itself---referred to as the "reference observation". The ID of the reference observation must be specified by the user with the ref_obs_id parameter. Angular distances from the point source are calculated from the right ascension and declination of the aperture.

The maximum number of input data points is 1,000.

PARAMETERS

intable [file name]
Name of the input table; this table must have the following columns:

(obsid_key)     Observed ID (char*10).  The actual column name  
		is passed from the 'obsid_key' parameter.
(count_key)     Observed count rate (real). The actual column
                name is passed from the 'count_key' parameter.
(counterr_key)  Standard deviation of observed count rate 
		(real). The actual column name is passed 
		from the 'dcount_key' parameter.
(ra_key)        Predicted right ascension in decimal degrees
		(double).  The actual column name is passed 
		from the 'ra_key' parameter.
(dec_key)       Predicted declination in decimal degrees 
		(double). The actual column name is passed 
		from the 'dec_key' parameter (double).
(temp_key)      Temperature (real).  The actual column name 
		is passed from the 'temp_key' parameter.
'EPOCH'         Epoch of observation (double).
'TRGTNAME'      Target name (char*20).
'APERTOBJ'      Object aperture name (char*10).
outtable [file name]
Name of the output table produced by scatterv; this table will have the following columns:

'APER_NAME'     Aperture name (char*10).
'ANGULAR_DIST'  Angular distance from the target---in degrees
                (double).
'POSITION_ANG'  Position angle relative to the target---in degrees
                (real).
'FLUX_RATIO'    Ratio between the observed flux and the flux
                of the target in the reference observation (real).
'RATIO_ERR'     Uncertainty of 'FLUX_RATIO' (real).
'TEMPERATURE'   Temperature, as specified in the 'temp_key'
		parameter (real).
'EPOCH'         Epoch of observation (double).
'TRGTNAME'      Target name (char*20).
ref_obs_id = [string]
Reference observation ID (i.e., ID of the direct observation of the target).
(obsid_key) = "ROOTNAME" [string]
Column name of the observation ID in the input table.
(count_key) = "DOBJ" [string, allowed values = DOBJ | AOBJ |
DSKY | ASKT]

Column name of the count rate in the input table.

(counterr_key) = "DOBJ_ERR" [string]
Column name in intable containing the count rate's standard deviation.
(ra_key) = "RA_APER" [string]
Column name of the predicted right ascension in input table.
(dec_key) = "DEC_APER" [string]
Column name of the predicted declination in input table.
(temp_key) = "DET_TEMP" [string]
Column name of the temperature in input table.

EXAMPLES

1. Tabulate the scattered light effect from the input data table xscatterv$input1 and put results in the output table yscatterv$output. The observation ID of the target itself is VSCATT1. Use default values for all hidden parameters.

hs> scatterv "xscatterv$input1" "yscatterv$output" "VSCATT1"

BUGS

REFERENCES

SEE ALSO


Source Code · Package Help · Search Form · STSDAS