blob: d9d21c566054f215e5156a480a7db7e6ab4a1d5b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
from __future__ import absolute_import, print_function
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)
|