aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/votopic.html
blob: 38d7b59c18e37759d4ab3c3f01c5175d02827711 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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">&nbsp;</A>
<H2>NAME</H2>

votopic - Query for data from resources specified by topic keyword
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>votopic</B> [&lt;opts&gt;] &lt;topic&gt; { &lt;object&gt; | &lt;ra&gt; &lt;dec&gt; } [ &lt;size&gt; ]
<P>
<A NAME="lbAD">&nbsp;</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">&nbsp;</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. &quot;galaxies&quot;, &quot;observation
logs&quot;) 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>&lt;topic&gt;</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>&lt;object&gt;fP 
or &lt;ra&gt; &lt;dec&gt;</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">&nbsp;</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">&nbsp;</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">&nbsp;</A>
<H2>BUGS</H2>

No known bugs with this release.
<A NAME="lbAI">&nbsp;</A>
<H2>Revision History</H2>

Feb 2013 - First public release
<A NAME="lbAJ">&nbsp;</A>
<H2>Author</H2>

Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>

vodata, vocatalog, voimage, vospectra, voregistry
<P>

<HR>
<A NAME="index">&nbsp;</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>