summaryrefslogtreecommitdiff
path: root/updatewcs/det2im.py
diff options
context:
space:
mode:
authordencheva <dencheva@stsci.edu>2010-09-30 15:07:47 -0400
committerdencheva <dencheva@stsci.edu>2010-09-30 15:07:47 -0400
commit02ba60cfb8db0288977724ebe73a13ee68544c31 (patch)
tree0bc705ff56e531f8acb15da60a11c95a86fc0e82 /updatewcs/det2im.py
parent9011189f4969aa74150abe493bf4b22886f7c372 (diff)
downloadstwcs_hcf-02ba60cfb8db0288977724ebe73a13ee68544c31.tar.gz
Added documentaion
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10441 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'updatewcs/det2im.py')
-rw-r--r--updatewcs/det2im.py16
1 files changed, 10 insertions, 6 deletions
diff --git a/updatewcs/det2im.py b/updatewcs/det2im.py
index c9837c9..993ec52 100644
--- a/updatewcs/det2im.py
+++ b/updatewcs/det2im.py
@@ -7,12 +7,16 @@ import utils
class DET2IMCorr(object):
def updateWCS(cls, fobj):
"""
- :Parameters:
- `fobj`: pyfits object
- Science file, for which a detector to image correction
- is available
- Uses a kw 'D2IMFILE' in the primary header to create an extension with
- a detector to image correction.
+ Parameters
+ ----------
+ fobj: pyfits object
+ Science file, for which a detector to image correction
+ is available
+
+ Notes
+ -----
+ Uses the file pointed to in the primary header keyword 'D2IMFILE'
+ to create an extension with a detector to image correction.
"""
assert isinstance(fobj, pyfits.HDUList)