From 307590776e2b8f3ca052c7450c6396b304b4c89a Mon Sep 17 00:00:00 2001 From: dencheva Date: Tue, 22 Dec 2009 21:29:46 +0000 Subject: Comments and minor corrections git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@8515 fe389314-cf27-0410-b35b-8c050e845b92 --- updatewcs/__init__.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'updatewcs/__init__.py') diff --git a/updatewcs/__init__.py b/updatewcs/__init__.py index a2d0690..71987e7 100644 --- a/updatewcs/__init__.py +++ b/updatewcs/__init__.py @@ -18,7 +18,13 @@ def updatewcs(input, vacorr=True, tddcorr=True, dgeocorr=True, checkfiles=True, """ Purpose ======= - Applies corrections to the WCS keywords. + 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. + Example ======= @@ -192,3 +198,16 @@ def checkFiles(input): return newfiles + +def getCorrections(instrument): + """ + Print corrections available for an instrument + + :Parameters: + `instrument`: string, one of 'WFPC2', 'NICMOS', 'STIS', 'ACS', 'WFC3' + """ + acorr = apply_corrections.allowed_corrections[instrument] + + print "The following corrections will be performed for instrument %s\n" % instrument + for c in acorr: print c,': ' , apply_corrections.cnames[c] + \ No newline at end of file -- cgit