Previous topic

UPDATEWCS

Next topic

WCS Corrections

This Page

UPDATEWCS - User Interface

stwcs.updatewcs.updatewcs(input, vacorr=True, tddcorr=True, npolcorr=True, d2imcorr=True, checkfiles=True, wcskey=' ', wcsname=' ', clobber=False, verbose=False)

Updates HST science files with the best available calibration information. This allows users to retrieve from the archive self contained science files which do not require additional reference files.

Basic WCS keywords are updated in the process and new keywords (following WCS Paper IV and the SIP convention) as well as new extensions are added to the science files.

Parameters :
 

input: a python list of file names or a string (wild card characters allowed) :

input files may be in fits, geis or waiver fits format

vacorr: boolean :

If True, vecocity aberration correction will be applied

tddcorr: boolean :

If True, time dependent distortion correction will be applied

npolcorr: boolean :

If True, a Lookup table distortion will be applied

d2imcorr: boolean :

If True, detector to image correction will be applied

checkfiles: boolean :

If True, the format of the input files will be checked, geis and waiver fits files will be converted to MEF format. Default value is True for standalone mode.

wcskey: None, one character string A-Z or an empty string of length 1 :

If None - the primary WCS is not archived If an empty string - the next available wcskey is used for the archive A-Z - use this key to archive the WCS

wcsname: a string :

The name under which the primary WCS is archived after it is updated. If an empty string (default), the name of the idctable is used as a base.

clobber: boolean :

a flag for reusing the wcskey when archiving the primary WCS