diff options
author | Joseph Hunkeler <jhunkeler@gmail.com> | 2015-07-08 20:46:52 -0400 |
---|---|---|
committer | Joseph Hunkeler <jhunkeler@gmail.com> | 2015-07-08 20:46:52 -0400 |
commit | fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch) | |
tree | bdda434976bc09c864f2e4fa6f16ba1952b1e555 /vo/votools/doc | |
download | iraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz |
Initial commit
Diffstat (limited to 'vo/votools/doc')
32 files changed, 2373 insertions, 0 deletions
diff --git a/vo/votools/doc/_docs b/vo/votools/doc/_docs new file mode 100644 index 00000000..6086ab9d --- /dev/null +++ b/vo/votools/doc/_docs @@ -0,0 +1,35 @@ +_docs +aladin.hlp +colbyid.hlp +colbyname.hlp +colbyucd.hlp +dispname.hlp +dss.hlp +getcat.hlp +getimg.hlp +getspec.hlp +hub.hlp +imgcat.hlp +makewcs.hlp +mkregdb.hlp +nedoverlay.hlp +obslogoverlay.hlp +overhandler.hlp +qstring.hlp +radiooverlay.hlp +rawcaller.hlp +regdb.hlp +sesame.hlp +stilts.hlp +taboverlay.hlp +topcat.hlp +urlget.hlp +vocatalog.hlp +voclient.hlp +vodata.hlp +voimage.hlp +votcopy.hlp +votget.hlp +votpos.hlp +wcsinfo.hlp +xrayoverlay.hlp diff --git a/vo/votools/doc/aladin.hlp b/vo/votools/doc/aladin.hlp new file mode 100644 index 00000000..d86ba655 --- /dev/null +++ b/vo/votools/doc/aladin.hlp @@ -0,0 +1,50 @@ +.help aladin Mar12 votools +.ih +NAME +aladin -- Start/Stop/Status of the Aladin external task +.ih +USAGE +aladin command +.ih +PARAMETERS +.ls command +Command to execute. If not specified, the default action is to start +the application. +.le +.ls bkg = yes +Run the application in the background? +.le +.ls verbose = no +Print actions? +.le + +.ih +DESCRIPTION +The \fIALADIN\fR task is used to start, stop, or check the status of +the Aladin external application. If no command argument is given, the +default action is to start the application if it is not already running. +If command is \fIstop\fR then a running Aladin application is shutdown. + +If the command is \fIstatus\fR then the output will be "on" or "off" +depending on whether the application is running. + +.ih +EXAMPLES +1. Demonstrated uses of the command: + +.nf + votools> aladin status # check if Aladin is running + off + votools> aladin start # start Aladin + votools> aladin status # check if Aladin is running + on + votools> aladin stop # stop Aladin +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +hub, topcat, samp +.endhelp diff --git a/vo/votools/doc/colbyid.hlp b/vo/votools/doc/colbyid.hlp new file mode 100644 index 00000000..34510f57 --- /dev/null +++ b/vo/votools/doc/colbyid.hlp @@ -0,0 +1,94 @@ +.help colbyid Mar12 votools +.ih +NAME +colbyid -- Identify VOTable column by ID attribute +.ih +USAGE +colbyid input id +.ih +PARAMETERS +.ls input +The input VOTable. +.le +.ls id +The ID attribute name +.le +.ls column = 0 +Found column number (1-indexed, or -1 if not found) +.le +.ls ucd = "" +Value of the UCD attribute for the found column. +.le +.ls name = "" +Value of the NAME attribute for the found column. +.le +.ls print = no +Print column field number? +.le +.ls found = no +Was column found in table? +.le + +.ih +DESCRIPTION +The \fICOLBYID\fR task is used to find the column in a VOTable with the +named \fIID\fR attribute value of a table column. This attribute is not +generally guaranteed to be unique within a table and so the task will print +a warning if multiple values are found, but only the first value found will +be saved. This attribute value is not generally guaranteed to be the same +across VO services (e.g. an 'RA' and 'Dec' column may have alternate IDs), +and so some knowledge of the table contents is assumed. + +If a column with the specified attribute is found, the \fIcolumn\fR parameter +will be the one-indexed column number and the \fIfound\fR parameter will +be set, otherwise the \fIcolumn\fR value will be '-1'. If the column is +found, the \fIucd\fR and \fIname\fR values will be filled in with the +corresponding attributes for that column or the null string. + +If the \fIprint\fR parameter is set, the column number will be printed to the +standard output. + +.ih +EXAMPLES +1. Find the column in the table where the 'id' attribute is 'RA' in a +VOTable document: + +.nf + votools> colbyid vodata$usno-b.xml RA print+ + 2 + votools> colbyid http://iraf.noao.edu/votest/usno-b.xml RA print+ + 2 + votools> colbyid file:///<path>/data/usno-b.xml RA print+ + 2 + votools> colbyid file:///localhost/<path>/data/usno-b.xml RA print+ + 2 +.fi + +Or when a parameter is not found: + +.nf + votools> colbyid vodata$usno-b.xml FOO print+ + -1 +.fi + +If a matching column is found in the table, the task parameters may be +queried for additional information: + +.nf + votools> =colbyid.column + 2 + votools> =colbyid.found + yes + votools> =colbyid.ucd + POS_EQ_RA_MAIN + votools> =colbyid.name + RA +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +colbyucd, colbyname +.endhelp diff --git a/vo/votools/doc/colbyname.hlp b/vo/votools/doc/colbyname.hlp new file mode 100644 index 00000000..880d1b8f --- /dev/null +++ b/vo/votools/doc/colbyname.hlp @@ -0,0 +1,94 @@ +.help colbyname Mar12 votools +.ih +NAME +colbyname -- Identify VOTable column by NAMED attribute +.ih +USAGE +colbyname input name +.ih +PARAMETERS +.ls input +The input VOTable. +.le +.ls name +The NAMED attribute name +.le +.ls column = 0 +Found column number (1-indexed, or -1 if not found) +.le +.ls ucd = "" +Value of the UCD attribute for the found column. +.le +.ls name = "" +Value of the NAME attribute for the found column. +.le +.ls print = no +Print column field number? +.le +.ls found = no +Was column found in table? +.le + +.ih +DESCRIPTION +The \fICOLBYNAMED\fR task is used to find the column in a VOTable with the +named \fINAMED\fR attribute value of a table column. This attribute is not +generally guaranteed to be unique within a table and so the task will print +a warning if multiple values are found, but only the first value found will +be saved. This attribute value is not generally guaranteed to be the same +across VO services (e.g. an 'RA' and 'Dec' column may have alternate NAMEs), +and so some knowledge of the table contents is assumed. + +If a column with the specified attribute is found, the \fIcolumn\fR parameter +will be the one-indexed column number and the \fIfound\fR parameter will +be set, otherwise the \fIcolumn\fR value will be '-1'. If the column is +found, the \fIucd\fR and \fIname\fR values will be filled in with the +corresponding attributes for that column or the null string. + +If the \fIprint\fR parameter is set, the column number will be printed to the +standard output. + +.ih +EXAMPLES +1. Find the column in the table where the 'name' attribute is 'RA' in a +VOTable document: + +.nf + votools> colbyname vodata$usno-b.xml RA print+ + 2 + votools> colbyname http://iraf.noao.edu/votest/usno-b.xml RA print+ + 2 + votools> colbyname file:///<path>/usno-b.xml RA print+ + 2 + votools> colbyname file:///localhost/<path>/usno-b.xml RA print+ + 2 +.fi + +Or when a parameter is not found: + +.nf + votools> colbyname vodata$usno-b.xml FOO print+ + -1 +.fi + +If a matching column is found in the table, the task parameters may be +queried for additional information: + +.nf + votools> =colbyname.column + 2 + votools> =colbyname.found + yes + votools> =colbyname.ucd + POS_EQ_RA_MAIN + votools> =colbyname.name + RA +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +colbyucd, colbyid +.endhelp diff --git a/vo/votools/doc/colbyucd.hlp b/vo/votools/doc/colbyucd.hlp new file mode 100644 index 00000000..abe52cbc --- /dev/null +++ b/vo/votools/doc/colbyucd.hlp @@ -0,0 +1,92 @@ +.help colbyucd Mar12 votools +.ih +NAME +colbyucd -- Identify VOTable column by UCD attribute +.ih +USAGE +colbyucd input ucd +.ih +PARAMETERS +.ls input +The input VOTable. +.le +.ls ucd +The UCD attribute name +.le +.ls column = 0 +Found column number (1-indexed, or -1 if not found) +.le +.ls id = "" +Value of the ID attribute for the found column. +.le +.ls name = "" +Value of the NAME attribute for the found column. +.le +.ls print = no +Print column field number? +.le +.ls found = no +Was column found in table? +.le + +.ih +DESCRIPTION +The \fICOLBYUCD\fR task is used to find the column in a VOTable with the +named \fIUCD\fR attribute value of a table column. This attribute is not +generally guaranteed to be unique within a table and so the task will print +a warning if multiple values are found, but only the first value found will +be saved. + +If a column with the specified attribute is found, the \fIcolumn\fR parameter +will be the one-indexed column number and the \fIfound\fR parameter will +be set, otherwise the \fIcolumn\fR value will be '-1'. If the column is +found, the \fIid\fR and \fIname\fR values will be filled in with the +corresponding attributes for that column or the null string. + +If the \fIprint\fR parameter is set, the column number will be printed to the +standard output. + +.ih +EXAMPLES +1. Find the column in the table where the 'ucd' attribute is 'RA' in a +VOTable document: + +.nf + votools> colbyucd vodata$usno-b.xml POS_EQ_RA_MAIN print+ + 2 + votools> colbyucd http://iraf.noao.edu/votest/usno-b.xml POS_EQ_RA_MAIN print+ + 2 + votools> colbyucd file:///<path>/usno-b.xml POS_EQ_RA_MAIN print+ + 2 + votools> colbyucd file:///localhost/<path>/usno-b.xml POS_EQ_RA_MAIN print+ + 2 +.fi + +Or when a parameter is not found: + +.nf + votools> colbyucd vodata$usno-b.xml FOO print+ + -1 +.fi + +If a matching column is found in the table, the task parameters may be +queried for additional information: + +.nf + votools> =colbyucd.column + 2 + votools> =colbyucd.found + yes + votools> =colbyid.ucd + POS_EQ_RA_MAIN + votools> =colbyucd.name + RA +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +colbyid, colbyname +.endhelp diff --git a/vo/votools/doc/dispname.hlp b/vo/votools/doc/dispname.hlp new file mode 100644 index 00000000..9c6cb6f3 --- /dev/null +++ b/vo/votools/doc/dispname.hlp @@ -0,0 +1,44 @@ +.help dispname Mar12 votools +.ih +NAME +dispname -- Get the currently displayed image name +.ih +USAGE +dispname frame + +.ih +PARAMETERS +.ls frame +Frame number to query. +.le + +.ih +DESCRIPTION + +The \fIDISPNAME\fR task is used to get the name of the image displayed +in the frame number specified by the \fIframe\fR parameter. + +.ih +EXAMPLES + +1. Print the displayed image name to the STDOUT + +.nf + votools> display dev$pix 1 + votools> dispname 1 verbose+ + dev$pix +.fi + +2. Get the name, but use it within as script as a parameter: + +.nf + int frame_num = 1 + dispname (frame_num) + printf ("The displayed image is '%s'\n", dispname.name) +.fi + + +.ih +SEE ALSO + +.endhelp diff --git a/vo/votools/doc/dss.hlp b/vo/votools/doc/dss.hlp new file mode 100644 index 00000000..caac4123 --- /dev/null +++ b/vo/votools/doc/dss.hlp @@ -0,0 +1,88 @@ +.help dss Mar12 votools +.ih +NAME +dss -- Display a DSS2 image of a named field +.ih +USAGE +dss field +.ih +PARAMETERS +.ls field +Name of target field to display. If the null string then the \fIra\fR, +\fIdec\fR and \fIsize\fR parameters determine the image to display. If +specified as an image name, the WCS footprint of the image is used to +determine the displayed image. +.le +.ls ra = 0.0 +RA (J2000) of field. +.le +.ls dec = 0.0 +Dec (J2000) of field. +.le +.ls size = 0.25 +Size of field (decimal degrees). +.le +.ls frame = 1 +Image display frame. +.le +.ls use_display = yes +Display the retrieved image? If 'no', the image is retrieved to the +system cache but is not displayed. +.le +.ls grid = no +Overlay a coordinate grid on the image display? +.le +.ls verbose = yes +Print actions? +.le +.ls save = yes +Save the retrieved image? If 'no', the field is displayed but the +image is not saved for later use, otherwise the name of the retrieved +file is written to the \fIimname\fR parameter. +.le +.ls imname = "" +Saved image name. +.le + +.ih +DESCRIPTION +The \fIDSS\fR task is used to query and optionally display an image of +the named \fIfield\fR. If the \fIfield\fR param is the null string, +the \fIra\fR, \fIdec\fR and \fIsize\fR parameters determine the image +to display. If \fIfield\fR is specified as an image name, the WCS +footprint of the image is used to determine the query parameters. + +The \fIuse_display\fR parameter determines whether an image is displayed +to the specified \fIframe\fR. If disabled, the image will be retrieved +to the system cache and the filename will be written to the \fIimname\fR +parameter. + +.ih +EXAMPLES +1. Display a half-degree image of M31. + +.nf + votools> dss m31 size=0.5 +.fi + +2. Display the DSS version of the dev$ypix field, overlay a grid. + +.nf + votools> dss dev$ypix grid+ +.fi + +3. Get an image of a field but don't display it + +.nf + votools> dss m83 use_display- + votools> =dss.imname + cache$m83.fits +.fi + +.ih +REVISIONS + +.ih +SEE ALSO + +.endhelp diff --git a/vo/votools/doc/getcat.hlp b/vo/votools/doc/getcat.hlp new file mode 100644 index 00000000..b8ee9cd8 --- /dev/null +++ b/vo/votools/doc/getcat.hlp @@ -0,0 +1,144 @@ +.help getcat Mar12 votools +.ih +NAME +getcat -- Query catalog data services in the VO +.ih +USAGE +getcat resource fields +.ih +PARAMETERS +.ls resource +List of the VO data services to query. +.le +.ls fields +List of objects or images used to specify the position of the query. An +object name will be resolved to a position using the \fISESAME\fR service +and the \fIsize\fR parameter will determine the query size. If an image +name is given, the center position and image corners will be used to +determine the query position and size. +.le +.ls pos = "" +A string specifying the position of the query. Positions are specified as +J2000 RA and Dec in decimal degrees separate by a comma. +.le +.ls size = 0.25 +Query size in decimal degrees. +.le +.ls samp = no +If enabled, each result table is broadcast as a SAMP message to other +VO applications. +.le +.ls plot = no +Plot the result table to the standard graphics stream? +The \fIplot\fR parameter is ignored when using multiple resources or fields. +.le +.ls display = no +If enabled, an image of the \fIfield\fR will be displayed. If the +\fIfield\fR is an object name, a DSS image of the field will be displayed, +if the \fIfield\fR is an image then the image will be displayed. The +\fIdisplay\fR parameter is ignored when using multiple resources or fields. +.le +.ls overplot = no +If enabled, the objects in the result table will be overlayed on the +image display. The \fIoverplot\fR parameter is ignored when using multiple +resources or fields. +.le +.ls output = "STDOUT" +Output filename. If the \fIoutput\fR parameter is "STDOUT" the result table +will be written to the standard output stream. If the output name is a +null string, no result table will be printed or saved. +.le +.ls format = "ascii" +Format of the result table. Allowed values are +.ls vot | xml +A new VOTable. +.le +.ls asv +Ascii separated values. +.le +.ls bsv +Bar separated values. +.le +.ls csv +Comma separated values. +.le +.ls tsv +Tab separated values. +.le +.ls html +Standalone HTML document. +.le +.ls shtml +Single HTML <table> element. This format may be used to generate the <table> +code for inclusion in another HTML document. +.le +.ls fits +FITS binary table +.le +.le +.ls status = 0 +Return status code. A non-zero value indicates an error in the query. +.le + +.ih +DESCRIPTION +The \fIGETCAT\fR task is used to retrieve data from one or more VO +catalog services. An individual \fIresource\fR name may be +specified as a user-defined alias, a VO \fIShortName\fR, a VO \fIivorn\fR +identifier string, or as a base service URL. If specified as a service URL, +additional parameters to specify the position and size will be determined +from the \fIfields\fR, \fIpos\fR and \fIsize\fR parameters. Multiple +resources may be specified as a comma-delimited string or as an \fI@file\fR. + +The position to be queried may be specified by the \fIfields\fR parameter +as either a list of object names that are resolved to equatorial coordinates +automatically, or as a list of images where the WCS footprint of the image is +used to determine the center and size. For object names, the \fIsize\fR +parameter is specified in decimal degrees as the radius around the position +to query. The \fIpos\fR parameter may be specified as a comma-separated +set of RA/Dec values given in decimal degrees. + +Result tables may be broadcast to other VO applications using SAMP messaging +by enabling the \fIsamp\fR parameter. If the \fIdisplay\fR parameter is +enabled then images used as input will be displayed, if object names are +used a DSS image of the field will be displayed. The \fIoverplot\fR parameter +may be set to overplot the result catalog on the image display automatically. +The \fIdisplay\fR and \fIoverplot\fR parameters are only used for +single-resource and single-object queries. + +Results may be saved to disk in a format specified by the \fIformat\fR +parameter (described above). If the \fIoutput\fR parameter is the null +string then no local results will be saved or printed, the value "STDOUT" +may be used to print the result table to the standard output stream (except +in the case of FITS bintable output). + +.ih +EXAMPLES +1. Find the GSC2.3 catalog sources within 0.1 degrees of 3c273. Display +the field and overplot the catalog positions on the image display, but do +not print the results. Then do the same but plot a graph instead of +overlay the display. + +.nf + votools> getcat gsc2.3 3c273 size=0.1 display+ overplot+ output="" + votools> getcat gsc2.3 3c273 size=0.1 plot+ output="" +.fi + +2. Find the 2MASS point-source catalog objects in each extension of a +NEWFIRM mosaic image: + +.nf + votools> getcat 2mass-psc @newfirm.fits format="fits" output="nf" +.fi + +The result tables are saved as FITS bintables with the root name 'nf' +followed by a running number indicating the extension. + + +.ih +REVISIONS +.le +.ih +SEE ALSO +getimg, vodata, votpos +.endhelp diff --git a/vo/votools/doc/getimg.hlp b/vo/votools/doc/getimg.hlp new file mode 100644 index 00000000..7b780f9d --- /dev/null +++ b/vo/votools/doc/getimg.hlp @@ -0,0 +1,142 @@ +.help getimg Mar12 votools +.ih +NAME +getimg -- Query image data services in the VO +.ih +USAGE +getimg resource fields +.ih +PARAMETERS +.ls resource +List of the VO data services to query. +.le +.ls fields +List of objects or images used to specify the position of the query. An +object name will be resolved to a position using the \fISESAME\fR service +and the \fIsize\fR parameter will determine the query size. If an image +name is given, the center position and image corners will be used to +determine the query position and size. +.le +.ls pos = "" +A string specifying the position of the query. Positions are specified as +J2000 RA and Dec in decimal degrees separate by a comma. +.le +.ls size = 0.25 +Query size in decimal degrees. +.le +.ls samp = no +If enabled, each result table is broadcast as a SAMP message to other +VO applications. +.le +.ls plot = no +Plot the result table to the standard graphics stream? +The \fIplot\fR parameter is ignored when using multiple resources or fields. +.le +.ls display = no +If enabled, an image of the \fIfield\fR will be displayed. If the +\fIfield\fR is an object name, a DSS image of the field will be displayed, +if the \fIfield\fR is an image then the image will be displayed. The +\fIdisplay\fR parameter is ignored when using multiple resources or fields. +.le +.ls overplot = no +If enabled, the objects in the result table will be overlayed on the +image display. The \fIoverplot\fR parameter is ignored when using multiple +resources or fields. +.le +.ls output = "STDOUT" +Output filename. If the \fIoutput\fR parameter is "STDOUT" the result table +will be written to the standard output stream. If the output name is a +null string, no result table will be printed or saved. +.le +.ls format = "ascii" +Format of the result table. Allowed values are +.ls vot | xml +A new VOTable. +.le +.ls asv +Ascii separated values. +.le +.ls bsv +Bar separated values. +.le +.ls csv +Comma separated values. +.le +.ls tsv +Tab separated values. +.le +.ls html +Standalone HTML document. +.le +.ls shtml +Single HTML <table> element. This format may be used to generate the <table> +code for inclusion in another HTML document. +.le +.ls fits +FITS binary table +.le +.le +.ls status = 0 +Return status code. A non-zero value indicates an error in the query. +.le + +.ih +DESCRIPTION +The \fIGETIMG\fR task is used to retrieve data from one or more VO +image services. An individual \fIresource\fR name may be +specified as a user-defined alias, a VO \fIShortName\fR, a VO \fIivorn\fR +identifier string, or as a base service URL. If specified as a service URL, +additional parameters to specify the position and size will be determined +from the \fIfields\fR, \fIpos\fR and \fIsize\fR parameters. Multiple +resources may be specified as a comma-delimited string or as an \fI@file\fR. + +The position to be queried may be specified by the \fIfields\fR parameter +as either a list of object names that are resolved to equatorial coordinates +automatically, or as a list of images where the WCS footprint of the image is +used to determine the center and size. For object names, the \fIsize\fR +parameter is specified in decimal degrees as the radius around the position +to query. The \fIpos\fR parameter may be specified as a comma-separated +set of RA/Dec values given in decimal degrees. + +Result tables may be broadcast to other VO applications using SAMP messaging +by enabling the \fIsamp\fR parameter. If the \fIdisplay\fR parameter is +enabled then images used as input will be displayed, if object names are +used a DSS image of the field will be displayed. The \fIoverplot\fR parameter +may be set to overlay the result catalog on the image display automatically. +The \fIdisplay\fR and \fIoverplot\fR parameters are only used for +single-resource and single-object queries. + +Results may be saved to disk in a format specified by the \fIformat\fR +parameter (described above). If the \fIoutput\fR parameter is the null +string then no local results will be saved or printed, the value "STDOUT" +may be used to print the result table to the standard output stream (except +in the case of FITS bintable output). + +.ih +EXAMPLES +1. Find the HST GOODS images within 0.1 degrees of 3c273. Display +the field and overlay the central image positions on the image display, +do not print the results. Then do the same, but plot the results instead +of overlaying the display, append the GSC2.3 catalog. + +.nf + votools> getimg hst.goods 3c273 size=0.1 display+ overplot+ output="" + votools> getimg hst.goods 3c273 size=0.1 plot+ output="" + votools> getimg gsc2.3 3c273 size=0.1 plot+ overplot+ output="" +.fi + +2. Find the NVSS (all-sky 21-cm radio survey) images for each extension of a +NEWFIRM mosaic image, save the raw VOTable results: + +.nf + votools> getimg nvss @newfirm.fits format="raw" output="nf" +.fi + + +.ih +REVISIONS +.le +.ih +SEE ALSO +getcat, vodata +.endhelp diff --git a/vo/votools/doc/getspec.hlp b/vo/votools/doc/getspec.hlp new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/vo/votools/doc/getspec.hlp @@ -0,0 +1 @@ + diff --git a/vo/votools/doc/hub.hlp b/vo/votools/doc/hub.hlp new file mode 100644 index 00000000..949f559b --- /dev/null +++ b/vo/votools/doc/hub.hlp @@ -0,0 +1,56 @@ +.help hub Mar12 votools +.ih +NAME +hub -- Start/Stop/Status of the Hub external task +.ih +USAGE +hub command +.ih +PARAMETERS +.ls command +Command to execute. If not specified, the default action is to start +the application. +.le +.ls bkg = yes +Run the application in the background? +.le +.ls gui = yes +Run the application with a GUI control window? +.le +.ls verbose = no +Print actions? +.le + +.ih +DESCRIPTION +The \fIHUB\fR task is used to start, stop, or check the status of +the SAMP Hub. If no command argument is given, the +default action is to start the external JSamp Hub if it is not already running +or if there is no internal Hub available from Topcat or Aladin, SAMP +messaging is enabled as well +If command is \fIstop\fR then a running Hub application is shutdown and +SAMP messaging is disabled in the CL. + +If the command is \fIstatus\fR then the output will be "on" or "off" +depending on whether a Hub is available. + +.ih +EXAMPLES +1. Demonstrated uses of the command: + +.nf + votools> hub status # check if Hub is running + off + votools> hub start # start Hub + votools> hub status # check if Hub is running + on + votools> hub stop # stop Hub +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +hub, topcat, samp +.endhelp diff --git a/vo/votools/doc/mkregdb.hlp b/vo/votools/doc/mkregdb.hlp new file mode 100644 index 00000000..5e0a4b86 --- /dev/null +++ b/vo/votools/doc/mkregdb.hlp @@ -0,0 +1,93 @@ +.help mkregdb Mar12 votools +.ih +NAME +mkregdb -- Create a local registry database +.ih +USAGE +mkregdb query +.ih +PARAMETERS +.ls query +Registry query term(s). +.le +.ls output = "" +Output filename. +.le +.ls type = "" +Constraint on the resource type (e.g. 'catalog' or 'image') +.le +.ls bandpass = "" +Constraint on the resource spectral coverage. +.le +.ls content = "" +Constraint on the resource content level. +.le +.ls sql = "" +Arbitrary SQL predicate string. +.le +.ls header = yes +Print header? +.le +.ls nresults = 0 +Updated with the number of resources found. +.le +.ls status = 0 +Status value, a non-zero value indicates an error. +.le + +.ih +DESCRIPTION + +The \fIMKREGDB\fR task is used to create a local resource database that +matches a given query term and service constraints. The \fIquery\fR +parameter is a search term or phrase for the Registry, results may be +constrained by specifying the \fItype\fR, \fIbandpass\fR, \fIcontent\fR +or \fIsql\fR parameters. Output is written to the \fIoutput\fR filename +(or "STDOUT" if a null string). + +The \fItype\fR parameter is currently limited to supported data services, +namely 'image', 'catalog' or 'spectra'. The \fIcontent\fR parameter can be +used to select only research-grade service, EPO data, etc. Allowed content +values are described in the IVOA Resource Metadata document +(http://www.ivoa.net/Documents/latest/RM.html). + +The \fIbandpass\fR constraint may be one of the following values: +.nf + radio + millimeter + infrared, IR + optical + ultraviolet, ultra-violet, EUV, UV + xray, x-ray + gamma, gammaray, gamma-ray +.fi + +When done, the \fInresults\fR parameter is updated with the number of +matching records found. Note that non-data services (e.g. institutional +names) are not included in the result table. If an error is encountered, +or no results are found, the \fIstatus\fR parameter will contain a +non-zero value. + +.ih +EXAMPLES + +1) Create a local database of VO Resources containing image data on quasars: + +.nf + votools> mkregdb quasar type="image" +.fi + +2) Create a local database of all IR catalog services. + +.nf + votools> mkregdb "" bandpass="infrared" type="catalog" +.fi + +.ih +REVISIONS + +.ih +SEE ALSO +regdb, registry + +.endhelp 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 diff --git a/vo/votools/doc/obslogoverlay.hlp b/vo/votools/doc/obslogoverlay.hlp new file mode 100644 index 00000000..ef049c10 --- /dev/null +++ b/vo/votools/doc/obslogoverlay.hlp @@ -0,0 +1,98 @@ +.help obslogoverlay Mar12 votools +.ih +NAME +obslogedoverlay -- Overlay observation logs in the image display +.ih +USAGE +obslogoverlay input mission +.ih +PARAMETERS +.ls input +Input image or field name. +.le +.ls mission +Mission name. A small set of space based missions are supported directly, +however the task can be easily modified to add other available observation +logs. +.le +.ls size = 0.25 +Field size in degrees. If the \fIinput\fR parameter is not an image, it is +assumed to be an object name, the query will be for all observations within +\fIfield\fR degrees of the field center. +.le +.ls frame = 1 +Display frame. +.le +.ls display = yes +Display the image/field? If enabled, the input image or a DSS image of +the field will be displayed before overlaying the catalog. +.le +.ls print = no +List the observations on the standard output? +.le +.ls mkcolor = 0 +Marker color. If zero, a predefined color for each mission will be used. +.le +.ls mksize = 60 +Marker size (arcsec). +.le +.ls maxobs = 0 +Max observations to draw. If zero, all returned results are displayed. +.le +.ls verbose = no +Print actions? +.le +.ls status = 0 +Service status code. +.le + +.ih +DESCRIPTION + +The \fIOBSLOGOVERLAY\fR task is used to overlay markers indicating +observations from the selected space mission. The \fIinput\fR parameter +may be either an image name containing a valid WCS, or the name of an +object that will be used to form the query. If an image, the WCS +footprint will determine the query size, otherwise the \fIsize\fR +parameter will specify the query size. + +The \fImission\fR parameter specifies which mission's observations are +to be queried. Currently allowed values are: +.nf + EXOSAT FUSE HST + IUE Spitzer XMM +.fi +Additional missions and ground-based observation logs will be added +in future versions. This task is meant as a convenience application, +using other tasks in the \fIVOTOOLS\fR package any observation log +available from the VO could be overlayed using a small script task. + +If the \fIdisplay\fR task is enabled, the \fIinput\fR image (or a DSS +field containing the named object) will be displayed to frame +\fIframe\fR in the image display. The \fIprint\fR parameter may be used to +list instead of overlay the observation positions. + +Markers indicating the center of the observation will be drawn using a +size (in arcsec) specified by the \fImksize\fR parameter. If the +\fImkcolor\fR parameter is zero, a pre-determined marker color will be +used for each mission, allowing multiple missions to be overlayed. The +\fImaxobs\fR parameter can be used to limit the number of markers drawn +on the display. Note that no attempt is made to drawn a realistic +instrumental footprint. + +.ih +EXAMPLES +1. Overlay the IUE observations of the dev$ypix test image: +.nf + votools> obslogoverlay dev$ypix iue maxobs=30 +or + votools> obslogoverlay m51 iue size=0.2 display+ frame=1 maxobs=50 +.fi + +.ih +REVISIONS + +.ih +SEE ALSO +radiooverlay, xrayoverlay, nedoverlay +.endhelp diff --git a/vo/votools/doc/overhandler.hlp b/vo/votools/doc/overhandler.hlp new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/vo/votools/doc/overhandler.hlp diff --git a/vo/votools/doc/qstring.hlp b/vo/votools/doc/qstring.hlp new file mode 100644 index 00000000..55c46cba --- /dev/null +++ b/vo/votools/doc/qstring.hlp @@ -0,0 +1,71 @@ +.help qstring Mar12 votools +.ih +NAME +qstring -- Generate a query string URL +.ih +USAGE +qstring base field +.ih +PARAMETERS +.ls base +Base URL or resource name. +.le +.ls field +Query image or field name. +.le +.ls type = "catalog" +Data service type. +.le +.ls ra = 0.0 +RA position of query string (object or image center if provided). +.le +.ls dec = 0.0 +Dec position of query string (object or image center if provided). +.le +.ls size = 0.25 +Desired query size (or size derived from image). +.le + +.ih +DESCRIPTION +The \fIQSTRING\fR task ..... + +.ih +EXAMPLES +1. Print the query string used to access the NED service for the field +covering the dev$ypix test image: + +.nf + votools> qstring ned dev$ypix + http://ned.ipac.caltech.edu/cgi-bin/nph-NEDobjsearch?search_type=Near+Position+Search&of=xml_main&RA=202.47023333333&DEC=47.194552777778&SR=0.1088616739748&RUNID=iraf2160 +.fi + +1. Print the query string used to access the NED service for the field +covering the dev$ypix test image: + +.nf + votools> qstring ned dev$ypix + http://ned.ipac.caltech.edu/cgi-bin/nph-NEDobjsearch?search_type=Near+Position+Search&of=xml_main&RA=202.47023333333&DEC=47.194552777778&SR=0.1088616739748&RUNID=iraf2160 +.fi + +2. Print the query string used to access the DSS image service for the field +covering the dev$ypix test image: + +.nf + votools> qstring dss dev$ypix type="image" + http://skyview.gsfc.nasa.gov/cgi-bin/vo/sia.pl?survey=dss2&POS=202.47023333333,47.194552777778&SIZE=0.1088616739748&RUNID=iraf2160 +.fi + +3. Construct a catalog query string for a local URL at an explicit position: +.nf + votools> qstring http://foo.bar/cat ra=1.23 dec=2.34 size=0.2 + http://foo.bar/cat?RA=1.23&DEC=2.34&SR=0.2&RUNID=iraf2160 +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +getcat, getimg, getspec, vodata +.endhelp diff --git a/vo/votools/doc/radiooverlay.hlp b/vo/votools/doc/radiooverlay.hlp new file mode 100644 index 00000000..1396626d --- /dev/null +++ b/vo/votools/doc/radiooverlay.hlp @@ -0,0 +1,64 @@ +.help radiooverlay Mar12 votools +.ih +NAME +radiooverlay -- Overlay NVSS radio contours in the image display +.ih +USAGE +radiooverlay image +.ih +PARAMETERS +.ls image +Input image. +.le +.ls size = 0.25 +Field size. +.le +.ls ncontours = 0 +Number of contours to be drawn. If 0, the contour interval may +be specified, otherwise 20-30 nicely spaced contours are +drawn. A maximum of 40 contours can be drawn. +.le +.ls append = yes +Append the display? +.le +.ls verbose = no +Print actions? +.le +.ls device = "imdred" +Overlay device. +.le +.ls status = 0 +Service status code. +.le + +.ih +DESCRIPTION +The \fIRADIOOVERLAY\fR task is used to overlay contours from the NVSS 21-cm +all-sky survey 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. + +The \fICONTOUR\fR task is used to draw the overlays and should be consulted +to adjust the overlay as desired. + +.ih +EXAMPLES +1. Display an image of m83 and overlay the NVSS radio contours in the field. + +.nf + votools> radiooverlay m83 append- + +or + + votools> dss m83 + votools> radiooverlay m83 append+ +.fi + +.ih +REVISIONS + +.ih +SEE ALSO +nedoverlay, xrayoverlay, obslogoverlay, contour +.endhelp diff --git a/vo/votools/doc/regdb.hlp b/vo/votools/doc/regdb.hlp new file mode 100644 index 00000000..52c7a74d --- /dev/null +++ b/vo/votools/doc/regdb.hlp @@ -0,0 +1,117 @@ +.help regdb Mar12 votools +.ih +NAME +regdb -- Manage/Query a local VO Registry database +.ih +USAGE +regdb arg1 <arg2> <arg3> +.ih +PARAMETERS +.ls arg1, arg2, arg3 +Command argument strings. The \fIarg1\fR parameter is in general the name +of an operation to be performed (see below), depending on its value the +additional \fIarg\fR parameters may or may not be required. +.le +.ls type = "" +Service type constraint term. +.le +.ls bandpass = "" +Bandpass constraint term. +.le +.ls verbose = no +Verbose output? +.le +.ls status = 0 +Status value, a non-zero value indicates an error or no results found.. +.le + +.ls OUTPUT PARAMETERS +If a matching record is found, one or more of the following task parameters +may be updated with the record values: +.nf + (alias = "") Resource alias + (ivorn = "") Ivorn string + (sname = "") Short Name + (svctype = "") Resource type + (bpass = "") Bandpass + (url = "") Service URL + (desc = "") Description (Title string) +.fi + + +.ih +DESCRIPTION + +The \fIREGDB\fR task is used to query or manage the local registry database +file defined by the VO package \fIresdb\fR parameter. A local registry +database allows tasks to use preferred resources without generating a +query to the VO Registry each time information about the resource is +needed (e.g. the service URL), or to refer to a resource by a user-defined +alias. The \fIarg1\fR parameter may be either a command to manage the +database, or a search term for the database, in all cases the results are +written to the standard output. + +Searches may be constrained by setting the \fItype\fR or \fIbandpass\fR +parameter to match only those records meeting the constraints. This can +be used for example to select the image service in a registry database +containing multiple services with the same name alias. + +.ih +COMMANDS + +If the first argument to the task is not in the following list of allowed +commands, it is assumed to be a search term. Record searches are done +as case-insensitive substring matches against all the saved fields of +the record. + +The following commands are supported: + +.nf + list List the registry database records + resolve Resolve (search) for the \fIarg2\fR string + search Search for (resolve) the \fIarg2\fR string + + type Print the service type for records matching \fIarg2\fR + alias Print the DB alias for records matching \fIarg2\fR + bpass Print the bandpass value for records matching \fIarg2\fR + ivorn Print the VO identifier for records matching \fIarg2\fR + sname Print the VO ShortName for records matching \fIarg2\fR + url Print the ServiceURL for records matching \fIarg2\fR + desc Print the Description for records matching \fIarg2\fR + + add Add a record for the service + del Delete the record that matches the \fIarg2\fR string + update Do a new Registry query and update the local DB + rename Rename the local record alias +.fi + +.ih +EXAMPLES + +1) List the local resource database. Repeat but list only the image +services. Repeat again looking for radio catalog services. +.nf + votools> regdb list + votools> regdb list type="image" + votools> regdb list type="catalog" bandpass="radio" +.fi + +2) Print the URL for the DSS service in the registry database. +.nf + votools> regdb url alias="dss" +.fi + +3) Find the one X-Ray service in the registry database: +.nf + votools> regdb resolve bandpass="x-ray" +.fi + + +.ih +REVISIONS + +.ih +SEE ALSO +mkregdb, registry + +.endhelp diff --git a/vo/votools/doc/regmetalist.hlp b/vo/votools/doc/regmetalist.hlp new file mode 100644 index 00000000..a349cf1e --- /dev/null +++ b/vo/votools/doc/regmetalist.hlp @@ -0,0 +1,34 @@ +.help regmetalist Mar12 votools +.ih +NAME +regmetalist -- List the metadata fields of a Registry record +.ih +USAGE +regmetalist +.ih +PARAMETERS +.ls all = no +List all available fields, or just common ones. +.le + +.ih +DESCRIPTION +The \fIREGMETALIST\fR task is used to print the names of the queryable +fields of the registry. These fields may be used to create SQL predicates +that may be appended to a query to help constrain the search. + +.ih +EXAMPLES +1. Demonstrated uses of the command: + +.nf + votools> regmetalist +.fi + +.ih +REVISIONS + +.ih +SEE ALSO +registry, regdb, mkregdb +.endhelp diff --git a/vo/votools/doc/sesame.hlp b/vo/votools/doc/sesame.hlp new file mode 100644 index 00000000..d2d3fbec --- /dev/null +++ b/vo/votools/doc/sesame.hlp @@ -0,0 +1,124 @@ +.help sesame Mar12 votools +.ih +NAME +sesame -- Resolve a target name into a coordinate position +.ih +USAGE +sesame <target> +.ih +PARAMETERS +.ls target +List of objects to be resolved. Targets may be specified as a +comma-delimited list string or in an @file to resolve multiple targets. When +the \fIrange\fR parameter is non-null, this will be the root part of the +target name. +.le +.ls range = "" +A range string used to expand the \fItarget\fR parameter to a list of names +to be resolved (e.g. if \fItarget\fR is "ngc" then \fIrange\fR may be +specified as "1-100" to create a list of the first 100 NGC objects). +.le +.ls verbose = yes +Print coordinates to the stdout? If enabled the sexagesimal coordinates +of the resolved target will be printed to the STDOUT where they may be easily +scanned into variables in a script. In all cases, the output parameters +below are updated with the target information once the task has completed. +.le +.ls long = no +Print long-form output to the stdout? If enabled the target name, +sexagesimal coordinates, position error (in arcsec) and object type are +printed on the output line. +.le +.ls pos = "" +A sesagesimal string of the J2000 RA/Dec position (output). +.le +.ls ra = 0.0 +J2000 RA of the object in decimal degrees (output). +.le +.ls dec = 0.0 +J2000 Declination of the object in decimal degrees (output). +.le +.ls ra_err = 0.0 +Error of the RA position in arcsec (output). +.le +.ls dec_err = 0.0 +Error of the Dec position in arcsec (output). +.le +.ls otype = "" +Object type (output). +.le +.ls status = "" +Status return code of the web service (output). +.le + +.ih +DESCRIPTION + +The \fBSESAME\fR task invokes the Sesame name resolver service from CDS to +convert an object identifier (e.g. catalog name) to an ICRS coordinate pair. +The service will first try to resolve the object using the NED database, and +if not found will use the Simbad database, the VizieR database is used to +resolve the coordinates as a final option. The \fItarget\fR parameter may +be specified as a comma-delimited list or in an @file to resolve multiple +target names. If the \fIrange\fR parameter is set, it may contain a range +string that will be expanded to append numeric values to the \fItarget\fR +value (e.g. to dynamically create catalog names). + +If the \fBverbose\fR parameter is set the ra/dec coords are written to the +STDOUT where they may be easily scanned into script variables. If the +\fIlong\fR parameter is enabled, all known information about the object is +printed (as name, ra, dec, ra_err, dec_err and object type). + +In cases where only a single object is resolved the \fBpos\vR, \fBra\fR, +\fBdec\fR, \fBraw_err\fR, \fBdec_err\fR, \fBotype\fR, and \fBstatus\fR +parameters are updated with the resolved values. The \fRstatus\fR +parameter will be zero is successful, non-zero is the object could not be +resolved or the service could not be reached. + +.ih +EXAMPLES +1. Find the coordinates of M51 (i.e. the dev$pix image): + +.nf + votools> sesame m51 + 13:29:55.72 +47:13:53.4 + + votools> sesame m51 long+ + m51 13:29:52.69 +47:11:42. 0. 0. Sy + + votools> sesame m51 + votools> lpar sesame + target = "m51" Target name to resolve + (verbose = no) Print position to stdout?\n + (pos = "13:29:55.72 +47:13:53.4") Position (sexagesimal string) + (ra = 202.4821936) Resolved RA (J2000 decimal degrees) + (dec = 47.2315089) Resolved DEC (J2000 decimal degrees) + (ra_err = 134.) Error on Resolved RA (arcsec) + (dec_err = 134.) Error on Resolved DEC (arcsec) + (otype = "GPair") Resolved object type description + (status = 0) Resolved DEC (J2000 decimal degrees) + (mode = "ql") +.fi + + +2. Create a local copy of the Messier catalog. + +.nf + votools> for (i=1; i < 100; i=i+1) { + >>> printf ("m%d\n", i) | scan (s1) + >>> sesame (s1, verb-) + >>> printf ("m%d %s %s\n", i, sesame.pos, sesame.otype) + >>> } + + or + + votools> sesame m range="1-110" long+ | fields STDIN "1-3" +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +voclient +.endhelp diff --git a/vo/votools/doc/stilts.hlp b/vo/votools/doc/stilts.hlp new file mode 100644 index 00000000..b89e0575 --- /dev/null +++ b/vo/votools/doc/stilts.hlp @@ -0,0 +1,27 @@ +.help stilts Mar12 votools +.ih +NAME +stilts -- Starlink Tables Infrastructure Library Tool Set +.ih +USAGE +stilts <task> <args> + +.ih +DESCRIPTION + +STILTS is used as a foreign task by the NVO package for converting +VOTables and other utility functions. A full description of the tasks +available can be found at + +.nf + http://www.star.bris.ac.uk/~mbt/stilts/ +.fi + +STILTS is distributed with the NVO package however it requires Java +to be available on the machine. The current version requires J2SE1.4 +or later. + +.ih +SEE ALSO +voclient +.endhelp diff --git a/vo/votools/doc/tabclip.hlp b/vo/votools/doc/tabclip.hlp new file mode 100644 index 00000000..ae359268 --- /dev/null +++ b/vo/votools/doc/tabclip.hlp @@ -0,0 +1,39 @@ +.help tabclip Mar12 votools +.ih +NAME +tabclip -- Clip a table to a specified box region +.ih +USAGE +tabclip intab outtab xcol ycol x1 y1 x2 y2 +.ih +PARAMETERS +.ls intab +The input table name. +.le +.ls outtab +The out table name. +.le +.ls xcol, ycol +The X and Y column names. +.le +.ls x1, y1 +The lower-left clipping values. +.le +.ls x2, y2 +The upper-right clipping values. +.le + +.ih +DESCRIPTION + +The \fITABCLIP\fR task is used clip a table (i.e. select rows) where +the value is the \fIxcol\fR and \fIycol\fR columns fall within the +box specified by the \fIx1\fR, \fIy1\fR, \fIx2\fR, \fIx2\fR values. + +.ih +REVISIONS + +.ih +SEE ALSO + +.endhelp 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 diff --git a/vo/votools/doc/tblhandler.hlp b/vo/votools/doc/tblhandler.hlp new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/vo/votools/doc/tblhandler.hlp diff --git a/vo/votools/doc/topcat.hlp b/vo/votools/doc/topcat.hlp new file mode 100644 index 00000000..441c5b18 --- /dev/null +++ b/vo/votools/doc/topcat.hlp @@ -0,0 +1,50 @@ +.help topcat Mar12 votools +.ih +NAME +topcat -- Start/Stop/Status of the Topcat external task +.ih +USAGE +topcat command +.ih +PARAMETERS +.ls command +Command to execute. If not specified, the default action is to start +the application. +.le +.ls bkg = yes +Run the application in the background? +.le +.ls verbose = no +Print actions? +.le + +.ih +DESCRIPTION +The \fITOPCAT\fR task is used to start, stop, or check the status of +the Topcat external application. If no command argument is given, the +default action is to start the application if it is not already running. +If command is \fIstop\fR then a running Topcat application is shutdown. + +If the command is \fIstatus\fR then the output will be "on" or "off" +depending on whether the application is running. + +.ih +EXAMPLES +1. Demonstrated uses of the command: + +.nf + votools> topcat status # check if Topcat is running + off + votools> topcat start # start Topcat + votools> topcat status # check if Topcat is running + on + votools> topcat stop # stop Topcat +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +hub, aladin, samp +.endhelp diff --git a/vo/votools/doc/voclient.hlp b/vo/votools/doc/voclient.hlp new file mode 100644 index 00000000..8b5c1773 --- /dev/null +++ b/vo/votools/doc/voclient.hlp @@ -0,0 +1,22 @@ +.help voclient Mar12 votools +.ih +NAME +voclient -- The VO Client / IRAF Interface + +.ih +INTRODUCTION + +.ih +DESCRIPTION + + +.ih +EXAMPLES + +.ih +REVISIONS +.le +.ih +SEE ALSO +conecaller, siapcaller, datascope, registry, vizier +.endhelp diff --git a/vo/votools/doc/vodata.hlp b/vo/votools/doc/vodata.hlp new file mode 100644 index 00000000..25df9068 --- /dev/null +++ b/vo/votools/doc/vodata.hlp @@ -0,0 +1,189 @@ +.help vodata Mar12 votools +.ih +NAME +vodata -- General-purpose query and access to VO data services + +.ih +USAGE +vodata resources objects + +.ih +PARAMETERS +.ls resources +List of resources to query +.le +.ls objects +List of targets to query +.le +.ls ra = 0.0 +Resolved RA (J2000 decimal degrees) +.le +.ls dec = 0.0 +Resolved Dec (J2000 decimal degrees) +.le +.ls size = 0.0 +Query size (decimal degrees) +.le +.ls output = "" +Output filename base +.le +.ls format = "raw" +Output format +.le +.ls samp = yes +Broadcast as samp message? +.le +.ls bandpass = "" +Bandpass constraint +.le +.ls type = "" +Service type constraint +.le +.ls nthreads = 1 +Number of simultaneous query threads +.le +.ls resdb = ")_.resdb" +Resource database +.le +.ls header = yes +List result column headers only? +.le +.ls verbose = 1 +Query verbosity level +.le +.ls quiet = yes +Suppress task output? +.le +.ls status = 0 +Service status code +.le + +.ih +DESCRIPTION + + + + + +.ih +EXAMPLES + +1) Query the GSC 2.3 catalog for stars a) within the 0.1 degree default +search size around NGC 1234: b) around all positions contained in file +'pos.txt': c) for the list of objects given on the command line: d) +query a list of services for a list of positions: e) print a count of +results that would be returned from 3 services for each position in a file: +(f) find the 2MASS point sources in the dev$ypix test image: + +.nf + votools> vodata gsc2.3 ngc1234 (a) + votools> vodata gsc2.3 @pos.txt (b) + votools> vodata gsc2.3 m31,m51,m93 (c) + votools> vodata @svcs.txt @pos.txt (d) + votools> vodata hst,chandra,gsc2.3 @pos.txt (e) + votools> vodata 2mass-psc dev$ypix (f) +.fi + + +2) Query all available image services having data of the subdwarf galaxy +IC 10: + +.nf + votools> vodata any IC10 type="image" * +.fi + +Note that we use the reserved word '\fIany\fR' for the service name and +constrain by image type. The task will automatically query the Registry to +create the list of services to be queried. + + +3) Query for X-ray image data around Abell2712: + +.nf + votools> vodata any abell2712 type="image" bandpass="x-ray" +.fi + +In this case we constrain both the service type as well as the spectral +coverage published for the resource in the Registry. The object name is +resolved to coordinates internally. + + +4) Use the Registry to query for resources using the search terms +"cooling flow". Upon examining the output the user notices a +Vizier paper titled "\fICooling Flows in 207 clusters of Galaxies\fR" +that looks interesting. Use the \fBvodata\fR task to download all +tables associated with this paper, save tables in the default +CSV format: +.nf + + votools> registry "cooling flow" verb+ + votools> vodata J/MNRAS/292/419 output="white97" all+ + +.fi +All tables will be written to the current directory to files having a +root name 'white97' (chosen based on the author and publication date). + + +5) Query for the images available from 2MASS at a given position, +extract the positions and service URLs to separate files: + +.nf + votools> vodata 2mass output="2mass" type="image" ra=12:34 dec=-23:12 + votools> votpos 2mass.xml out="2mass.pos" + votools> votget 2mass.pos +.fi + +The query produces files with the root name '2mass', and extensions of +"\fI.csv\fR" (the main response), "\fI.pos\fR" (the extracted pos- itions), +and "\fI.urls\fR" (the access references). The user inspects the files and +notices that the references return both FITS and HTML files, but she only +wants the FITS image date and uses \fBvotget\fR to download only those. + + +6) Use \fIvodata\fR as a test client for a locally-installed SIAP service: + +.nf + votools> vodata http://localhost/siap.pl type="image" ra=180.0 dec=0.0 +.fi + +In this case we force the serviceURL being used by simply specifying it as +the resource parameter, but since we can't do a Registry query to discover +what type of service this is, we must use the '\fItype\fR' parameter to +indicate it is an image service. + + +7) Use the \fITSELECT\fR task select rows from a VOTable of QSOs (made +with an earlier query) where the redshift is > 0.2. Use \fITDUMP\fR to +print only the positions then call \fIVODATA\fR to see whether HST has +observed any of these objects: + +.nf + votools> tselect qso_survey.xml high_z.fits "Z > 0.2" + votools> tdump high_z.fits columns="RA,DEC" > pos.txt + votools> vodata hstpaec @pos.txt +.fi + + +8) Query the VO for GALEX data of M51. Because the \fIShortName\fR GALEX +is not unique, we must either specify the IVO identifier of a +specific service to query, or if we're interested in results from all +supported data services with \fIgalex\fR in the name: + +.nf + votools> vodata galex M51 all+ output="m51" +.fi + +The results come from the Cone and SIAP services both called \fIGALEX\fR, +as well as an additional SIAP service called 'GALEX_Atlas'. Note that the +service names are case insensitive in either case. + + + + +.ih +REVISIONS +.le +.ih +SEE ALSO +conecaller, siapcaller, datascope, registry, vizier +.endhelp diff --git a/vo/votools/doc/votcopy.hlp b/vo/votools/doc/votcopy.hlp new file mode 100644 index 00000000..f47d4af3 --- /dev/null +++ b/vo/votools/doc/votcopy.hlp @@ -0,0 +1,102 @@ +.help votcopy Mar12 votools +.ih +NAME +votcopy -- Copy VOTables to a new format +.ih +USAGE +votcopy input output format +.ih +PARAMETERS +.ls input +The list of input VOTables. +.le +.ls output +The list of output file names. +.le +.ls format + +.ls vot | xml +A new VOTable. +.le +.ls asv +Ascii separated values. +.le +.ls bsv +Bar separated values. +.le +.ls csv +Comma separated values. +.le +.ls tsv +Tab separated values. +.le +.ls html +Standalone HTML document. +.le +.ls shtml +Single HTML <table> element. This format may be used to generate the <table> +code for inclusion in another HTML document. +.le +.ls fits +FITS binary table +.le + +.le +.ls header = yes +Print a header on formats that support it? +.le +.ls verbose = yes +Print verbose output? +.le + +.ih +DESCRIPTION + + +.ih +EXAMPLES +1. Find the coordinates of M51 (i.e. the dev$pix image): + +.nf + votools> sesame m51 + 13:29:55.72 +47:13:53.4 + + votools> sesame m51 long+ + m51 13:29:52.69 +47:11:42. 0. 0. Sy + + votools> sesame m51 + votools> lpar sesame + target = "m51" Target name to resolve + (verbose = no) Print position to stdout?\n + (pos = "13:29:55.72 +47:13:53.4") Position (sexagesimal string) + (ra = 202.4821936) Resolved RA (J2000 decimal degrees) + (dec = 47.2315089) Resolved DEC (J2000 decimal degrees) + (ra_err = 134.) Error on Resolved RA (arcsec) + (dec_err = 134.) Error on Resolved DEC (arcsec) + (otype = "GPair") Resolved object type description + (status = 0) Resolved DEC (J2000 decimal degrees) + (mode = "ql") +.fi + + +2. Create a local copy of the Messier catalog. + +.nf + votools> for (i=1; i < 100; i=i+1) { + >>> printf ("m%d\n", i) | scan (s1) + >>> sesame (s1, verb-) + >>> printf ("m%d %s %s\n", i, sesame.pos, sesame.otype) + >>> } + + or + + votools> sesame m range="1-110" long+ | fields STDIN "1-3" +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +voclient +.endhelp diff --git a/vo/votools/doc/votget.hlp b/vo/votools/doc/votget.hlp new file mode 100644 index 00000000..cdbf7637 --- /dev/null +++ b/vo/votools/doc/votget.hlp @@ -0,0 +1,107 @@ +.help votget Mar12 votools +.ih +NAME +votget -- Download data referenced in a VOTable +.ih +USAGE +votget input base +.ih +PARAMETERS +.ls input +The list of input VOTables. +.le +.ls base +The base output filename. +.le +.ls extn = "fits" +Filename extension. The \fIextn\fR string will be appended to each +downloaded filename. +.le +.ls format +Format to download. If not a null string and the \fIextn\fR string is a +substring of the value of the column containing the UCD "VOX:Image_Format", +the referenced file will be downloaded. +.le +.ls acref = "VOX:Image_AccessReference" +The UCD of the column containing the image access reference. +.le +.ls col = INDEF +The (one-indexed) column number containing the image access reference. If +specified, the UCD values will be ignored and the specific column will be +used. +.le +.ls sequential = yes +If enabled, sequential file numbers will be appended to the \fIbase\fR +name for each downloaded file. Otherwise, an image name will be constructed +from the access URL. In the latter case, no check is made to prevent +overwriting of files. +.le +.ls nthreads = 4 +Number of simultaneous download threads to execute. +.le +.ls list = no +List access references instead of downloading? Enabling this option may +be used to extract a list of access URLs from the table. +.le + +.ih +DESCRIPTION + +The \fIVOTGET\fR task is used to download data referenced in a VOTable +(e.g. the result of a query to an image or spectral service) to the local +machine. The \fIinput\fR parameter may be a list of VOTables, in which +case the parameters will apply to all files in input the list. The +\fIformat\fR parameter is used to select the image format to download from +the file, it is a case-insensitive substring of the VOTable column +containing the UCD "VOC:Image_Format". If this column does not exist, or +if the \fIformat\fR parameter is the null string, then all images will be +retrieved. The \fIacref\fR parameter parameter specified the UCD that +identifies the access reference to retrieve (i.e. a table may contain +multiple URLs per row, the UCD uniquely identifies the desired data +column), the default value of "VOX:Image_AccessReference" is the standard +value used for current VO data services. Alternatively, the \fIcol\fR +parameter may be used to specify the column number (one-indexed) to +retrieve (e.g. to download other URLs in the table). + +The \fIbase\fR parameter defines the root part of the saved image name, and +\fIextn\fR provides the extension. If the \fIsequential\fR parameter is +set then files will be numbered in the order they were retrieved and saved +to a filename of the form "\fI<base><seqno>.<extn>\fR". Otherwise, a +filename is constructed from the access URL and may or may not be either +unique or helpful. + +Data are retrieved using multiple simultaneous threads in order make most +efficient use of the network and data service. The \fInthreads\fR +parameter determines how many simultaneous downloads will be in progress at +any one time. Once a download completes, a new thread is started until all +files have been retrieved. + +The \fIlist\fR parameter may be used to simply extract a list of URLs from +all of the input tables. When enabled, the \fIbase\fR paramter is not +required and a list of URLs, one per line, will be printed on the standard +output. + + +.ih +EXAMPLES +1. Download all images referenced in the test Simple Image Access service +result table, saved files will + +.nf + votools> votget data$sia.xml test +.fi + +2. Extrace the access URLs from the same table without actually downloading +the files: + +.nf + votools> votget data$sia.xml list+ +.fi + +.ih +REVISIONS +.le +.ih +SEE ALSO +votcopy +.endhelp diff --git a/vo/votools/doc/votpos.hlp b/vo/votools/doc/votpos.hlp new file mode 100644 index 00000000..5a817327 --- /dev/null +++ b/vo/votools/doc/votpos.hlp @@ -0,0 +1,119 @@ +.help votpos Mar12 votools +.ih +NAME +votpos -- Extract the position columns from a VOTable +.ih +USAGE +votpos input +.ih +PARAMETERS +.ls input +The list of input VOTables. +.le +.ls output = STDOUT +The output filename. +.le +.ls ra_col = INDEF +RA column number (one-indexed). If specified as other than INDEF, the named +column will be used instead of the column determined by the primary position +UCD (i.e. 'POS_EQ_RA_MAIN' or 'pos.eq.ra;meta.main'). +.le +.ls dec_col = INDEF +Dec column number (one-indexed). If specified as other than INDEF, the named +column will be used instead of the column determined by the primary position +UCD (i.e. 'POS_EQ_DEC_MAIN' or 'pos.eq.dec;meta.main'). +.le +.ls rows = "-" +A range specification of rows to extract. +.le +.ls header = no +Print a output header? +.le +.ls number = no +Print the row number of each position? If enabled, the output will consist +of the (index,ra,dec) values from the table, otherwise just the (ra,dec) will +be printed. +.le +.ls plot = no +Plot the result table on the standard graphics stream? If enabled, a plot +of the (ra,dec) positions will be drawn to the graphics terminal. +.le +.ls overplot = no +Over an existing display/plot? If enabled, and existing plot will be +appended using the same axis labels and scale. +.le +.ls color = 1 +Plot marker color (in the range 1 to 9). +.le +.ls title = "" +Title string to put on a plot. +.le +.ls verbose = yes +Print verbose output? +.le +.ls status = 0 +Status of the service. A non-zero value indicates no results were found. +.le + +.ih +DESCRIPTION + +The \fIVOTPOS\fR task is used to extract the primary position columns from +a VOTable. These columns are defined by the UCD 'POS_EQ_RA_MAIN' and +'POS_EQ_DEC_MAIN' for Cone Search services, or by 'pos.eq.ra;meta.main' +and 'pos.eq.dec;meta.main' for other VO services. If the \fIra_col\fR +and \fIdec_col\fR parameters are set, the (one-indexed) column number in +the table will be used regardless of the UCD value. Rows of the table +may be selected by specifying a range string to the \fIrows\fR parameter. + +If the \fIheader\fR parameter is enabled, a table header will prepend the +list of extracted positions. If the \fInumber\fR parameter is enabled, +the row number will be printed as the first column of the output. + +A plot of the positions may be displayed by setting the \fIplot\fR parameter. +Subsequent tables may be appended to the plot by specifying the +\fIoverplot\fR parameter. When not overplotting, the \fIcolor\fR parameter +number 1 will always be used, otherwise each overplot will automatically +increment the marker color to make the points a unique color. In all cases, +the marker shape will be a box meaning that when overplotted points are at +the same position they will be drawn in the last color used and may be +confused with earlier points at the same position. A title string may be +put on the plot by specifying the \fItitle\fR parameter. + + +.ih +EXAMPLES +1. Query for catalog positions of NGC188 and extract the (numbered) position +columns to the file 'ngc188.pos'. + +.nf + votools> getcat gsc2.3 ngc188 size=0.1 output="ngc188.xml" + votools> votpos ngc188.xml number+ out="ngc188.pos" +.fi + +2. Use the VOTable is the first example but plot the positions on the +graphics terminal. Overplot a second catalog query of the 2MASS Point +SOurce Catalog without saving the extracted positions. + +.nf + votools> votpos ngc188.xml plot+ out="ngc188.pos" + votools> getcat 2mass-psc ngc188 size=0.1 output="2mass.xml" + votools> votpos 2mass.xml plot+ overplot+ out="" +.fi + +3. Query the GSC 2.3 catalog to overlay an image displayed of the NGC188 field. + +.nf + votools> dss ngc188 size=0.1 + votools> getcat gsc2.3 ngc188 size=0.1 output="ngc188.xml" + votools> votpos ngc188.xml number+ out="ngc188.pos" + votools> taboverlay ngc188 ngc188.pos +.fi + +.ih +REVISIONS +. +.ih +SEE ALSO +getcat, getimg +.endhelp 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 diff --git a/vo/votools/doc/xrayoverlay.hlp b/vo/votools/doc/xrayoverlay.hlp new file mode 100644 index 00000000..c6282909 --- /dev/null +++ b/vo/votools/doc/xrayoverlay.hlp @@ -0,0 +1,65 @@ +.help xrayoverlay Mar12 votools +.ih +NAME +xrayoverlay -- Overlay RASS3 broad-band X-Ray contours in the image display +.ih +USAGE +xrayoverlay image +.ih +PARAMETERS +.ls image +Input image. +.le +.ls size = 0.25 +Field size. +.le +.ls ncontours = 0 +Number of contours to be drawn. If 0, the contour interval may +be specified, otherwise 20-30 nicely spaced contours are +drawn. A maximum of 40 contours can be drawn. +.le +.ls append = yes +Append the display? +.le +.ls verbose = no +Print actions? +.le +.ls device = "imdred" +Overlay device. +.le +.ls status = 0 +Service status code. +.le + +.ih +DESCRIPTION +The \fIRADIOOVERLAY\fR task is used to overlay contours from the RASS3 +broad-band +all-sky survey 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. + +The \fICONTOUR\fR task is used to draw the overlays and should be consulted +to adjust the overlay as desired. + +.ih +EXAMPLES +1. Display an image of m83 and overlay the RASS3 X-Ray contours in the field. + +.nf + votools> xrayoverlay m83 append- + +or + + votools> dss m83 + votools> xrayoverlay m83 append+ +.fi + +.ih +REVISIONS + +.ih +SEE ALSO +nedoverlay, xrayoverlay, obslogoverlay, contour +.endhelp |