aboutsummaryrefslogtreecommitdiff
path: root/vo/votools/doc/taboverlay.hlp
diff options
context:
space:
mode:
Diffstat (limited to 'vo/votools/doc/taboverlay.hlp')
-rw-r--r--vo/votools/doc/taboverlay.hlp61
1 files changed, 61 insertions, 0 deletions
diff --git a/vo/votools/doc/taboverlay.hlp b/vo/votools/doc/taboverlay.hlp
new file mode 100644
index 00000000..c69722bd
--- /dev/null
+++ b/vo/votools/doc/taboverlay.hlp
@@ -0,0 +1,61 @@
+.help taboverlay Mar12 votools
+.ih
+NAME
+taboverlay -- General table overlay in the image display
+.ih
+USAGE
+taboverlay image catalog
+.ih
+PARAMETERS
+.ls image
+The input image.
+.le
+.ls catalog
+The input catalog.
+.le
+.ls labcol = 1
+Label column number (one-indexed).
+.le
+.ls racol = 2
+RA column number (one-indexed).
+.le
+.ls deccol =3INDEF
+Dec column number (one-indexed).
+.le
+.ls mkcolor = 208
+Marker color index to use.
+.le
+.ls status = 0
+Status of the service. A non-zero value indicates no results were found.
+.le
+
+.ih
+DESCRIPTION
+
+The \fITABOVERLAY\fR task is used to overlay a catalog of positions on
+the image display. The input catalog file is assumed to be an ascii
+table of the form (index,ra,dec) however the \fIracol\fR, \fIdeccol\fR and
+\fIlabcol\fR parameters can be used to select columns from tables containing
+more information. Markers will be drawn using the color specified by the
+\fImkcolor\fR parameter.
+
+.ih
+EXAMPLES
+1. Query for catalog positions of NGC188 and extract the (numbered) position
+columns to the file 'ngc188.pos'. Then display an image of the field and
+overlay the catalog positions.
+
+.nf
+ votools> getcat gsc2.3 ngc188 size=0.1 output="ngc188.xml"
+ votools> votpos ngc188.xml number+ out="ngc188.pos"
+ votools> dss ngc188
+ votools> taboverlay ngc188 ngc188.pos
+.fi
+
+.ih
+REVISIONS
+.
+.ih
+SEE ALSO
+getcat, getimg
+.endhelp