summaryrefslogtreecommitdiff
path: root/updatewcs/__init__.py
diff options
context:
space:
mode:
authordencheva <dencheva@stsci.edu>2009-12-22 16:29:46 -0500
committerdencheva <dencheva@stsci.edu>2009-12-22 16:29:46 -0500
commit307590776e2b8f3ca052c7450c6396b304b4c89a (patch)
tree9432414a32ce648ce32cc298c054b7aab31db4ed /updatewcs/__init__.py
parent86e6ddc7aeb483fa9dd1cce4b052fe8e9ad86695 (diff)
downloadstwcs_hcf-307590776e2b8f3ca052c7450c6396b304b4c89a.tar.gz
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
Diffstat (limited to 'updatewcs/__init__.py')
-rw-r--r--updatewcs/__init__.py21
1 files changed, 20 insertions, 1 deletions
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