summaryrefslogtreecommitdiff
path: root/lib/stwcs/gui/apply_headerlet.help
diff options
context:
space:
mode:
Diffstat (limited to 'lib/stwcs/gui/apply_headerlet.help')
-rw-r--r--lib/stwcs/gui/apply_headerlet.help40
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)