diff options
| author | dencheva <dencheva@stsci.edu> | 2010-09-30 15:07:33 -0400 |
|---|---|---|
| committer | dencheva <dencheva@stsci.edu> | 2010-09-30 15:07:33 -0400 |
| commit | 9011189f4969aa74150abe493bf4b22886f7c372 (patch) | |
| tree | aad401aa9c4160cc110f9ecbc316268627267f63 /wcsutil/altwcs.py | |
| parent | 006537f7a7607130a2c6fa0eaedb8c62b7590101 (diff) | |
| download | stwcs_hcf-9011189f4969aa74150abe493bf4b22886f7c372.tar.gz | |
Added documentaion
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10440 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'wcsutil/altwcs.py')
| -rw-r--r-- | wcsutil/altwcs.py | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/wcsutil/altwcs.py b/wcsutil/altwcs.py index 4cfb033..42a2d67 100644 --- a/wcsutil/altwcs.py +++ b/wcsutil/altwcs.py @@ -290,9 +290,11 @@ def wcskeys(header): def wcsnames(header): """ - Purpose - ======= - Return a dictionary of wcskey: WCSNAME pairs + Returns a dictionary of wcskey: WCSNAME pairs + + Parameters + ---------- + header: pyfits.Header """ names = header["WCSNAME*"] d = {} @@ -340,6 +342,12 @@ def getKeyFromName(header, wcsname): If WCSNAME is found in header, return its key, else return None. This is used to update an alternate WCS repeatedly and not generate new keys every time. + + Parameters + ---------- + header: pyfits.Header + wcsname: str + Value of WCSNAME """ wkey = None names = wcsnames(header) |