SCSService¶
-
class
pyvo.dal.scs.
SCSService
(baseurl, resmeta=None, version='1.0')[source]¶ Bases:
pyvo.dal.query.DALService
a representation of a Cone Search service
instantiate a Cone Search service
Parameters: baseurl : str
the base URL for submitting search queries to the service.
resmeta : dict
an optional dictionary of properties about the service
Methods Summary
create_query
([pos, radius, verbosity])create a query object that constraints can be added to and then search
(pos[, radius, verbosity])submit a simple Cone Search query that requests objects or observations Methods Documentation
-
create_query
(pos=None, radius=None, verbosity=None)[source]¶ create a query object that constraints can be added to and then executed. The input arguments will initialize the query with the given values.
Parameters: pos : 2-element tuple/list of floats
a 2-element tuple or list containing the ICRS right ascension and declination defining the position of the center of the circular search region, in decimal degrees
radius : float
the radius of the circular search region, in decimal degrees
verbosity : int
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columsn, 3 means as many columns as are available.
Returns: SCSQuery
the query instance
See also
-
search
(pos, radius=1.0, verbosity=2)[source]¶ submit a simple Cone Search query that requests objects or observations whose positions fall within some distance from a search position.
Parameters: pos : 2-element tuple/list of floats
a 2-element tuple or list containing the ICRS right ascension and declination defining the position of the center of the circular search region, in decimal degrees
radius : float
the radius of the circular search region, in decimal degrees
verbosity : int
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columsn, 3 means as many columns as are available.
Returns: SCSResults
a container holding a table of matching catalog records
Raises: DALServiceError
for errors connecting to or communicating with the service
DALQueryError
if the service responds with an error, including a query syntax error.
-