diff options
Diffstat (limited to 'stwcs/wcsutil/__init__.py')
| -rw-r--r-- | stwcs/wcsutil/__init__.py | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/stwcs/wcsutil/__init__.py b/stwcs/wcsutil/__init__.py new file mode 100644 index 0000000..65280be --- /dev/null +++ b/stwcs/wcsutil/__init__.py @@ -0,0 +1,34 @@ +from __future__ import absolute_import, print_function # confidence high + +from .altwcs import * +from .hstwcs import HSTWCS + + +def help(): + doc = """ \ + 1. Using a `astropy.io.fits.HDUList` object and an extension number \n + Example:\n + from astropy.io improt fits + fobj = fits.open('some_file.fits')\n + w = wcsutil.HSTWCS(fobj, 3)\n\n + + 2. Create an HSTWCS object using a qualified file name. \n + Example:\n + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits[sci,1]')\n\n + + 3. Create an HSTWCS object using a file name and an extension number. \n + Example:\n + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2)\n\n + + 4. Create an HSTWCS object from WCS with key 'O'.\n + Example:\n + + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2, wcskey='O')\n\n + + 5. Create a template HSTWCS object for a DEFAULT object.\n + Example:\n + w = wcsutil.HSTWCS(instrument='DEFAULT')\n\n + """ + + print('How to create an HSTWCS object:\n\n') + print(doc) |