/[volute]/trunk/projects/dal/SCS/SCS.tex
ViewVC logotype

Contents of /trunk/projects/dal/SCS/SCS.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4464 - (show annotations)
Mon Oct 9 12:02:59 2017 UTC (2 years, 11 months ago) by molinaro
File MIME type: application/x-tex
File size: 39011 byte(s)
scs-1.1: typos and minimal wording changes

1 \documentclass[11pt,a4paper]{ivoa}
2 \input tthdefs
3
4 \usepackage{todonotes}
5 \usepackage{enumitem}
6
7 \usepackage{listings}
8 \lstloadlanguages{XML,sh}
9 \lstset{flexiblecolumns=true,tagstyle=\ttfamily,
10 showstringspaces=False}
11
12 \usepackage{multirow}
13
14 \title{Simple Cone Search}
15
16 \ivoagroup{Data Access Layer}
17
18 \author[http://www.ivoa.net/twiki/bin/view/IVOA/RayPlante]{Raymond Plante}
19 \author[http://www.ivoa.net/twiki/bin/view/IVOA/MarcoMolinaro]{Marco Molinaro}
20 \author[http://www.ivoa.net/twiki/bin/view/IVOA/MarkusDemleitner]{Markus Demleitner}
21 \author[http://www.ivoa.net/twiki/bin/view/IVOA/BobHanisch]{Robert Hanisch}
22 \author[http://www.ivoa.net/twiki/bin/view/IVOA/AlexSzalay]{Alex Szalay}
23 \author[http://www.ivoa.net/twiki/bin/view/IVOA/RoyWilliams]{Roy Williams}
24
25 \editor{Ray Plante, Marco Molinaro}
26
27 \previousversion[http://www.ivoa.net/Documents/REC/DAL/ConeSearch-20080222.html]{REC 1.03}
28 \previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070914.html]{PR 2007-09-14}
29 \previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070628.html]{PR 2007-06-28}
30 \previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20060908.html]{PR 2006-09-08}
31
32
33 \begin{document}
34 \begin{abstract}
35 This specification defines a simple query protocol, named Simple Cone Search (SCS or simply cone search hereafter), for retrieving records from a catalog of astronomical sources. The query describes a sky position and an angular distance, defining a cone on the sky. The response returns a list of astronomical sources from the catalog whose positions lie within the cone, formatted as a VOTable. This version aims essentially at aligning this specification with the Data Access Layer (DAL) landscape at the time of writing.
36 \end{abstract}
37
38
39 \section*{Acknowledgments}
40 This document was originally published as a document of the US National Virtual Observatory (NVO) \todo{check if the document or a link is still available} and then transcripted into an IVOA standards document format to became an IVOA recommendation. The changes made in this transcription and in the process of producing the first recommendation are reported in Appendix \ref{app:changes}.
41
42 The Simple Cone Search (SCS) version 1.03 document has been developed with support from the National Science Foundation's Information Technology Research Program under Cooperative Agreement AST0122449 with The Johns Hopkins University.
43
44 The SCS-1.1 revision has been developed under the ASTERICS project, supported by the European Commission Framework Programme Horizon 2020 Research and Innovation action, grant agreement n. 653477.
45
46 Work of the original authors of the Cone Search specification as well as the numerous data providers who have implemented and continue to support this protocol is kindly acknowledged.
47
48 \section*{Conformance-related definitions}
49
50 The words ``MUST'', ``SHALL'', ``SHOULD'', ``MAY'', ``RECOMMENDED'', and
51 ``OPTIONAL'' (in upper or lower case) used in this document are to be
52 interpreted as described in IETF standard RFC2119 \citep{std:RFC2119}.
53
54 The \emph{Virtual Observatory (VO)} is a
55 general term for a collection of federated resources that can be used
56 to conduct astronomical research, education, and outreach.
57 The \href{http://www.ivoa.net}{International
58 Virtual Observatory Alliance (IVOA)} is a global
59 collaboration of separately funded projects to develop standards and
60 infrastructure that enable VO applications.
61
62
63 \section{Introduction}
64
65 This specification describes how a provider of an astronomical source catalog can publish that catalog to the Virtual Observatory in such a way that a simple cone search can be done. The data remains in the control of the data provider, served through a web server to the world, but the query profile and response profile are carefully controlled, as described below. It is intended that setting up this web service be simple enough that data providers will not have to spend too much time on it (their funding to support such services is typically small). At the same time, the service implementation and the data it provides can serve as a basis for more sophisticated tools.
66
67 This specification does not specify how cone search services are implemented, or how the data are stored or manipulated. The concern of this specification is how the data are exposed to the world through well-defined requests and responses.
68
69 This specification assumes that the data provider has already selected a catalog of astronomical sources. This catalog can be presented as a single table; it is expected that the table contains several columns.
70
71 \subsection{Role within the VO Architecture}
72
73 \begin{figure}
74 \centering
75
76 % Get the architecture diagram from the TCG chair
77 % http://wiki.ivoa.net/twiki/bin/view/IVOA/IvoaTCG
78 % If they give you a PDF, for now dumb it down to a png by
79 % convert -antialias -density 72x72 archdiag.pdf archdiag.png
80 % Oh -- Notes don't need this; you'd have to remove archdiag.png
81 % from FIGURES in the Makefile, too.
82
83 \includegraphics[width=0.9\textwidth]{archdiag.png}
84 \caption{Architecture diagram for SCS - TODO}
85 \label{fig:archdiag}
86 \end{figure}
87
88 Fig.~\ref{fig:archdiag} shows the role this document plays within the
89 IVOA architecture \citep{note:VOARCH}.
90
91 \section{Resource}
92 \label{sec:resif}
93
94 A SCS service for accessing catalogue resources is implemented as a synchronous resource, as compliant as possible to the DALI specification \citep{std:DALI}.
95
96 \begin{table}[th]
97 \begin{center}
98 \begin{tabular}{p{0.25\textwidth}p{0.25\textwidth}p{0.25\textwidth}}
99 \sptablerule
100 \textbf{resource type}&\textbf{resource name}&\textbf{required}\\
101 \sptablerule
102 \{query\} & service specific & yes\\
103 VOSI-capabilities & /capabilities & should\\
104 VOSI-availability & (/availability) & should\\
105 \sptablerule
106 \label{table:resources}
107 \end{tabular}
108 \caption{SCS resources tree}
109 \end{center}
110 \end{table}
111
112 It \textbf{must} have one \{query\} resource and \textbf{should} have a VOSI-capability resource and a VOSI-availability one. The VOSI-capability \textbf{must} be a sibling to the \{query\} one.
113
114 \subsection{\{query\} resource}
115 \label{sec:basepar}
116 The SCS \{query\} resource \textbf{must} meet the following requirements:
117 \begin{itemize}
118 \item the resource \textbf{must} respond to requests submitted using an HTTP GET query string, and \textbf{should} respond to HTTP POST query actions (as described in later in this same section);
119 \item the response, by default, \textbf{must} be a valid VOTable document, providing a table containing the sources of the catalogue whose positions are within the cone described in the query request (see Sec.~\ref{sec:response});
120 \item in case of error, the response \textbf{must} follow prescriptions as described in Sec.~\ref{sec:error}.
121 \end{itemize}
122
123 The SCS service \texttt{\{query\}} resource is a synchronous web resource, as described by DALI, of the form
124 $$\hbox{\nolinkurl{http://<server>/<local_path>?} }$$
125 To this base URL the query parameters, described hereafter, are attached to build the query request to be submitted through HTTP.
126
127 Usage of fixed, custom query parameters, defined by the service provider to build a base URL of the form
128 $$\hbox{\nolinkurl{http://<server>/<local_path>?<base\_query>&}}$$
129 (standard behaviour of base URLs in SCS-1.03) is allowed but \textbf{deprecated} in order to bring cone searches base URLs in the common ReST shape promoted by DALI. Clients \textbf{must} anyway treat opaquely these fixed \texttt{<base\_query>} additions.
130
131 In the case of HTTP POST action, the behaviour of SCS services having the deprecated base URL format (including custom extra parameters) is not specified. It is however suggested to adopt a mixed GET/POST solution, so the let the fixed \texttt{<base\_query>} arguments always be submitted in the query part of the HTTP request.
132
133 On the opposite, services having plain \texttt{\{query\}} base URLs as mandated by this specification are highly encouraged to support HTTP POST method in order to fulfill DALI compliance.
134
135 The set of query constraints a cone search needs to understand \textbf{must} include the \textbf{RA}, \textbf{DEC}, \textbf{SR} parameters, \textbf{should} include the \textbf{MAXREC} and \textbf{RESPONSEFORMAT} ones and \textbf{may} include the \textbf{VERB} one, all of which are to be interpreted with the following stated meaning and the DALI recommendations about parameters.
136
137 \subsubsection{RA}
138 \textbf{RA} represents a right-ascension in the ICRS coordinate system for the position of the center of the cone to search, given in decimal degrees. It is a single valued parameter and \textbf{must} be present in the query.
139
140 \subsubsection{DEC}
141 \textbf{DEC} represents a declination in the ICRS coordinate system for the position of the center of the cone to search, given in decimal degrees. It is a single value parameter and \textbf{must} be present in the query.
142
143 \subsubsection{SR}
144 \textbf{SR} represents the radius of the cone to search, given in decimal degrees. It is a single valued parameter and \textbf{must} be present in the query. If set to zero (SR=0) it should have the same effect as setting MAXREC=0, i.e. a service metadata request as prescribed by DALI\footnote{SR=0 is kept in this version of this specification for back compatibility. It is suggested to prefer the usage of MAXREC to enable metadata discovery}.
145
146 \subsubsection{MAXREC}
147 As defined by DALI a cone search \textbf{should} accept the \textbf{MAXREC} parameter to let the client limit the number of records returned or require a service metadata response (see above). Its usage is encouraged and preferred to the SR=0 solution for metadata discovery.
148
149 \subsubsection{RESPONSEFORMAT}
150 \label{subsubsec:responseformat}
151 An SCS service \textbf{must} provide responses in VOTable \citep{std:VOTABLE} format, compliant with respect to what will be detailed in Sec.~\ref{sec:response}, but \textbf{should} also support the DALI \textbf{RESPONSEFORMAT} parameter. Allowed media types for VOTable response \textbf{should} be the \texttt{application/x-votable+xml} or \texttt{text/xml} as specified by DALI but \texttt{text/xml;content=x-votable} may be considered legal for backward compatibility reasons.
152
153 \subsubsection{VERB}
154 The query \textbf{may} contain the optional single valued parameter, \textbf{VERB}, whose value is an integer (either 1, 2, or 3) indicating verbosity which determines how many columns are to be returned in the resulting table. If the service supports the parameter, then when the value is 1, the response should include the bare minimum of columns that the provider considers useful in describing the returned objects (while still remaining compliant with this standard; see section \ref{sec:response} below). When the value is 3, the service should return all of the columns that are available for describing the objects. A value of 2 is intended for requesting a medium number of columns between the minimum and maximum (inclusive) that are considered by the provider to most typically useful to the user. When the VERB parameter is not provided, the server should respond as if VERB=2. If the VERB parameter is not supported by the service, the service should ignore the parameter and should always return the same set of columns for every request.
155
156 There may be other parameters in the query, but this document does not specify their meaning or usage. If a query includes an optional parameter, either one specified by this document or not, that is not supported by the service implementation, the service must ignore that parameter.\todo{MMo: I don't think I like this idea, it sound like failing silently}
157
158 A query following this syntax represents a request for information on sources located within the specified cone on the sky.
159
160 \subsection{Query examples}
161 \begin{bigdescription}
162 \item[Minimal SCS query] \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=0.01}
163 \item[Service Metadata query] \nolinkurl{http://my.cone/search?cat=A1\&RA=0\&DEC=0\&SR=0\&MAXREC=0}
164 \item[Limit number of records in response] \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=1\&MAXREC=100}
165 \item[Ask for the minimal set of response fields] \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=0.01\&VERB=1}
166 \end{bigdescription}
167
168 \subsection{Availability: VOSI-availability}
169 A web service with SCS capabilities \textbf{should} have a VOSI-availability resource as described in DALI. Since VOSI relaxed the availability endpoint, letting it be located elsewhere than being a sibling to the service base URL, support for this interface is encouraged even in the case of services having base URL of the deprecated form.
170
171 \subsection{Capabilities: VOSI-capabilities}
172 A web service with SCS capabilities must have a VOSI-capabilities resource as described in DALI. The standardID for the {query} capability is reported, among other details and recommendations in Sec.~\ref{subsec:capability}.
173
174 Services that present the \texttt{\{query\}} base URL as a plain ReST resource without additional opaque query parameters are strongly encouraged to provide a capabilities endpoint as a sibling to the \texttt{\{query\}} resource. The capabilities resource may be unfeasible to maintain for services exposing a base URL with the deprecated format.
175
176 \section{Successful Response}
177 \label{sec:response}
178 A successful query \textbf{must} result in an HTTP response with status code 200 (OK) and a content that, by default, \textbf{must} be in VOTable format (version 1.0 or later), that represents a table of astronomical sources whose positions are within the cone (see Appendix \ref{app:responsesample} for an example)\todo{Example needs to be rebuild.}.
179
180 There may also be other sources outside the cone, the service implementor may decide on the exact search criterion used internally to the service to select the sources.
181
182 The response format may be other than VOTable when requested using the RESPONSEFORMAT query parameter described in Sec.~\ref{subsubsec:responseformat}. Mime-type of the response will vary accordingly to the output format, again as prescribed by DALI and reported in Sec.~\ref{subsubsec:responseformat}.
183
184 \subsection{VOTable compliant response}
185
186 In the case the service response is serialised in the default, VOTable, format, this response \textbf{MUST} comply with the following requirements.
187
188 There \textbf{must} be a single \xmlel{RESOURCE} with \xmlel{type}=\texttt{"results"}\todo{Do current cone services use this attribute? Update: no, most SCS-1.03 services do not.} in the VOTable, and containing a single \xmlel{TABLE}\todo{should we relax on the number of tables? Discuss this with apps.}.
189
190 The \xmlel{TABLE} \textbf{must} have \xmlel{FIELD}s where the following UCD values have been set. There \textbf{must} only be one \xmlel{FIELD} with each of these UCDs:
191 \begin{itemize}
192 \item \textbf{Exactly one} \xmlel{FIELD} \textbf{must} have \xmlel{ucd}=\texttt{"ID\_MAIN"}, with an array character type (fixed or variable length), representing an ID string for that record of the table. This identifier \textbf{may not} be repeated in the table, and it could be used to retrieve that same record again from that same table.
193 \item \textbf{Exactly one} \xmlel{FIELD}, representing the right ascension of the source in the ICRS coordinate system, \textbf{must} have \xmlel{ucd}=\texttt{"POS\_EQ\_RA\_MAIN"}, and have \xmlel{datatype} set to \texttt{"float"} or \texttt{"double"}.
194 \item \textbf{Exactly one} \xmlel{FIELD}, representing the declination of the source in the ICRS coordinate system, \textbf{must} have \xmlel{ucd}=\texttt{"POS\_EQ\_DEC\_MAIN"}, and have \xmlel{datatype} set to \texttt{"float"} or \texttt{"double"}.
195 \end{itemize}
196
197 The VOTable may include an expression of the uncertainty of the positions given in the above mentioned fields to be interpreted either as a positional error of the source positions, or an angular size if the sources are resolved. If this uncertainty is not provided, it should be taken to be zero; otherwise, it may be set for all table entries with a \xmlel{PARAM} in the \xmlel{RESOURCE} which has a UCD that is set to OBS\_ANG-SIZE and has a value which is the angle in decimal degrees. Alternatively, a different value for each row in the table can be given via a \xmlel{FIELD} in the table having a UCD set to OBS\_ANG-SIZE.
198 There may be other \xmlel{FIELD}s in the table. Their specification \textbf{should} include description, datatype, and UCD.\todo{A solution to move to UCD1+ would be nice, but it should probably be postponed to a major revision.}
199
200 \section{Error Response}
201 \label{sec:error}
202
203 If the service detects an exceptional condition, it \textbf{should} return an error document with an appropriate status code, as specified by DALI, with, possibly, a Content-Type header to tell the client the format of the document.
204
205 In the case the error is expressed in VOTable format, recommendation expressed in Section 4.4 of DALI (currently version 1.1) \textbf{should} be followed, inluding the overflow behaviour in the case the MAXREC parameter is in use.
206
207 Errors \textbf{must} be reported in case any one of the three required paramaters (RA, DEC, SR) is missing,
208 or if their values cannot be parsed to floating-point numbers, or if the numbers are out of range (DEC=91.0, for example).
209
210 The service \textbf{may} also return an error if the search radius (given by the SR parameter) is larger than the one set by the \xmlel{maxSR} element child of the \xmlel{capability} one of the service described as a VO resource (see Sec.~\ref{sec:regext}).
211
212 The service \textbf{may}, as an alternative, report exceptions using the profile expressed by the previous SCS recommendation \citep[v1.03]{std:SCS}. This alternative for error reporting is to be considered \textbf{deprecated}, being the purpose of this specification to fill in the gap of the SCS protocol with the general DAL landscape. The way the alternative works is detailed in Sec.~\ref{subsec:err103} here below.
213
214 \subsection{(\textbf{deprecated}) Alternative Error Response}
215 \label{subsec:err103}
216 In the case of error, the service \textbf{must} respond with a VOTable that contains a single \xmlel{PARAM} element or a single \xmlel{INFO} element with \xmlel{name}=\texttt{"Error"}, where the corresponding \xmlel{value} attribute should contain some explanation of the nature of the error. If an \xmlel{INFO} element is used, it must appear as a direct child of one of the following elements:
217 \begin{itemize}
218 \item the root \xmlel{VOTABLE} element (which is preferred by this document), or
219 \item the \xmlel{RESOURCE} element
220 \end{itemize}
221
222 If a \xmlel{PARAM} element is used, it must appear as a direct child of the \xmlel{RESOURCE} element.\todo{Removed reference to the DEFINITION element solution, definitely out of VOTable since long.} Please note that, apart from being deprecated here, the use of the \xmlel{PARAM} element to convey error response was already discouraged in the previous version of this specification.
223
224 \begin{bigdescription}
225 \item[Example Error Responses] Error INFO as child of VOTABLE (preferred)\\
226 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
227 <?xml version="1.0"?>
228 <!DOCTYPE VOTABLE SYSTEM "http://us-vo.org/xml/VOTable.dtd">
229 <VOTABLE version="1.0">
230 <DESCRIPTION>MAST Simple Cone Search Service</DESCRIPTION>
231 <INFO ID="Error" name="Error" value="Error in input RA value: as3f"/>
232 </VOTABLE>
233 \end{lstlisting}
234 Error PARAM as child of RESOURCE (allowed)
235 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
236 <?xml version="1.0"?>
237 <!DOCTYPE VOTABLE SYSTEM "http://us-vo.org/xml/VOTable.dtd">
238 <VOTABLE version="1.0">
239 <DESCRIPTION>
240 HEASARC Browse data service
241 Please send inquiries to mailto:request@athena.gsfc.nasa.gov
242 </DESCRIPTION>
243 <RESOURCE ID="error_resource">
244 <PARAM ID="Error" name="Error" datatype="char" arraysize="*"
245 value="Invalid data type: text/html"/>
246 </RESOURCE>
247 </VOTABLE>
248 \end{lstlisting}
249 \end{bigdescription}
250
251 Queries targeting no records \textbf{should not} generate an error response, but an empty metadata response.\todo{Does it make sense to keep this sentence, shortened from the previous version? MMo guess: no}
252
253 \section{Resource Registry Extension}
254 \label{sec:regext}
255
256 \begin{admonition}{Note}
257 The content of \textbf{Section \ref{sec:regext}} is taken from REC-SimpleDALRegExt-1.1, sections 1, 2 and 3, specifically section 3.1 that is dedicated to the Simple Cone Search case.
258 \end{admonition}
259
260 To adequately describe that a service supports the Simple Cone Search protocol, it is necessary to define SCS specific capability metadata. This is needed both to allow discovery of cone search services within VO registered resources (through the Registry Interfaces standard, \citet{std:RI1}, deploying VOResource documents, \citet{std:VOR}) and to generally describe service behaviour to help applications consume it properly, given compliance to the protocol.
261
262 This section specifies these metadata for cone search resources and is intended to be applicable wherever VOResource records are used, in particular for standard encoding of resource descriptions within IVOA registries and for encoding capability metadata available through VOSI \citep{std:VOSI11} interfaces.
263
264 Apart from the above standards referenced here above, this registry extension depends on the VODataService \citep{std:VODS11} standard.
265
266 \subsection{Resource record and Capability requirements}
267 To be recognized as a SCS, the service resource must be described as a resource of type \xmlel{vr:Service} (defined in the VOResource schema) or one of its legal sub-types. The resource type is set by setting the \xmlel{xsi:type} attribute on the element representing the root of the VOResource record to the namespace-qualified resource type name. SCS \textbf{should} be of the resource type \xmlel{vs:CatalogService} (defined in the VODataService extension schema)\footnote{\xmlel{vr:} and \xmlel{vs:} are the canonical prefixes for the namespaces associated with VOResource and VODataService XML schemata}.
268
269 Since the \xmlel{vs:CatalogService} resource type allows it, record authors are encouraged to include a full description of the columns in the table returned in query response (assuming full verbosity), as well as to provide sky coverage information.
270
271 \subsubsection{Capability}
272 \label{subsec:capability}
273 The VOResource record \textbf{must} include a \xmlel{capability} element that \textbf{must} have a \xmlel{standardID} attribute set to
274 $$\hbox{\nolinkurl{ivo://ivoa.net/std/conesearch#query-1.1}}$$
275 to unambiguously identify the resource as a Simple Cone Search compliant to SCS-1.1 version. The \xmlel{capability} \textbf{should} also have \xmlel{xsi:type="cs:ConeSearch"} to specialize the \xmlel{vr:Capability} to be of the specific sub-type supporting the cone search protocols. The \xmlel{cs:} here refers to the canonical prefix for the namespace associated with the SCS extension schema, that is
276 $$\hbox{\nolinkurl{http://www.ivoa.net/xml/ConeSearch/v1.0} ,}$$
277 the same as for SCS-1.03, as explained in the XML Schema Versioning \citep{note:schemaversioning} document; distinction among the two schemata version being delivered by the \xmlel{version} attribute in the schema root element.
278
279 The \xmlel{cs:ConeSearch} type is described in Sec.~\ref{subsec:cstype}.
280
281 \subsubsection{Interface}
282 The \xmlel{capability} element described in Sec.~\ref{subsec:capability} \textbf{must} include a child \xmlel{interface} element.
283 The \xmlel{interface} element \xmlel{xsi:type} attribute \textbf{must} be set to \texttt{vs:ParamHTTP}, and its \xmlel{role} attribute \textbf{must} be set to \texttt{"std"}. A \xmlel{accessURL} element within that
284 \xmlel{interface} \textbf{must} be set to the \xmlel{<base\_url>} of the service (see \ref{sec:basepar}).
285
286 It is not necessary to provide the \xmlel{use} attribute to the
287 \xmlel{accessURL} element (as its value can be assumed); however, when
288 it is provided, it must be set to \texttt{"base"}. Similarly, it is not
289 necessary to provide the \xmlel{interface} element with
290 \xmlel{queryType} or \xmlel{resultType} elements; however, when
291 provided, their values should be \texttt{"GET"} and
292 \texttt{"application/x-votable+xml"}, respectively. The
293 \xmlel{vs:ParamHTTP} allows one to describe input parameters supported
294 by the service; description authors are encouraged to list the optional
295 parameters and any custom parameters supported by the instance of the
296 service.
297
298 \subsubsection{\textit{cs:}ConeSearch}
299 \label{subsec:cstype}
300 The \xmlel{cs:ConeSearch} type is a \xmlel{vr:Capability} sub-type that should be used
301 to describe a service's support for the Simple Cone Search protocol;
302 it is defined as follows:
303
304 % GENERATED: !schemadoc ConeSearch-v1.1.xsd ConeSearch
305 \begin{generated}
306 \begingroup
307 \renewcommand*\descriptionlabel[1]{%
308 \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{cs:ConeSearch} Type Schema Documentation}
309
310 \noindent{\small
311 The capabilities of a Cone Search implementation.
312 \par}
313
314 \vspace{1ex}\noindent\textbf{\xmlel{cs:ConeSearch} Type Schema Definition}
315
316 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
317 <xs:complexType name="ConeSearch" >
318 <xs:complexContent >
319 <xs:extension base="vr:Capability" >
320 <xs:sequence >
321 <xs:element name="maxSR" type="xs:float" minOccurs="0"
322 maxOccurs="1" />
323 <xs:element name="maxRecords" type="xs:positiveInteger"
324 minOccurs="0" maxOccurs="1" />
325 <xs:element name="verbosity" type="xs:boolean" />
326 <xs:element name="testQuery" type="cs:Query" minOccurs="0"
327 maxOccurs="1" />
328 </xs:sequence>
329 </xs:extension>
330 </xs:complexContent>
331 </xs:complexType>
332 \end{lstlisting}
333
334 \vspace{0.5ex}\noindent\textbf{\xmlel{cs:ConeSearch} Extension Metadata Elements}
335
336 \begingroup\small\begin{bigdescription}\item[Element \xmlel{maxSR}]
337 \begin{description}
338 \item[Type] floating-point number: \xmlel{xs:float}
339 \item[Meaning]
340 The largest search radius, in degrees, that will be
341 accepted by the service without returning an error
342 condition. Not providing this element or
343 specifying a value of 180 indicates that there
344 is no restriction.
345
346 \item[Occurrence] optional
347 \item[Comment]
348 Not providing a value is the prefered way to indicate
349 that there is no restriction.
350
351
352 \end{description}
353 \item[Element \xmlel{maxRecords}]
354 \begin{description}
355 \item[Type] \xmlel{xs:positiveInteger}
356 \item[Meaning]
357 The largest number of records that the service will
358 return. Not providing this value means that
359 there is no effective limit.
360
361 \item[Occurrence] optional
362 \item[Comment]
363 This does not refer to the total number of records in
364 the catalog but rather maximum number of records the
365 service is capable of returning. A limit that is
366 greater than the number of records available in the
367 archive is equivalent to their being no effective
368 limit. (See RM, Hanisch 2007.)
369
370
371 \end{description}
372 \item[Element \xmlel{verbosity}]
373 \begin{description}
374 \item[Type] boolean (true/false): xs:boolean
375 \item[Meaning]
376 True if the service supports the VERB keyword;
377 false, otherwise.
378
379 \item[Occurrence] required
380
381 \end{description}
382 \item[Element \xmlel{testQuery}]
383 \begin{description}
384 \item[Type] composite: \xmlel{cs:Query}
385 \item[Meaning]
386 A query that will result in at least one
387 matched record that can be used to test the
388 service.
389
390 \item[Occurrence] optional
391
392 \end{description}
393
394
395 \end{bigdescription}\endgroup
396
397 \endgroup
398 \end{generated}
399
400 % /GENERATED
401
402 The custom metadata that the \xmlel{cs:ConeSearch} type provides is given
403 above. Other genaral metadata useful to describe the SCS
404 specification are directly part of the core VOResource schema.
405
406 \subsubsection{testQuery and the Query Type}
407
408 The \xmlel{testQuery} element is intended to help other VO components (e.g.
409 registries, validation services, services that monitor the VO's
410 operational health, but typically not end users) test that the service
411 is up and operating correctly. It provides a set of legal input
412 parameters that should return a legal response that includes at least
413 one matched record. Since this query is intended for testing purposes,
414 the size of the result set should be small.
415
416 The \xmlel{cs:Query} type captures the different components of the query into
417 separate elements, as defined below:
418
419 % GENERATED: !schemadoc ConeSearch-v1.1.xsd Query
420 \begin{generated}
421 \begingroup
422 \renewcommand*\descriptionlabel[1]{%
423 \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{cs:Query} Type Schema Documentation}
424
425 \noindent{\small
426 A query to be sent to the service
427 \par}
428
429 \vspace{1ex}\noindent\textbf{\xmlel{cs:Query} Type Schema Definition}
430
431 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
432 <xs:complexType name="Query" >
433 <xs:sequence >
434 <xs:element name="ra" type="xs:double" />
435 <xs:element name="dec" type="xs:double" />
436 <xs:element name="sr" type="xs:double" />
437 <xs:element name="verb" type="xs:positiveInteger" minOccurs="0" />
438 <xs:element name="catalog" type="xs:string" minOccurs="0" />
439 <xs:element name="extras" type="xs:string" minOccurs="0" />
440 </xs:sequence>
441 </xs:complexType>
442 \end{lstlisting}
443
444 \vspace{0.5ex}\noindent\textbf{\xmlel{cs:Query} Metadata Elements}
445
446 \begingroup\small\begin{bigdescription}\item[Element \xmlel{ra}]
447 \begin{description}
448 \item[Type] floating-point number: \xmlel{xs:double}
449 \item[Meaning]
450 the right ascension of the search cone's center in
451 decimal degrees.
452
453 \item[Occurrence] required
454
455 \end{description}
456 \item[Element \xmlel{dec}]
457 \begin{description}
458 \item[Type] floating-point number: \xmlel{xs:double}
459 \item[Meaning]
460 the declination of the search cone's center in
461 decimal degrees.
462
463 \item[Occurrence] required
464
465 \end{description}
466 \item[Element \xmlel{sr}]
467 \begin{description}
468 \item[Type] floating-point number: \xmlel{xs:double}
469 \item[Meaning]
470 the radius of the search cone in decimal degrees.
471
472 \item[Occurrence] required
473
474 \end{description}
475 \item[Element \xmlel{verb}]
476 \begin{description}
477 \item[Type] \xmlel{xs:positiveInteger}
478 \item[Meaning]
479 the verbosity level to use where 1 means the bare
480 minimum set of columns and 3 means the full set of
481 available columns.
482
483 \item[Occurrence] optional
484
485 \end{description}
486 \item[Element \xmlel{catalog}]
487 \begin{description}
488 \item[Type] string: \xmlel{xs:string}
489 \item[Meaning]
490 the catalog to query.
491
492 \item[Occurrence] optional
493 \item[Comment]
494 When the service can access more than one catalog,
495 this input parameter, if available, is used to
496 indicate which service to access.
497
498
499 \end{description}
500 \item[Element \xmlel{extras}]
501 \begin{description}
502 \item[Type] string: \xmlel{xs:string}
503 \item[Meaning]
504 any extra (non-standard) parameters that must be
505 provided (apart from what is part of base URL given
506 by the accessURL element).
507
508 \item[Occurrence] optional
509 \item[Comment]
510 this value should be in the form of name=value
511 pairs delimited with ampersands (\&).
512
513
514 \end{description}
515
516
517 \end{bigdescription}\endgroup
518
519 \endgroup
520 \end{generated}
521
522 \todo{attach xsd?}
523
524 \appendix
525 \section{Sample VOTable Response}
526 \label{app:responsesample}
527 This is a sample of a legal response to a Cone Search query.\todo{Needs to be changed}
528 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
529 <?xml version="1.0"?>
530 <!DOCTYPE VOTABLE SYSTEM "http://us-vo.org/xml/VOTable.dtd">
531 <VOTABLE version="1.0">
532 <DEFINITIONS>
533 <COOSYS system="eq_FK5" equinox="2000" />
534 </DEFINITIONS>
535 <RESOURCE ID="T9001">
536 <DESCRIPTION>
537 HEASARC Browse data service
538 Please send inquiries to mailto:request@athena.gsfc.nasa.gov
539 </DESCRIPTION>
540 <PARAM ID="default_search_radius" ucd="OBS_ANG-SIZE" datatype="double"
541 value="0.0516666666666667" />
542 <TABLE ID="heasarc_first_9001">
543 <DESCRIPTION> Faint Images of the Radio Sky at Twenty cm Source Catalog (FIRST) </DESCRIPTION>
544 <FIELD name="unique_id" datatype="char" arraysize="*" ucd="ID_MAIN">
545 <DESCRIPTION> Integer key </DESCRIPTION>
546 </FIELD>
547 <FIELD name="name" datatype="char" arraysize="*" >
548 <DESCRIPTION> FIRST Source Designation </DESCRIPTION>
549 </FIELD>
550 <FIELD name="ra" datatype="double" unit="degree" ucd="POS_EQ_RA_MAIN">
551 <DESCRIPTION> Right Ascension </DESCRIPTION>
552 </FIELD>
553 <FIELD name="dec" datatype="double" unit="degree" ucd="POS_EQ_DEC_MAIN">
554 <DESCRIPTION> Declination </DESCRIPTION>
555 </FIELD>
556 <FIELD name="flux_20_cm" datatype="double" unit="mJy" >
557 <DESCRIPTION> Peak 1.4GHz Flux Density (mJy) </DESCRIPTION>
558 </FIELD>
559 <FIELD name="flux_20_cm_error" datatype="double" unit="mJy" >
560 <DESCRIPTION> Estimated rms in at Source (mJy) </DESCRIPTION>
561 </FIELD>
562 <FIELD name="int_flux_20_cm" datatype="double" unit="mJy" >
563 <DESCRIPTION> Integrated 1.4GHz Flux Density (mJy) </DESCRIPTION>
564 </FIELD>
565 <DATA>
566 <TABLEDATA>
567 <TR>
568 <TD>384559</TD><TD>FIRST J120002.6+595708</TD>
569 <TD>180.0110042</TD><TD>59.9523889</TD>
570 <TD> 1.11</TD><TD> 0.139</TD><TD> 1.14</TD>
571 </TR>
572 <TR>
573 <TD>385094</TD><TD>FIRST J120025.3+600103</TD>
574 <TD>180.1057250</TD><TD>60.0175556</TD>
575 <TD> 2.89</TD><TD> 0.142</TD><TD> 2.56</TD>
576 </TR>
577 <TR>
578 <TD>384928</TD><TD>FIRST J120018.1+600236</TD>
579 <TD>180.0755500</TD><TD>60.0434750</TD>
580 <TD> 19.38</TD><TD> 0.145</TD><TD> 19.23</TD>
581 </TR>
582 <TR>
583 <TD>384490</TD><TD>FIRST J115959.4+600403</TD>
584 <TD>179.9978875</TD><TD>60.0677083</TD>
585 <TD> 1.01</TD><TD> 0.147</TD><TD> 1.20</TD>
586 </TR>
587 </TABLEDATA>
588 </DATA>
589 </TABLE>
590 </RESOURCE>
591 </VOTABLE>
592 \end{lstlisting}
593
594 \section{Changes from Previous Versions}
595 \label{app:changes}
596
597 \subsection{Changes from REC-1.03}
598 \begin{itemize}[noitemsep]
599 \item moving base URL to a plain http://server/path? format
600 \item changed error response to comply with DALI
601 \item changed resource metadata importing directly from SimpleDALRegExt
602 \item relaxed RA and Dec FIELDs in response to allow float or double datatype
603 \item no more exactly one RESOURCE in response, now stating exactly one of type="results"
604 \item removed fixed version (1.0 or 1.1) for VOTable default response
605 \item Added DALI MAXREC and RESPONSEFORMAT
606 \item Added POST as optional HTTP query method
607 \item Addition of authors/editors.
608 \item Plain porting of the HTML document into ivoatex template, including change history, then modified it and reshaped.
609 \end{itemize}
610
611 \subsection{Changes from PR-1.02}
612 \begin{itemize}[noitemsep]
613 \item converted to Recommendation
614 \end{itemize}
615
616 \subsection{Changes from PR-1.01}
617 \begin{itemize}[noitemsep]
618 \item eliminated the choice of encoding an ERROR response in a PARAM that is a direct child of VOTABLE as this is not legal in the VOTable schema.
619 \item Allowed the use of the INFO element for error messages.
620 \item In examples, made sure PARAM elements have datatype attributes
621 \item Corrected wording to be definitive that positions are given in the ICRS coordinate system.
622 \item Other typos.
623 \end{itemize}
624
625 \subsection{Changes from PR-1.00}
626 \begin{itemize}[noitemsep]
627 \item Various typos.
628 \item Clarified description of VERB parameter:
629 \begin{itemize}[noitemsep]
630 \item Clarified what is meant by optional for client and server.
631 \item Clarified the meaning of the values.
632 \end{itemize}
633 \item Explicitly mention the 3 legal locations for ERROR messages.
634 \item Refer to string types as character arrays, as per the VOTable std.
635 \item Prefers text/xml;content=x-votable over text/xml;votable.
636 \item Added examples of error message, legal response in appendix.
637 \end{itemize}
638
639 \subsection{Changes from the original NVO Specification Document}
640 \begin{itemize}[noitemsep]
641 \item References to the original HTML document have been replaced with references to this IVOA specification.
642 \item Replaced references to "curator" with "data provider" or similar wording.
643 \item Replaced references to the NVO with references either to the IVOA or this specification, as appropriate.
644 \item Ambiguous language like "perhaps" has been replaced with more definitive wording where appropriate. Use of the word "will" is replaced with "must" and "can" with "may", in accordance with the definitions set in the preface.
645 \item Grammatical and spelling corrections have been made.
646 \item The content is organized into sections typical of an IVOA spec.
647 \item Description of the URL syntax is sharper, borrowing language from the SIA specification [SIA]. This includes:
648 \begin{itemize}[noitemsep]
649 \item More explicitly specifying the form of the URL.
650 \item Sharpening the definition of the input parameters.
651 \item Indicating that parameter order is not significant.
652 \item Stating explicitly that unsupported optional arguments should be ignored.
653 \item Adding examples.
654 \item Re-ordering information for improved flow.
655 \end{itemize}
656 \item The version of VOTable supported is explicitly stated.
657 \item Whereas the NVO version describes the parameter with ucd="OBS\_ANG-SIZE" as "an expression of the opening angle of the cones", this version describes it specifically as "an expression of the uncertainty of the positions".
658 \item A note has been added to recognize the ambiguity in the location of the ERROR parameter.
659 \item The general description of the resource profile has been altered to allow rendering of the metadata to change according to the standards and conventions of the IVOA.
660 \item An editor's note has been added that makes reference to the RM document [RM].
661 \item A requirement that \textbf{MaxSR} be given in decimal degrees has been added.
662 \item For the \textbf{BaseURL} resource profile metadatum, the example has been replaced with a reference to the BaseURL syntax description.
663 \item An appendix has been added to describe the current practice for registering Cone Search services.
664 \end{itemize}
665
666 \bibliography{ivoatex/ivoabib,ivoatex/docrepo,scs}
667
668
669 \end{document}

Properties

Name Value
svn:executable *

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26