diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 72b5cde..79afad7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -33,7 +33,7 @@ jobs: test -f ${{ env.doc_name }}.bbl - name: Keep the PDF artefact - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: PDF Preview path: ${{ env.doc_name }}.pdf diff --git a/.gitignore b/.gitignore index 1202507..31b17e5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ ivoatexmeta.tex +gitmeta.tex ConeSearch.aux ConeSearch.bbl ConeSearch.blg @@ -6,4 +7,7 @@ ConeSearch.log ConeSearch.out ConeSearch.pdf ConeSearch.toc +ConeSearch.hd +ConeSearch.fls +ConeSearch.fdb_latexmk ConeSearch.html diff --git a/ConeSearch.tex b/ConeSearch.tex index e15ba4d..a552954 100755 --- a/ConeSearch.tex +++ b/ConeSearch.tex @@ -1,92 +1,68 @@ -\documentclass[11pt,a4paper]{ivoa} +\documentclass[11pt,a4paper]{ivoa} \input tthdefs - +\input gitmeta \usepackage{todonotes} -\usepackage{enumitem} + \usepackage{listings} \lstloadlanguages{XML,sh} \lstset{flexiblecolumns=true,tagstyle=\ttfamily, showstringspaces=False} \usepackage{multirow} - \title{Simple Cone Search} \ivoagroup{Data Access Layer} +\author[http://www.ivoa.net/twiki/bin/view/IVOA/RayPlante]{Raymond Plante} \author[http://www.ivoa.net/twiki/bin/view/IVOA/MarcoMolinaro]{Marco Molinaro} -\author[http://www.ivoa.net/twiki/bin/view/IVOA/AdaNebot]{Ada Nebot} -\author[http://www.ivoa.net/twiki/bin/view/IVOA/MarkusDemleitner]{Markus Demleitner} +%\author[http://www.ivoa.net/twiki/bin/view/IVOA/MarkusDemleitner]{Markus Demleitner} \author[http://www.ivoa.net/twiki/bin/view/IVOA/BobHanisch]{Robert Hanisch} -\author[http://www.ivoa.net/twiki/bin/view/IVOA/RayPlante]{Raymond Plante} \author[http://www.ivoa.net/twiki/bin/view/IVOA/AlexSzalay]{Alex Szalay} \author[http://www.ivoa.net/twiki/bin/view/IVOA/RoyWilliams]{Roy Williams} -\editor{Marco Molinaro, Ada Nebot, Raymond Plante} +\editor{Ray Plante, Marco Molinaro} +\previousversion[http://www.ivoa.net/Documents/ConeSearch/20200828/index.html]{WD 1.1 2020-08-28} \previousversion[http://www.ivoa.net/Documents/REC/DAL/ConeSearch-20080222.html]{REC 1.03} -\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070914.html]{PR 2007-09-14} -\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070628.html]{PR 2007-06-28} -\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20060908.html]{PR 2006-09-08} - -\begin{document} \begin{abstract} This specification defines a simple -query protocol, named Simple Cone Search, 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 at aligning this -specification with the Data Access Layer (DAL) landscape. We also -extend the protocol to query catalogs by an interval of time. The -response returns a list of astronomical sources from the catalog whose -time values lie within the time interval, formatted as a -VOTable. - - -\end{abstract} - - -\section*{Acknowledgments} This document was originally published as a -document of the US National Virtual Observatory (NVO) -\footnote{ - The NVO document: "Conesearch definition" (Roy Williams, Bob Hanish, Alex Szalay; April - 2002) is currently available at this link: - \url{https://wiki.ivoa.net/internal/IVOA/ConeSearch/NVO_conesearch_April2002.html}. -} -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}. +\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070914.html]{PR 1.02 2007-09-14} +\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20070628.html]{PR 1.01 2007-06-28} +\previousversion[http://www.ivoa.net/Documents/PR/DAL/ConeSearch-20060908.html]{PR 1.00 2006-09-08} + + +\begin{document} + +\begin{abstract} This specification defines a simple +query protocol for retrieving records from a catalog of astronomical +sources. The query describes 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 of the specification is essentially a +transcription of the original Cone Search specification in order to move +it into the IVOA standardization process. \end{abstract} + + +\section*{Acknowledgments} + +This document was originally published as a +document of the US National Virtual Observatory (NVO)\footnote{The NVO +document: "Conesearch definition" (Roy Williams, Bob Hanish, Alex +Szalay; April 2002) is currently available at this link: +\url{https://wiki.ivoa.net/internal/IVOA/ConeSearch/NVO\_conesearch\_April2002.html.}} +and then transcripted into an IVOA standards document format to become +an IVOA Recommendation. The changes made in this transcription and in +the process of producing the first recommendation are reported in +Appendix \ref{appendix:nvochanges}. The Simple Cone Search 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. -The ConeSearch-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. -This work has been supported by the ESCAPE project (the European Science -Cluster of Astronomy \& Particle Physics ESFRI Research Infrastructures) -that has received funding from the European Union’s Horizon 2020 -research and innovation programme under the Grant Agreement n. 824064 - -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. - -\section*{Conformance-related definitions} - -The words ``MUST'', ``SHALL'', ``SHOULD'', ``MAY'', ``RECOMMENDED'', and -``OPTIONAL'' (in upper or lower case) used in this document are to be -interpreted as described in IETF standard RFC2119 \citep{std:RFC2119}. - -The \emph{Virtual Observatory (VO)} is a general term for a collection -of federated resources that can be used to conduct astronomical -research, education, and outreach. The -\href{http://www.ivoa.net}{International Virtual Observatory Alliance -(IVOA)} is a global collaboration of separately funded projects to -develop standards and infrastructure that enable VO applications. - +The ConeSearch-1.1 revision has been initially supported under the +ASTERICS and ESCAPE projects (funded by the European Commission +Framework Programme Horizon 2020 Research and Innovation Action, grant +agreements n. 653477 and n. 824064 respectively). Work done within the +two projects has been reported in \ref{appendix:first11changes}. \section{Introduction} @@ -101,7 +77,7 @@ \section{Introduction} the same time, the service implementation and the data it provides can serve as a basis for more sophisticated tools. -This specification does not specify how cone search services are +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. @@ -112,848 +88,643 @@ \section{Introduction} \subsection{Role within the VO Architecture} -\begin{figure} -\centering - -% Get the architecture diagram from the TCG chair -% http://wiki.ivoa.net/twiki/bin/view/IVOA/IvoaTCG If they give you a -% PDF, for now dumb it down to a png by convert -antialias -density -% 72x72 archdiag.pdf archdiag.png Oh -- Notes don't need this; you'd -% have to remove archdiag.png from FIGURES in the Makefile, too. - -\includegraphics[width=0.9\textwidth]{role_diagram.pdf} -\caption{Architecture diagram for Simple Cone Search} +\begin{figure} \centering +%% Get the architecture diagram from the TCG chair % +%http://wiki.ivoa.net/twiki/bin/view/IVOA/IvoaTCG % If they give you a +%PDF, for now dumb it down to a png by % convert -antialias -density +%72x72 archdiag.pdf archdiag.png % Oh -- Notes don't need this; you'd +%have to remove archdiag.png % from FIGURES in the Makefile, too. +\includegraphics[width=0.9\textwidth]{role_diagram} +\caption{Architecture diagram for the Simple Cone Search +specification.} \label{fig:archdiag} \end{figure} Fig.~\ref{fig:archdiag} shows the role this document plays within the -IVOA architecture \citep{2010ivoa.rept.1123A}. - -\section{Resource} -\label{sec:resif} - -A Simple Cone Search service for accessing catalogue resources is -implemented as a synchronous resource, as compliant as possible to the -DALI specification \citep{2017ivoa.spec.0517D}. - -\begin{table}[th] -\begin{center} -\begin{tabular}{p{0.25\textwidth}p{0.25\textwidth}p{0.25\textwidth}} -\sptablerule \textbf{resource type}&\textbf{resource name}&\textbf{required}\\ -\sptablerule \{query\} & service specific & yes\\ VOSI-capabilities & /capabilities & should\\ VOSI-availability & (/availability) & should\\ -\sptablerule -\label{table:resources} -\end{tabular} -\caption{Simple Cone Search resources tree} -\end{center} -\end{table} - -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. - -\subsection{\{query\} resource} \label{sec:basepar} The Simple Cone -Search \{query\} resource \textbf{must} meet the following requirements: -\begin{itemize} \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); -\item the response, by default, \textbf{must} be a valid VOTable -document, providing a table containing the sources of the catalogue -whose positions and/or timestamps are within the cone and/or time -interval described in the query request (see Sec.~\ref{sec:response}); -\item in case of error, the response \textbf{must} follow prescriptions -as described in Sec.~\ref{sec:error}. \end{itemize} - -The Simple Cone Search service \texttt{\{query\}} resource is a -synchronous web resource, as described by DALI, of the form -$$\hbox{\nolinkurl{http:///?} }$$ To this base URL -the query parameters, described hereafter, are attached to build the -query request to be submitted through HTTP. - -Usage of fixed, custom query parameters, defined by the service provider -to build a base URL of the form -$$\hbox{\nolinkurl{http:///?&}}$$ -(standard behaviour of base URLs in Simple Cone Search-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{} additions. - -In the case of HTTP POST action, the behaviour of Simple Cone Search -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{} arguments -always be submitted in the query part of the HTTP request. - -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. - -The set of query constraints a cone search needs to understand -\textbf{must} include the \textbf{RA}, \textbf{DEC}, \textbf{SR} -parameters, \textbf{may} understand the TIME parameter, -\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. - -\subsubsection{RA} \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. - -\subsubsection{DEC} \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. - -\subsubsection{SR} \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 -not return an error condition because the request might describe an -interest in retrieving only the metadata structure of the service's -response (i.e. discovery of the FIELDS delivered by the service). - -This is similar to 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}\textsuperscript{, -}\footnote{SR=180 can be used for cases in which only information of -time is provided or where a cone search is not a convenient search for -the location of a source in they sky (e.g. GW and neutrinos).} - -\subsubsection{TIME} \textbf{TIME} represents the time interval to be -searched for data. The value is an open or closed interval with numeric -values (interpreted as Modified Julian Dates). A TIME constraint is -satisfied if the interval intersects the time coverage of the -observation. Values used in the TIME parameter are always interpreted as -specified in DALI in the section on literal values: UTC time scale and -UNKNOWN reference position. Modified Julian Date values are always in -days. The parameter TIME \textbf{may} be present in the query. - -\subsubsection{MAXREC} 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. -Its usage is encouraged and preferred to the SR=0 solution for metadata -discovery. - -\subsubsection{RESPONSEFORMAT} \label{subsubsec:responseformat} A -Simple Cone Search service \textbf{must} provide responses in VOTable -\citep{2019ivoa.spec.1021O} 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. - -\subsubsection{VERB} 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. - -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. - -A query following this syntax represents a request for information on -sources located within the specified cone on the sky. - -\subsection{Query examples} - -\begin{bigdescription} - \item[Minimal Simple Cone Search query] - \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=0.01} - \item[Service Metadata query] - \nolinkurl{http://my.cone/search?cat=A1\&RA=0\&DEC=0\&SR=0\&MAXREC=0} - \item[Limit number of records in response] - \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=1\&MAXREC=100} - \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} - \item[Query by time interval] - \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=ALLSKY&TIME=MJD\_MIN\%20MJD\_MAX} - \item[Query by position and time interval] - \nolinkurl{http://my.cone/search?RA=10.68\&DEC=41.26\&SR=0.01&TIME=MJD\_MIN\%20MJD\_MAX} -\end{bigdescription} - -\subsection{Availability: VOSI-availability} A web service with Simple -Cone Search 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. - -\subsection{Capabilities: VOSI-capabilities} A web service with Simple -Cone Search 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}. - -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. - -\section{Successful Response} \label{sec:response} 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 and/ or time inverterval as applicable -(see Appendix \ref{app:responsesample} for examples). - -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. - -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}. - -\subsection{VOTable compliant response} - -In the case the service response is serialised in the default, VOTable, -format, this response \textbf{MUST} comply with the following -requirements. - -There \textbf{must} be a single \xmlel{RESOURCE} with -\xmlel{type}=\texttt{"results"} in -the VOTable, and containing a single \xmlel{TABLE} - -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: - -\begin{itemize} - \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. - \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"}. - \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"}. - \item \textbf{Exactly one} \xmlel{FIELD}, representing the time of -the observation, \textbf{must} have \xmlel{ucd}=\texttt{"time.epoch;meta.main"}, -and have \xmlel{datatype} set to \texttt{"float"} or \texttt{"double"}. -\end{itemize} - -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. There may be other \xmlel{FIELD}s in the -table. Their specification \textbf{should} include description, -datatype, and UCD. - -\section{Error Response} \label{sec:error} - -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. - -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. - -Errors \textbf{must} be reported in case any one of the three required -paramaters (RA, DEC, SR) is missing, or if their values cannot be parsed -to floating-point numbers, or if the numbers are out of range (DEC=91.0, -for example). - -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}). - -The service \textbf{may}, as an alternative, report exceptions using the -profile expressed by the previous Simple Cone Search recommendation -\citep[v1.03]{2008ivoa.specQ0222P}. This alternative for error reporting is to be -considered \textbf{deprecated}, being the purpose of this specification -to fill in the gap of the Simple Cone Search protocol with the general -DAL landscape. The way the alternative works is detailed in -Sec.~\ref{subsec:err103} here below. - -\subsection{(\textbf{deprecated}) Alternative Error Response} -\label{subsec:err103} In the case of error, the service \textbf{must} -respond with a VOTable that contains a \xmlel{PARAM} element or an -\xmlel{INFO} element with \xmlel{name}=\texttt{"Error"}, where -the corresponding \xmlel{value} attribute should contain some -explanation of the nature of the error. No other \xmlel{PARAM} or -\xmlel{INFO} element in the response can be present having -\xmlel{name}=\texttt{"Error"} set, but additional \xmlel{INFO} and -\xmlel{PARAM} elements with the \xmlel{name} parameter set to a different value -are allowed. If an \xmlel{INFO} element is -used, it must appear as a direct child of one of the following elements: -\begin{itemize} \item the root \xmlel{VOTABLE} element (which is -preferred by this document), or \item the \xmlel{RESOURCE} element -\end{itemize} - -If a \xmlel{PARAM} element is used, it must appear as a direct child of -the \xmlel{RESOURCE} element. -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. - -\begin{bigdescription} - \item[Example Error Responses] Error INFO as child of VOTABLE (preferred)\\ - -\begin{lstlisting}[language=XML,basicstyle=\footnotesize] - - - - MAST Simple Cone Search Service - +IVOA architecture \citep{2021ivoa.spec.1101D}. + +\section{Service Interface Requirements} +\label{sec:2} + +A service implementation that is compliant with this standard must meet +the following requirements: + +\begin{enumerate} + \item the service must respond to a HTTP GET request + represented by a URL having two parts:\\ + + \begin{itemize} + \item A base URL of the form\\ + + \url{http:///?[&[...]]}\\ + + where and are URI-compliant components + indicating the domain address and local location path where the service + is deployed. The may end with one or more locally + supported URL arguments, ; these arguments are not + recognized parts of the Cone Search protocol and thus are treated + opaquely by clients of the service as part of the base URL.\\ Note that + when it contains extra GET arguments, the base URL ends in an ampersand, + \&; if there are no extra arguments, then it ends in a question mark, + ?.\\ + + \begin{bigdescription} + \item[Examples] + \url{http://mycone.org/cgi-bin/VOsearch?}\\ + \url{http://adil.ncsa.uiuc.edu/vocone?resolv&issurvey=T&} + \end{bigdescription} + + Every query to a given cone search service uses the same base URL. + + \item Constraints expressed as a list of + ampersand-delimited GET arguments of the form: = where + is a parameter name specified by this specification and + is its value. The constraints represent the query parameters which can + vary for each successive query. The order of the name-parameter pairs is + not significant. + \item The baseURL and constraint list are concatenated + to form the query. + \item The set of query constraints must include the + following parameters, which are interpreted by the service with the + stated meaning: + \begin{description} + \item[\textbf{RA}] a right-ascension + in the ICRS coordinate system for the positon of the center of the cone + to search, given in decimal degrees. + \item[\textbf{DEC}] a declination + in the ICRS coordinate system for the positon of the center of the cone + to search, given in decimal degrees. + \item[\textbf{SR}] the radius of + the cone to search, given in decimal degrees. + \end{description} + \begin{bigdescription} + \item[Example] + \url{http://mycone.org/cgi-bin/search?RA=180.567&DEC=-30.45&SR=0.0125} + \end{bigdescription} + \item The query MAY contain the optional 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. Support for this parameter by a Cone Search service + implementation is optional. 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 + 2.2 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 columns for every request. + \item 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. + \end{itemize} + + A query following this syntax represents a request for + information on sources located within the specified cone on the sky. + + \item The service must respond with an XML document in the VOTable + format, that represents a table of astronomical sources whose positions + are within the cone (see Appendix \ref{appendix:a} for an example). + 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. The base MIME-type of the HTTP + response should be \texttt{text/xml}. The more specific form + \texttt{text/xml;content=x-votable} may optionally be used. The + MIME-type, \texttt{text/xml;votable} shall also be considered legal (for + backward compatibility reasons); however, this value is strongly + discouraged as it is not compliant with the MIME-type standard + \citep{std:MIME}. Simple Cone Search services MUST return VOTable + version 1 documents. + + \begin{bigdescription} + \item[Editor's Note] The original NVO specification allowed a + MIME-type of text/xml;votable, thus for backward + compatibility this is still allowed but discouraged. + \end{bigdescription} + + The VOTable MUST comply with these conditions: + + \begin{itemize} + \item There must be a single RESOURCE in the VOTable, + and that contains a single TABLE. + \item The TABLE must have FIELDS where + the following UCD values have been set. There must only be one FIELD + with each of these UCDs: + + \begin{itemize} + \item Exactly one FIELD must + have ucd="ID\_MAIN", with an array character type (fixed or variable + length), representing an ID string for that record of the table. This + identifier may not be repeated in the table, and it could be used to + retrieve that same record again from that same table. + \item Exactly one + FIELD must have ucd="POS\_EQ\_RA\_MAIN", with type double, representing + the right-ascension of the source in the ICRS coordinate system. + \item + Exactly one FIELD must have ucd="POS\_EQ\_DEC\_MAIN", with type double, + representing the declination of the source in the ICRS coordinate system. + \end{itemize} + + \item 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 PARAM in the 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 FIELD in the table having a UCD set to OBS\_ANG-SIZE. + \item There may be other FIELDs in the table. Their specification should + include a description, data-type, and UCD. + \end{itemize} + + \item The service must respond with a stubbed version of the VOTable in the case + of error. This must happen if the three required parameters (RA, DEC, + SR) are not all present, or if their values cannot be parsed to + floating-point numbers, or if the numbers are out of range (DEC=91.0, + for example). The service may also make an error return if the search + radius (give by the SR parameter) is larger than the MaxSR parameter of + the Resource Profile (see Section \ref{sec:3}). In the case of error, + the service MUST respond with a VOTable that contains a PARAM element or + an INFO element with \texttt{name="Error"}, where thecorresponding value + attribute should contain some explanation of the nature of the error. No + other PARAM or INFO element in the response can be present having + \texttt{name=''Error''} set, but additional INFO and PARAM elements with + the name parameter set to a different value are allowed. If an INFO + element is used, it must appear as a direct child of one of the + following elements: + + \begin{itemize} + \item the root VOTABLE element (which is preferred by this document), or + \item the RESOURCE element + \end{itemize} + + If a PARAM element is used, it must appear as a direct + child of one of following elements: + + \begin{itemize} + \item the RESOURCE element, or + \item a DEFINITION element below the root VOTABLE element + (which is discouraged by this document). + \end{itemize} + + \begin{bigdescription} + \item[Editor's Note] + It was recognized that this + requirement, as it was described in the original NVO specification, is + ambiguous about both the element to use for the ERROR message and its + location in the document. The VOTable standard allows PARAM and INFO + elements to appear in various places within the document. Since several + of the different methods have been used in practice by Cone Search + service implementations, no attempt is made in this version to correct + this ambiguity. All of the above-mentioned locations should be + considered legal, and Cone Search service clients should be prepared to + look in all of them for an ERROR message. The use of PARAM as a child of + DEFINITIONS is discouraged as the DEFINITIONS element was deprecated in + VOTable v1.1. + \end{bigdescription} + \begin{bigdescription} + \item[Example Error Responses] + Error INFO as child of VOTABLE (preferred)\\ + + \begin{lstlisting}[language=XML,basicstyle=\footnotesize] + + + -\end{lstlisting} - -Error PARAM as child of RESOURCE (allowed) - -\begin{lstlisting}[language=XML,basicstyle=\footnotesize] + \end{lstlisting} + + Error PARAM as child of RESOURCE (allowed) + + \begin{lstlisting}[language=XML,basicstyle=\footnotesize] - HEASARC Browse data service Please send inquiries to - mailto:request@athena.gsfc.nasa.gov - - - + + HEASARC Browse data service + Please send inquiries to mailto:request@athena.gsfc.nasa.gov + + + + -\end{lstlisting} - -\end{bigdescription} - -Queries targeting no records \textbf{should not} generate an error -response, but an empty metadata response. - -\section{Resource Registry Extension} \label{sec:regext} - -\begin{admonition}{Note} 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. \end{admonition} - -To adequately describe that a service supports the Simple Cone Search -protocol, it is necessary to define Simple Cone Search specific -capability metadata. This is needed both to allow discovery of cone -search services within VO registered resources (through the Registry -Interfaces standard, \citet{2018ivoa.spec.0723D}, deploying VOResource documents, -\citet{2018ivoa.spec.0625P}) and to generally describe service behaviour to help -applications consume it properly, given compliance to the protocol. - -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{2017ivoa.spec.0524G} interfaces. - -Apart from the above standards referenced here above, this registry -extension depends on the VODataService \citep{2010ivoa.spec.1202P} standard. - -\subsection{Resource record and Capability requirements} To be -recognized as a Simple Cone Search, 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. Simple Cone Search -\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}. - -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. - -\subsubsection{Capability} \label{subsec:capability} The VOResource -record \textbf{must} include a \xmlel{capability} element that -\textbf{must} have a \xmlel{standardID} attribute set to -$$\hbox{\nolinkurl{ivo://ivoa.net/std/conesearch#query-1.1}}$$ to -unambiguously identify the resource as a Simple Cone Search compliant to -Simple Cone Search-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 Simple Cone Search extension -schema, that is -$$\hbox{\nolinkurl{http://www.ivoa.net/xml/ConeSearch/v1.0} ,}$$ the -same as for Simple Cone Search-1.03, as explained in the XML Schema -Versioning \citep{2018ivoa.spec.0529H} document; distinction among the -two schemata version being delivered by the \xmlel{version} attribute in -the schema root element. - -The \xmlel{cs:ConeSearch} type is described in Sec.~\ref{subsec:cstype}. - -\subsubsection{Interface} The \xmlel{capability} element described in -Sec.~\ref{subsec:capability} \textbf{must} include a child -\xmlel{interface} element. 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 -\xmlel{interface} \textbf{must} be set to the \xmlel{} of the -service (see \ref{sec:basepar}). - -It is not necessary to provide the \xmlel{use} attribute to the -\xmlel{accessURL} element (as its value can be assumed); however, when -it is provided, it must be set to \texttt{"base"}. Similarly, it is not -necessary to provide the \xmlel{interface} element with -\xmlel{queryType} or \xmlel{resultType} elements; however, when -provided, their values should be \texttt{"GET"} and -\texttt{"application/x-votable+xml"}, respectively. The -\xmlel{vs:ParamHTTP} allows one to describe input parameters supported -by the service; description authors are encouraged to list the optional -parameters and any custom parameters supported by the instance of the -service. - -\subsubsection{\textit{cs:}ConeSearch} \label{subsec:cstype} The -\xmlel{cs:ConeSearch} type is a \xmlel{vr:Capability} sub-type that -should be used to describe a service's support for the Simple Cone -Search protocol; it is defined as follows: - -% GENERATED: !schemadoc ConeSearch-v1.1.xsd ConeSearch -\begin{generated} -\begingroup - \renewcommand*\descriptionlabel[1]{% - \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{cs:ConeSearch} Type Schema Documentation} - -\noindent{\small The capabilities of a Cone Search implementation. -\par} - -\vspace{1ex}\noindent\textbf{\xmlel{cs:ConeSearch} Type Schema Definition} - -\begin{lstlisting}[language=XML,basicstyle=\footnotesize] - - - - - - - - - - - - -\end{lstlisting} - -\vspace{0.5ex}\noindent\textbf{\xmlel{cs:ConeSearch} Extension Metadata Elements} + \end{lstlisting} + + \end{bigdescription} + + Other conditions may + NOT be considered erroneous, for example if a query cone is in the + Southern hemisphere and the catalog coverage is in the Northern + hemisphere. This type of query is different from an error return; it + should return a VOTable as described above, with metadata, but no data + records. In particular, a zero value of Search Radius should not return + an error condition. This is because an application may be more + interested in the metadata than the data, and send a fixed query (for + example RA=0\&DEC=90\&SR=0) simply to discover the fields delivered by + the service. +\end{enumerate} + +\section{The Resource Profile} +\label{sec:3} + +A Cone Search service MUST +be described with a Resource Profile that includes the following +information. The Profile is composed of named metadata listed below. The +format used to encode the profile should be compliant with the +publishing standards of the IVOA throughout the time the service is +supported by the data provider. The metadata names and values used in +the profile encoding should match those given below as closely as +possible; where they do not match exactly, they should be consistent +with the IVOA metadata conventions in place at any given time and the +mapping of names and values actually used and those given below should +be well documented. -\begingroup -\small \begin{bigdescription} - - \item[Element \xmlel{maxSR}] - \begin{description} - \item[Type] floating-point number: \xmlel{xs:float} - \item[Meaning] The largest search radius, in degrees, that will be -accepted by the service without returning an error condition. Not -providing this element or specifying a value of 180 indicates that there -is no restriction. - \item[Occurrence] optional \item[Comment] Not providing a value is the -prefered way to indicate that there is no restriction. - \end{description} - - \item[Element \xmlel{maxRecords}] - \begin{description} - \item[Type] \xmlel{xs:positiveInteger} - \item[Meaning] The largest number of records that the service -will return. Not providing this value means that there is no effective limit. - \item[Occurrence] optional - \item[Comment] This does not refer to the -total number of records in the catalog but rather maximum number of -records the service is capable of returning. A limit that is greater -than the number of records available in the archive is equivalent to -their being no effective limit. (See RM, Hanisch 2007.) - \end{description} - - \item[Element \xmlel{verbosity}] - \begin{description} - \item[Type] boolean (true/false): xs:boolean - \item[Meaning] True if the service supports the VERB keyword; false, otherwise. - \item[Occurrence] required - \end{description} - - \item[Element \xmlel{testQuery}] - \begin{description} - \item[Type] composite: \xmlel{cs:Query} - \item[Meaning] A query that will result in at least one matched -record that can be used to test the service. - \item[Occurrence] optional - \end{description} - + \item[Editor's Note] + The original NVO specification pre-dates the IVOA standard for resource + metadata [RM], and so, obviously, some inconsistencies with that + standard exist. To deal with this, the wording of this section has been + altered to allow profiles to be constructed according to the latest + practices in the IVOA. Appendix B outlines the mapping of the metadata + listed below to that in the RM as well as the XML Schema used to render + the metadata within a Registry. \end{bigdescription} -\endgroup - -\endgroup -\end{generated} - -% /GENERATED - -The custom metadata that the \xmlel{cs:ConeSearch} type provides is -given above. Other genaral metadata useful to describe the Simple Cone -Search specification are directly part of the core VOResource schema. - -\subsubsection{testQuery and the Query Type} - -The \xmlel{testQuery} element is intended to help other VO components -(e.g. registries, validation services, services that monitor the VO's -operational health, but typically not end users) test that the service -is up and operating correctly. It provides a set of legal input -parameters that should return a legal response that includes at least -one matched record. Since this query is intended for testing purposes, -the size of the result set should be small. - -The \xmlel{cs:Query} type captures the different components of the query -into separate elements, as defined below: - -% GENERATED: !schemadoc ConeSearch-v1.1.xsd Query -\begin{generated} \begingroup \renewcommand*\descriptionlabel[1]{% -\hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{cs:Query} Type Schema Documentation} - -\noindent{\small A query to be sent to the service \par} - -\vspace{1ex}\noindent\textbf{\xmlel{cs:Query} Type Schema Definition} - -\begin{lstlisting}[language=XML,basicstyle=\footnotesize] - - - - - - - - - - - -\end{lstlisting} -\vspace{0.5ex}\noindent\textbf{\xmlel{cs:Query} Metadata Elements} +Several of the +metadata listed below can have values that are hierarchical; this +hierarchy should be represented in a manner most appropriate to the +format used. When the format does not provide any such mechanism, it is +recommended that the value be represented as a strings delimited by dots +with the root domain of the value appearing first. -\begingroup -\small +The resource profile consists of the following metadata with the stated +definitions: -\begin{bigdescription} +\begin{itemize} + \item[\textbf{ResponsibleParty}] The data provider's name and email. + \item[\textbf{ServiceName}] The name of the + catalog served by the service, for example "IRSA.2MASS.ExtendedSources". + \item[\textbf{Description}] A couple of paragraphs of text that describe + the nature of the catalog and its wider context. + \item[\textbf{Instrument}] The instrument that made the observations, + for example STScI.\-HST.\-WFPC2. + \item[\textbf{Waveband}] The waveband + of the observations, with ONE selected from this list: radio, + millimeter, infrared, optical, ultraviolet, xray, gammaray. + \item[\textbf{Epoch}] The epoch of the observations, as a free-form string. + \item[\textbf{Coverage}] The coverage on the sky, as a free-form string. + \item[\textbf{MaxSR}] The largest search radius, given in decimal + degrees, that will be accepted by the service without returning an error + condition. A value of 180.0 indicates that there is no restriction. + \item[\textbf{MaxRecords}] The largest number of records that the + service will return. + \item[\textbf{Verbosity}] True or false, depending + on whether the service supports the VERB keyword in the request. + \item[\textbf{BaseURL}] The base URL for the service as described in + Section \ref{sec:2}. +\end{itemize} - \item[Element \xmlel{ra}] - \begin{description} - \item[Type] floating-point number: \xmlel{xs:double} - \item[Meaning] the right ascension of the search cone's center in -decimal degrees. - \item[Occurrence] required - \end{description} \ - - \item[Element \xmlel{dec}] - \begin{description} - \item[Type] floating-point number: \xmlel{xs:double} - \item[Meaning] the declination of the search cone's center in decimal degrees. - \item[Occurrence] required - \end{description} - - \item[Element \xmlel{sr}] - \begin{description} - \item[Type] floating-point number: \xmlel{xs:double} - \item[Meaning] the radius of the search cone in decimal degrees. - \item[Occurrence] required - \end{description} - - \item[Element \xmlel{time}] - \begin{description} - \item[Type] floating-point number: \xmlel{xs:double} - \item[Meaning] the interval of time in the seach in MJD (days). - \item[Occurrence] optional - \end{description} - - \item[Element \xmlel{verb}] - \begin{description} - \item[Type] \xmlel{xs:positiveInteger} - \item[Meaning] the verbosity level to use where 1 means the bare -minimum set of columns and 3 means the full set of available columns. - \item[Occurrence] optional - \end{description} - - \item[Element \xmlel{catalog}] - \begin{description} - \item[Type] string: \xmlel{xs:string} - \item[Meaning] the catalog to query. - \item[Occurrence] optional - \item[Comment] When the service can access more than one catalog, -this input parameter, if available, is used to indicate which service to access. - \end{description} - - \item[Element \xmlel{extras}] - \begin{description} - \item[Type] string: \xmlel{xs:string} - \item[Meaning] any extra (non-standard) parameters that must be -provided (apart from what is part of base URL given by the accessURL element). - \item[Occurrence] optional \item[Comment] this value should be in the -form of name=value pairs delimited with ampersands (\&). - \end{description} +The service will be considered +published to the VO if the profile has been added to an IVOA Registry +according to the IVOA standards and conventions at the time the service +is made available, TOGETHER with maintaining the web service that is +described by the profile in compliant order. -\end{bigdescription} -\endgroup +\appendix -\endgroup \end{generated} +\section{Sample VOTable Response} +\label{appendix:a} -\appendix \section{Sample VOTable Response} \label{app:responsesample} This is a sample of a legal response to a Cone Search query. \begin{lstlisting}[language=XML,basicstyle=\footnotesize] - + - - - - - HEASARC Browse data service Please send inquiries - to mailto:request@athena.gsfc.nasa.gov - - - - - Faint Images of the Radio Sky at Twenty cm Source Catalog (FIRST) - - - Integer key - - - FIRST Source Designation - - - Right Ascension - - - Declination - - - Peak 1.4GHz Flux Density(mJy) - - - Estimated rms in at Source (mJy) - - - Integrated 1.4GHz Flux Density (mJy) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
384559FIRST J120002.6+595708180.011004259.95238891.110.1391.14
385094FIRST J120025.3+600103180.105725060.01755562.890.1422.56
384928FIRST J120018.1+600236180.075550060.043475019.380.14519.23
384490FIRST J115959.4+600403179.997887560.06770831.010.1471.20
- + + + + + + HEASARC Browse data service + Please send inquiries to mailto:request@athena.gsfc.nasa.gov + + + + + Faint Images of the Radio Sky at Twenty cm Source Catalog (FIRST) + + + Integer key + + + FIRST Source Designation + + + Right Ascension + + + Declination + + + Peak 1.4GHz Flux Density (mJy) + + + Estimated rms in at Source (mJy) + + + Integrated 1.4GHz Flux Density (mJy) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
384559FIRST J120002.6+595708180.011004259.95238891.110.1391.14
385094FIRST J120025.3+600103180.105725060.01755562.890.1422.56
384928FIRST J120018.1+600236180.075550060.043475019.380.14519.23
384490FIRST J115959.4+600403179.997887560.06770831.010.1471.20
+ \end{lstlisting} -This is an example of a legal response to a Cone Search query using the -time parameter: -\begin{lstlisting}[language=XML,basicstyle=\footnotesize] - - - - - - - - - Right Ascension - - - Right Ascension - - - Time of observation - - - Magnitude of the source - - - - - - - - - - - -
270.14754119086-30.904754595802309.0019986418.990655
- -\end{lstlisting} +\section{Current Practices for Representing Resource Profiles} + +\subsection{Mapping for Resource Profile Metadata to the RM} + +As mentioned in an Editor's Note in Section \ref{sec:3}, the original NVO +specification pre-dated the IVOA standard for resource metadata known as +the RM \citep{2004ivoa.spec.0426H}. This section indicates how the +resource profile metadata defined in this specification maps to the +metadata defined in the RM. + +\begin{table}[th] +\begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}} +\sptablerule +\textbf{Cone Search Metadatum} & \textbf{RM Metadatum}\\ +\sptablerule +\textbf{ResponsibleParty} & Publisher, Contact.Email\\ +\textbf{ServiceName} & Title\\ +\textbf{Description} & Description\\ +\textbf{Instrument} & Instrument\\ +\textbf{Waveband} & Coverage.Spectral\\ +\textbf{Epoch} & Coverage.Temporal.StartTime, Coverage.Temporal.StopTime\textsuperscript{1}\\ +\textbf{Coverage} & Coverage.Spatial\\ +\textbf{MaxSR} & Service.MaxSearchRadius\\ +\textbf{MaxRecords} & Service.MaxReturnRecords\\ +\textbf{Verbosity} & n/a\textsuperscript{2}\\ +\textbf{BaseURL} & Service.BaseURL\\ +\sptablerule +\label{table:b1meta} +\end{tabular} \caption{Metadata +Mapping} \end{table} + +Table notes: +\begin{enumerate} + \item The notion of + the epoch the observations is captured in the RM as the temporal + coverage. The notion of the equinox of the observational positions is + captured part of the RM's Coverage.Spatial. + \item As this concept is not + covered by the RM, it should be considered service-specific capability + metadata. +\end{enumerate} + +\subsection{VOResource (pre-v1.0) Schema Extension for Cone Search Services} + +Just prior to the adoption of IVOA standard for registry +interfaces, v1.0, resource descriptions were encoded using the +VOResource XML Schema, v0.10 and its family of extension schemas. The +extensions used to specifically describe Cone Search services were +VODataService, v0.5 and ConeSearch, v0.3. +%%%% \todo{The references to RI, +%VOResource, VODataService and ConeSearch here, are all referring to xsd +%schemata currently obsoleted.}. See the embedded documentation in each +%of these schemas for the precise definitions and usage of the metadata +%encodable through them. %%% + +The following table enumerates the mapping of resource profile metadata +defined in this specification with those defined in the XML schemas. + +\begin{table}[th] +\begin{tabular}{p{0.38\textwidth}p{0.27\textwidth}p{0.34\textwidth}} +\sptablerule +\multirow{2}{*}{\textbf{Cone Search Metadatum}}&\multicolumn{2}{p{0.59\textwidth}}{\textbf{VOResource Metadatum}}\\ +&\textbf{Schema Name}&\textbf{XPath Name}\\ +\sptablerule +\textbf{ResponsibleParty} & VOResource & curation/publisher, curation/contact/email\\ +\textbf{ServiceName} & VOResource & title\\ +\textbf{Description} & VOResource & content/description\\ +\textbf{Instrument} & VOResource & instrument\\ +\textbf{Waveband} & VODataService & coverage/spectral/waveband\\ +\textbf{Epoch} & VODataService & coverage/temporal/startTime, coverage/temporal/stopTime\textsuperscript{1}\\ +\textbf{Coverage} & VODataService & coverage/spatial\textsuperscript{2}\\ +\textbf{MaxSR} & ConeSearch & capability/maxSR\\ +\textbf{MaxRecords} & ConeSearch & capability/maxRecords\\ +\textbf{Verbosity} & ConeSearch &capability/verbosity\\ +\textbf{BaseURL} & VOResource interface/accessURL\\ +\sptablerule +\label{table:extable} +\end{tabular} +\caption{VOResource pre-0.10 extension} +\end{table} + +Table Notes: +\begin{enumerate} + \item The notion of the epoch the observations is + captured in the schema inside coverage/temporal. The notion of the + equinox of the observational positions is captured within + coverage/spatial/region, such as in + coverage/spatial/region[@xsi:type='vs:Circle']/coordFrame. + \item the coverage/spatial element encodes its information as a + complex set of child elements. +\end{enumerate} + +\subsection{VOResource (v1.0) Schema Extension for Cone Search Services} + +With the expected adoption of the IVOA standard for Registry +Interface, resources are described using the VOResource schema, v1.0 and +its family of extensions. Cone Search services are specifically +described using the VODataService, v1.0, and ConeSearch, v1.0, extension +schemas. Coverage information is encoded using the Space-Time +Coordinates (STC) schema. + +The following table enumerates the mapping of resource profile metadata +defined in this specification with those defined in the XML schemas. + +\begin{table}[th] +\begin{tabular}{p{0.4\textwidth}p{0.29\textwidth}p{0.3\textwidth}} +\sptablerule +\multirow{2}{*}{\textbf{Cone Search Metadatum}}&\multicolumn{2}{p{0.59\textwidth}}{\textbf{VOResource Metadatum}}\\ +&\textbf{Schema Name}&\textbf{XPath Name}\\ +\sptablerule +\textbf{ResponsibleParty} & VOResource & curation/publisher, curation/contact/email\\ +\textbf{ServiceName} & VOResource & title\\ +\textbf{Description} & VOResource & content/description\\ +\textbf{Instrument} & VOResource & instrument\\ +\textbf{Waveband} & VODataService & coverage/waveband\\ +\textbf{Epoch} & VODataService & coverage-/stc:STCResourceProfile-/stc:AstroCoordArea\textsuperscript{1}\\ +\textbf{Coverage} & VODataService & coverage-/stc:STCResourceProfile-/stc:AstroCoordArea\textsuperscript{1}\\ +\textbf{MaxSR} & ConeSearch & capability/maxSR\\ +\textbf{MaxRecords} & ConeSearch & capability/maxRecords\\ +\textbf{Verbosity} & ConeSearch & capability/verbosity\\ +\textbf{BaseURL} & VOResource & capability-/interface[@role='std']-/accessURL\\ +\sptablerule +\label{table:extable} +\end{tabular} +\caption{VOResource 1.0 extension} +\end{table} + +Table Notes: +\begin{enumerate} + \item In STC, coverage on the sky and in + time are described in an integrated way within the stc:AstroCoordArea + element. The notion of the equinox of the observational positions is + captured within stc:AstroCoordSystem element. +\end{enumerate} + +Subsequent versions of this document should include the ConeSearch extension +schemaas a formal part of the specification. + +\section{Changes from Previous Versions} +\subsection*{Changes from WD-1.1-20200828} +\begin{itemize} + \item embedded errata 1, 2 and 3 for ConeSearch-1.03 + \item Complete revert of changes to restore clean 1.03 contents, + in view of specific minor updates (listed here above) +\end{itemize} -\section{Changes from Previous Versions} \label{app:changes} - -\subsection{Changes from REC-1.03} -\begin{itemize}[noitemsep] -\item Added the extension for time search. -\item Moving base URL to a plain http://server/path? format -\item Changed error response to comply with DALI -\item Changed resource metadata importing directly from SimpleDALRegExt -\item Relaxed RA and Dec FIELDs in response to allow float or double datatype -\item No more exactly one RESOURCE in response, now stating exactly one of type="results" -\item Removed fixed version (1.0 or 1.1) for VOTable default response -\item Added DALI MAXREC and RESPONSEFORMAT -\item Added POST as optional HTTP query method -\item Addition and changes on authors/editors. -\item Plain porting of the HTML document into ivoatex template, -including change history, then modified it and reshaped. +\subsection*{Changes from REC-1.03} +\label{appendix:first11changes} +\begin{itemize} + \item moving base URL to a plain http://server/path? format + \item changed error response to comply with DALI + \item changed resource metadata importing directly from SimpleDALRegExt + \item relaxed RA and Dec FIELDs in response to allow float or double datatype + \item no more exactly one RESOURCE in response, now stating exactly one of + type="results" + \item removed fixed version (1.0 or 1.1) for VOTable default response + \item Added DALI MAXREC and RESPONSEFORMAT + \item Added POST as optional HTTP query method + \item Addition of authors/editors. + \item Plain porting of the HTML document into ivoatex template, + including change history, then modified it and reshaped. \end{itemize} -\subsection{Changes from PR-1.02} -\begin{itemize}[noitemsep] -\item Converted to Recommendation +\subsection*{Changes from PR-1.02} +\begin{itemize} + \item converted to Recommendation \end{itemize} -\subsection{Changes from PR-1.01} -\begin{itemize}[noitemsep] -\item Removed 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. -\item Allowed the use of the INFO element for error messages. -\item In examples, made sure PARAM elements have datatype attributes -\item Corrected wording to be definitive that positions are given in the ICRS -coordinate system. -\item Other typos. +\subsection*{Changes from PR-1.01} +\begin{itemize} + \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. + \item Allowed the use of the INFO element for error messages. + \item In examples, made sure PARAM elements have datatype attributes + \item Corrected wording to be definitive that positions are given + in the ICRS coordinate system. + \item Other typos. \end{itemize} -\subsection{Changes from PR-1.00} -\begin{itemize}[noitemsep] -\item Various typos. -\item Clarified description of VERB parameter: - \begin{itemize}[noitemsep] - \item Clarified what is meant by optional for - client and server. - \item Clarified the meaning of the values. - \end{itemize} -\item Explicitly mention the 3 legal locations for ERROR -messages. -\item Refer to string types as character arrays, as per the -VOTable std. -\item Prefers text/xml;content=x-votable over -text/xml;votable. -\item Added examples of error message, legal response -in appendix. +\subsection*{Changes from PR-1.00} +\begin{itemize} + \item Various typos. + \item Clarified description of VERB parameter: + \begin{itemize} + \item Clarified what is meant by optional for client and server. + \item Clarified the meaning of the values. + \end{itemize} + \item Explicitly mention the 3 legal locations for ERROR messages. + \item Refer to string types as character arrays, as per the VOTable std. + \item Prefers text/xml;content=x-votable over text/xml;votable. + \item Added examples of error message, legal response in appendix. \end{itemize} -\subsection{Changes from the original NVO Specification Document} -\begin{itemize}[noitemsep] -\item References to the original HTML -document have been replaced with references to this IVOA specification. -\item Replaced references to "curator" with "data provider" or similar -wording. -\item Replaced references to the NVO with references either to -the IVOA or this specification, as appropriate. -\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. -\item Grammatical and spelling corrections have been made. -\item The -content is organized into sections typical of an IVOA spec. -\item Description of the URL syntax is sharper, borrowing language from the -SIA specification [SIA]. This includes: \begin{itemize}[noitemsep] -\item More explicitly specifying the form of the URL. -\item Sharpening the -definition of the input parameters. -\item Indicating that parameter -order is not significant. -\item Stating explicitly that unsupported -optional arguments should be ignored. -\item Adding examples. -\item Re-ordering information for improved flow. \end{itemize} -\item The -version of VOTable supported is explicitly stated. -\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". -\item A note has been added to recognize the ambiguity in the location -of the ERROR parameter. -\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. -\item An -editor's note has been added that makes reference to the RM document -[RM]. -\item A requirement that \textbf{MaxSR} be given in decimal -degrees has been added. -\item For the \textbf{BaseURL} resource profile -metadatum, the example has been replaced with a reference to the BaseURL -syntax description. -\item An appendix has been added to describe the -current practice for registering Cone Search services. +\subsection*{Changes from the original NVO Specification Document} +\label{appendix:nvochanges} +\begin{itemize} + \item References to the original HTML document have been replaced + with references to this IVOA specification. + \item Replaced references to "curator" with "data + provider" or similar wording. + \item Replaced references to the NVO with + references either to the IVOA or this specification, as appropriate. + \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. + \item Grammatical and spelling corrections have been made. + \item The content is organized into sections typical of an IVOA spec. + \item Description of the URL syntax is sharper, borrowing language + from the SIA specification [SIA]. This includes: + \begin{itemize} + \item More explicitly specifying the form of the URL. + \item Sharpening the definition of the input parameters. + \item Indicating that parameter order is not significant. + \item Stating explicitly that unsupported optional arguments + should be ignored. + \item Adding examples. + \item Re-ordering information for improved flow. + \end{itemize} + \item The version of VOTable supported is explicitly stated. + \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". + \item A note has been added to recognize the ambiguity in the location + of the ERROR parameter. + \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. + \item An editor's note has been added that makes reference to the RM document [RM]. + \item A requirement that \textbf{MaxSR} be given in decimal + degrees has been added. \item For the \textbf{BaseURL} resource profile + metadatum, the example has been replaced with a reference to the BaseURL + syntax description. + \item An appendix has been added to describe the + current practice for registering Cone Search services. \end{itemize} \bibliography{ivoatex/ivoabib,ivoatex/docrepo,ConeSearch} diff --git a/Makefile b/Makefile old mode 100755 new mode 100644 index fd2e137..a9fd61a --- a/Makefile +++ b/Makefile @@ -1,4 +1,5 @@ -# ivoatex Makefile. The ivoatex/README for the targets available. +# ivoatex Makefile. The http://ivoa.net/documents/notes/IVOATex +# for the targets available. # short name of your document (edit $DOCNAME.tex; would be like RegTAP) DOCNAME = ConeSearch @@ -7,23 +8,36 @@ DOCNAME = ConeSearch DOCVERSION = 1.1 # Publication date, ISO format; update manually for "releases" -#DOCDATE = 2019-11-15 -DOCDATE = 2020-08-28 +DOCDATE = 2023-08-29 # What is it you're writing: NOTE, WD, PR, REC, PEN, or EN DOCTYPE = WD +# An e-mail address of the person doing the submission to the document +# repository (can be empty until a make upload is being made) +AUTHOR_EMAIL=marco.molinaro@inaf.it + # Source files for the TeX document (but the main file must always -# be called $(DOCNAME).tex -SOURCES = $(DOCNAME).tex +# be called $(DOCNAME).tex) +SOURCES = $(DOCNAME).tex gitmeta.tex -# List of pixel image files to be included in submitted package +# List of image files to be included in submitted package (anything that +# can be rendered directly by common web browsers) FIGURES = -# List of PDF figures (for vector graphics) -VECTORFIGURES = role_diagram.pdf +# List of PDF figures (figures that must be converted to pixel images to +# work in web browsers). +VECTORFIGURES = # Additional files to distribute (e.g., CSS, schema files, examples...) -AUX_FILES = +AUX_FILES = + +-include ivoatex/Makefile + +ivoatex/Makefile: + @echo "*** ivoatex submodule not found. Initialising submodules." + @echo + git submodule update --init -include ivoatex/Makefile +test: + @echo "No tests defined yet" diff --git a/ivoatex b/ivoatex index 70d2afe..85a59fe 160000 --- a/ivoatex +++ b/ivoatex @@ -1 +1 @@ -Subproject commit 70d2afe455256590aa5bc3f3f922190f338c075e +Subproject commit 85a59fe8e6abd86bbe3ef4e12fd3dade71a54924 diff --git a/role_diagram.pdf b/role_diagram.pdf index e81abee..a930685 100644 Binary files a/role_diagram.pdf and b/role_diagram.pdf differ diff --git a/role_diagram.svg b/role_diagram.svg index d0876ad..80a2267 100644 --- a/role_diagram.svg +++ b/role_diagram.svg @@ -1,63 +1,59 @@ -IVOA Architecture DiagramThis image shows the architecture of the Virtual Observatory - (cf. http://ivoa.net), together with the relevant standards.UsersComputersProvidersRegistryData Access ProtocolsUser LayerUsingResource LayerSharingVOCoreFindingGettingDesktop AppsIn-BrowserAppsUserProgramsData and Metadata CollectionStorageComputationSemanticsDataModelsVO QueryLanguagesFormats - - VOResource - RegistryInterface - VODataService - StandardsRegExt - SimpleDALR.E. - - - VOTable - - - DALI - SCS - - - - - VOSI - - - VOUnits - UCD - Vocabularies - - +IVOA Architecture DiagramThis image shows the architecture of the Virtual Observatory + (cf. http://ivoa.net), together with the relevant standards.UsersComputersProvidersRegistryData Access ProtocolsUser LayerUsingResource LayerSharingVOCoreFindingGettingDesktop AppsIn-BrowserAppsUserProgramsData and Metadata CollectionStorageComputationSemanticsDataModelsVO QueryLanguagesFormats + + VOResource + Resource M.D. + + + VOTable + + + ConeSearch + + + + + + + UCD + + diff --git a/role_diagram.xml b/role_diagram.xml index c9ffc78..50b835d 100644 --- a/role_diagram.xml +++ b/role_diagram.xml @@ -13,32 +13,45 @@ Document authors (ivoatex maintainers have different rules): For the time being, keep both role_diagram.pdf and role_diagram.svg as created by this in the VCS. This helps document builds on machines with missing dependencies. + + +Archdiag maintainers: When adding boxes here, first look for a good place, +preferably in one of the grid positions given in the comments for the +WGs (e.g., 55 for Registry). Good y positions are ones that already +exist. Leave out the w at first. + +Then, run + +make archdiag-debug.svg + +and open archdiag-debug.svg in a javascript-enabled browser. In that +browser's javascript console you will see lines like: + +SpectralDM: 67; 11.5 + +The first number is the box's natural width, which you should use in the w +attribute of the rec/prerec. The second is the offset to x you'd need to +add to one of the x grid lines (the x=something in the opening comments +of the various sections) to have the box centered. --> - - - - - - + + + - - + + - - - + + - + - - + - - - - + + - +