summaryrefslogtreecommitdiff
path: root/lib/__init__.py
diff options
context:
space:
mode:
authordencheva <dencheva@stsci.edu>2010-10-11 15:39:31 -0400
committerdencheva <dencheva@stsci.edu>2010-10-11 15:39:31 -0400
commit7003ee7c9b62fc80b4dd593081ceb04925682867 (patch)
treebaeeb5e88679033073e7cf8c4fe05568b44a8181 /lib/__init__.py
parent5aff646c4ffbb860ef9e95e501b1725dd880abbd (diff)
downloadstwcs_hcf-7003ee7c9b62fc80b4dd593081ceb04925682867.tar.gz
More docs
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10521 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'lib/__init__.py')
-rw-r--r--lib/__init__.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/__init__.py b/lib/__init__.py
index ebd45ef..0728a1c 100644
--- a/lib/__init__.py
+++ b/lib/__init__.py
@@ -1,3 +1,14 @@
+""" STWCS
+
+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.
+
+"""
from __future__ import division # confidence high
#import all needed modules here to avoid relative imports