aboutsummaryrefslogtreecommitdiff
path: root/vo/votools/doc/wcsinfo.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /vo/votools/doc/wcsinfo.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'vo/votools/doc/wcsinfo.hlp')
-rw-r--r--vo/votools/doc/wcsinfo.hlp77
1 files changed, 77 insertions, 0 deletions
diff --git a/vo/votools/doc/wcsinfo.hlp b/vo/votools/doc/wcsinfo.hlp
new file mode 100644
index 00000000..a387bf4c
--- /dev/null
+++ b/vo/votools/doc/wcsinfo.hlp
@@ -0,0 +1,77 @@
+.help wcsinfo Mar12 votools
+.ih
+NAME
+wcsinfo -- Determine the WCS information of an image
+.ih
+USAGE
+wcsinfo image
+.ih
+PARAMETERS
+.ls image
+The input image name.
+.le
+.ls verbose = no
+Print verbose output?
+.le
+
+.ls OUTPUT PARAMETERS
+After reading the image, the following task parameters are updated with
+the values derived from the input image:
+
+.nf
+ (pos = "") POS string
+ (size = 0.) SIZE value
+ (ra = 0.) RA value
+ (dec = 0.) DEC value
+ (llx = 0.) LLX wcs corner
+ (lly = 0.) LLY wcs corner
+ (urx = 0.) URX wcs corner
+ (ury = 0.) URY wcs corner
+ (midx = 0.) X wcs midpoint
+ (midy = 0.) Y wcs midpoint
+ (scale = 0.) Scale ("/pix)
+ (rot = 0.) Rotation (deg)
+ (width = 0.) Plt width (arcmin)
+ (height = 0.) Plt height (arcmin)
+ (axmap = "") Axis mapping
+ (epoch = 0.) Epoch
+ (equinox = 0.) Equinox
+ (ctype1 = "") CTYPE1
+ (ctype2 = "") CTYPE2
+ (crval1 = 0.) CRVAL1
+ (crval2 = 0.) CRVAL2
+ (crpix1 = 0.) CRPIX1
+ (crpix2 = 0.) CRPIX2
+ (cd11 = 0.) CD1_1
+ (cd12 = 0.) CD1_2
+ (cd21 = 0.) CD2_1
+ (cd22 = 0.) CD2_2
+ (ispix = no) Pixel only coords?
+.fi
+
+.ih
+DESCRIPTION
+
+The \fIWCSINFO\fR task is used to determine the WCS information in an image
+in ways which make it easy for script developers to use specific values
+easily (e.g. the plate center, scale, size, corners, etc). Images of
+arbitrary axis mapping and rotation can be used. If no WCS information
+can be found in the image, the \fIispix\fR parameter will be set to
+'yes'.
+
+
+.ih
+EXAMPLES
+1. Summarize the WCS information about the dev$ypix test image:
+
+.nf
+ votools> wcsinfo dev$ypix
+.fi
+
+.ih
+REVISIONS
+.
+.ih
+SEE ALSO
+getcat, getimg
+.endhelp