diff options
Diffstat (limited to 'vendor/voclient/doc/votopic.html')
| -rw-r--r-- | vendor/voclient/doc/votopic.html | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/vendor/voclient/doc/votopic.html b/vendor/voclient/doc/votopic.html new file mode 100644 index 00000000..38d7b59c --- /dev/null +++ b/vendor/voclient/doc/votopic.html @@ -0,0 +1,126 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOTOPIC</TITLE> +</HEAD><BODY> +<H1>VOTOPIC</H1> +Section: User Commands (1)<BR>Updated: Feb 2013<BR><A HREF="#index">Index</A> +<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR> + +<A NAME="lbAB"> </A> +<H2>NAME</H2> + +votopic - Query for data from resources specified by topic keyword +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>votopic</B> [<opts>] <topic> { <object> | <ra> <dec> } [ <size> ] +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>votopic</I> application accepts the following options: +<DL COMPACT> +<DT><B>-h, --help</B> + +<DD> +Print a help summary to the terminal and exit. No processing is done +following this flag. +<P> +<DT><B>All VODATA task options</B> + +<DD> +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>votopic</I> task is a convenience application built on top of the +<I>vodata</I> and <I>voregistry</I> applications. Its main purpose is to +allow a query for data using logical concepts (e.g. "galaxies", "observation +logs") rather than a specific list of resources. This should limit the +number of resources that need to be queried when querying all data services +and return more relevant results. This is done by using the <I><topic></I> +argument as a keyword search value for the Registry, the resulting resource +list +is then used as input for the VODATA task to query only those resources +returned by the Registry query at the position listed by the <I><object>fP +or <ra> <dec></I> position. As an example, the topic 'AGN' may be used +to query only those resources that claim to have something to do with AGN +as opposed to the many hundreds or thousands more that may not contain data +for that field at all but would be queried anyway using the more generalized +approach of <I>VODATA</I>. +<P> + +The actual effectiveness or suitability of this approach will depend greatly +on the keywords (i.e. <I>topic</I>) chosen and the aims of a specific query. +<P> + +For a complete list of options and a description of the task behavior, see +the <I>VODATA</I> and <I>VOREGISTRY</I> man page. +<P> +<A NAME="lbAF"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>votopic</B> task will return a zero indicating success, or a +one indicating an error. +<P> +<A NAME="lbAG"> </A> +<H2>EXAMPLES</H2> + +<DL COMPACT> +<DT>1) Query for catalog data of A2712 from Resources related to gravitational lensing:<DD> +<P> +<PRE> + % votopic -t catalog lens A2712 +</PRE> + +<DT>This query is against only 142 services (data found for 128), a similar query against ALL catalog services would require more than 8000 services to be queried. This is equivalent to the commands<DD> +<P> +<PRE> + % voregistry -t catalog -d -o lens.xml lens + % vodata lens.xml A2712 +</PRE> + +<DT>Here the 'lens.xml' output file contains the resources to be queried, the '-d' flag says to return only DAL services, the '-t' flag resticts by service type. In the call to VODATA, the 'lens.xml' file defines the 142 resources to be queried, the contraint to service type and DAL-only was done in the registry query that produced the file.<DD> +<P> +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +No known bugs with this release. +<A NAME="lbAI"> </A> +<H2>Revision History</H2> + +Feb 2013 - First public release +<A NAME="lbAJ"> </A> +<H2>Author</H2> + +Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013 +<A NAME="lbAK"> </A> +<H2>SEE ALSO</H2> + +vodata, vocatalog, voimage, vospectra, voregistry +<P> + +<HR> +<A NAME="index"> </A><H2>Index</H2> +<DL> +<DT><A HREF="#lbAB">NAME</A><DD> +<DT><A HREF="#lbAC">SYNOPSIS</A><DD> +<DT><A HREF="#lbAD">OPTIONS</A><DD> +<DT><A HREF="#lbAE">DESCRIPTION</A><DD> +<DT><A HREF="#lbAF">RETURN STATUS</A><DD> +<DT><A HREF="#lbAG">EXAMPLES</A><DD> +<DT><A HREF="#lbAH">BUGS</A><DD> +<DT><A HREF="#lbAI">Revision History</A><DD> +<DT><A HREF="#lbAJ">Author</A><DD> +<DT><A HREF="#lbAK">SEE ALSO</A><DD> +</DL> +<HR> +This document was created by +<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>, +using the manual pages.<BR> +Time: 05:13:27 GMT, April 14, 2013 +</BODY> +</HTML> |