aboutsummaryrefslogtreecommitdiff
path: root/vo/votools/doc/nedoverlay.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/nedoverlay.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'vo/votools/doc/nedoverlay.hlp')
-rw-r--r--vo/votools/doc/nedoverlay.hlp74
1 files changed, 74 insertions, 0 deletions
diff --git a/vo/votools/doc/nedoverlay.hlp b/vo/votools/doc/nedoverlay.hlp
new file mode 100644
index 00000000..204c1108
--- /dev/null
+++ b/vo/votools/doc/nedoverlay.hlp
@@ -0,0 +1,74 @@
+.help nedoverlay Mar12 votools
+.ih
+NAME
+nedoverlay -- Overlay NED objects in the image display
+.ih
+USAGE
+nedoverlay image
+.ih
+PARAMETERS
+.ls image
+Input image.
+.le
+.ls append = yes
+Append the display?
+.le
+.ls size = 0.25
+Field size.
+.le
+.ls galaxies = no
+Mark galaxies on the display? This is disabled by default so as not to
+clutter the display.
+.le
+.ls radios = yes
+Mark radio sources on the display?
+.le
+.ls xrays = yes
+Mark X-Ray sources on the display?
+.le
+.ls mkcolor = 208
+Marker color.
+.le
+.ls galcolor = 207
+Galaxy marker color.
+.le
+.ls verbose = no
+Print actions?
+.le
+.ls status = 0
+Service status code.
+.le
+
+.ih
+DESCRIPTION
+The \fINEDOVERLAY\fR task is used to overlay sources from the NED service on
+the image display. If the \fIimage\fR parameter is an object name, it's
+position will be resolved and a query for sources within \fIsize\fR degrees
+of that position will be used. If it is an image name, the WCS footprint
+of the image will be used to generate the query.
+
+If the \fIgalaxies\fR parameter is set, a small cross will be drawn at the
+position of each NED galaxy using the color specified by the \fIgalcolor\fR
+parameter. All other markers will be drawn and labelled using the
+\fImarkcolor\fR value.
+
+.ih
+EXAMPLES
+1. Display an image of m83 and overlay the NED radio sources in the field.
+
+.nf
+ votools> nedoverlay m83 append-
+
+or
+
+ votools> dss m83
+ votools> nedoverlay m83 append+
+.fi
+
+.ih
+REVISIONS
+
+.ih
+SEE ALSO
+radiooverlay, xrayoverlay, obslogoverlay
+.endhelp