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/index.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/index.rst')
| -rw-r--r-- | doc/source/index.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index a7bacd1..f108683 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,10 +6,22 @@ Welcome to STWCS's documentation! ================================= +This package provides support for WCS based distortion models and coordinate +transformation. It relies on PyWCS (based on WCSLIB). It consists of two subpackages: +UPDATEWCS and WCSUTIL. UPDATEWCS performs corrections to the basic WCS and includes +other distortion infomation in the science files as header keywords or file extensions. +WCSUTIL provides an HSTWCS object which extends pywcs.WCS object and provides HST instrument +specific information as well as methods for coordinate tarnsformaiton. WCSUTIL also provides +functions for manipulating alternate WCS descriptions in the headers. + Contents: .. toctree:: :maxdepth: 2 + + wcsutil + updatewcs + Indices and tables ================== |