summaryrefslogtreecommitdiff
path: root/lib/stwcs/gui/apply_headerlet.help
diff options
context:
space:
mode:
authorNadia Dencheva <nadia.astropy@gmail.com>2016-08-07 12:23:24 -0400
committerGitHub <noreply@github.com>2016-08-07 12:23:24 -0400
commita2e16e39b0eb8ac0251a6473c60fee0d437c3a5f (patch)
tree7b6771e9c1974852eb8a283507677651078ce32a /lib/stwcs/gui/apply_headerlet.help
parent86d1bc5a77491770d45b86e5cf18b79ded68fb9b (diff)
parent2dc0676bc00f66a87737e78484876051633b731a (diff)
downloadstwcs_hcf-a2e16e39b0eb8ac0251a6473c60fee0d437c3a5f.tar.gz
Merge pull request #9 from nden/refactor-and-tests
restructure and add stwcs tests
Diffstat (limited to 'lib/stwcs/gui/apply_headerlet.help')
-rw-r--r--lib/stwcs/gui/apply_headerlet.help38
1 files changed, 0 insertions, 38 deletions
diff --git a/lib/stwcs/gui/apply_headerlet.help b/lib/stwcs/gui/apply_headerlet.help
deleted file mode 100644
index f701b52..0000000
--- a/lib/stwcs/gui/apply_headerlet.help
+++ /dev/null
@@ -1,38 +0,0 @@
-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 or wild-card name
- File name(s) of science observation whose WCS solution will be updated
-hdrlet: string, @-file or wild-card name
- Headerlet file(s), must match input filenames 1-to-1
-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.
-logging: boolean
- enable file logging