summaryrefslogtreecommitdiff
path: root/updatewcs/det2im.py
diff options
context:
space:
mode:
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)