diff options
| author | dencheva <dencheva@stsci.edu> | 2010-09-30 15:06:39 -0400 |
|---|---|---|
| committer | dencheva <dencheva@stsci.edu> | 2010-09-30 15:06:39 -0400 |
| commit | 006537f7a7607130a2c6fa0eaedb8c62b7590101 (patch) | |
| tree | 3570cedc939c3fde9da13b6fa77e6bc1bd6ff743 /doc/source/hstwcs_ui.rst | |
| parent | fac076e7c94e199a684a6e606b4e7cc88116785c (diff) | |
| download | stwcs_hcf-006537f7a7607130a2c6fa0eaedb8c62b7590101.tar.gz | |
Adding documentation
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10439 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'doc/source/hstwcs_ui.rst')
| -rw-r--r-- | doc/source/hstwcs_ui.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/hstwcs_ui.rst b/doc/source/hstwcs_ui.rst new file mode 100644 index 0000000..7a09af4 --- /dev/null +++ b/doc/source/hstwcs_ui.rst @@ -0,0 +1,26 @@ +.. _hstwcs_ui: + +************************************** +HSTWCS UI Examples +************************************** +- Create an HSTWCS object using a pyfits HDUList and an extension number + + fobj = pyfits.open('some_file.fits') + + w = wcsutil.HSTWCS(fobj, 3) + +- Create an HSTWCS object using a qualified file name. + + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits[sci,1]') + +- Create an HSTWCS object using a file name and an extension number. + + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2) + +- Create an HSTWCS object from WCS with key 'O'. + + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2, wcskey='O') + +- Create a template HSTWCS object for a DEFAULT object. + + w = wcsutil.HSTWCS(instrument='DEFAULT')
\ No newline at end of file |