diff options
| author | hack <hack@stsci.edu> | 2011-10-25 17:25:35 -0400 |
|---|---|---|
| committer | hack <hack@stsci.edu> | 2011-10-25 17:25:35 -0400 |
| commit | b5f4204747f7e4105049713b40d7bca0fae052e5 (patch) | |
| tree | 8a2bd7713049a348ea3d955c646ccf1a7c4b7815 /lib/stwcs/gui/apply_headerlet.help | |
| parent | c68d6121a6847327df30ece3d90d8cfe0919367b (diff) | |
| download | stwcs_hcf-b5f4204747f7e4105049713b40d7bca0fae052e5.tar.gz | |
Merging changes from 'stwcs_hdrlet' branch (r18787 - r13909) into trunk. This version of STWCS (0.9.1) provides support for headerlets based on 'Headerlet Design' wiki document, and includes TEAL interfaces for all public headerlet functions. It also moves the TEAL interface for 'updatewcs' from 'astrodither' to this package. The TEAL interaces have been included as a new 'gui' sub-package in order to keep them separate from the remainder of the package's functionality.
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@13910 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'lib/stwcs/gui/apply_headerlet.help')
| -rw-r--r-- | lib/stwcs/gui/apply_headerlet.help | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/stwcs/gui/apply_headerlet.help b/lib/stwcs/gui/apply_headerlet.help new file mode 100644 index 0000000..2ddb2e4 --- /dev/null +++ b/lib/stwcs/gui/apply_headerlet.help @@ -0,0 +1,40 @@ +This task applies a headerlet to a science observation to update either the +PRIMARY WCS or to add it as an alternate WCS. + +filename = "" +hdrlet = "" +attach = True +primary = True +archive = True +force = False +wcskey = "" +wcsname = "" +verbose = False + +Parameters +---------- +filename: string + File name of science observation whose WCS solution will be updated +hdrlet: string + Headerlet file +attach: boolean + True (default): append headerlet to FITS file as a new extension. +primary: boolean + Specify whether or not to replace PRIMARY WCS with WCS from headerlet. +archive: boolean + True (default): before updating, create a headerlet with the + WCS old solution. +force: boolean + If True, this will cause the headerlet to replace the current PRIMARY + WCS even if it has a different distortion model. [Default: False] +wcskey: string + Key value (A-Z, except O) for this alternate WCS + If None, the next available key will be used +wcsname: string + Name to be assigned to this alternate WCS + WCSNAME is a required keyword in a Headerlet but this allows the + user to change it as desired. + +verbose: False or a python logging level + (one of 'INFO', 'DEBUG' logging levels) + (an integer representing a logging level) |