SCSService¶
-
class
pyvo.dal.scs.
SCSService
(baseurl)[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.
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, **keywords)[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 : astropy.coordinates.SkyCoord
a SkyCoord instance defining the position of the center of the circular search region. converted if it’s a iterable containing scalars, assuming icrs degrees.
radius :
Quantity
or floata Quantity instance defining the radius of the circular search region, in degrees. converted if it is another unit.
verbosity : int
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columns, 3 means as many columns as are available.
**keywords :
additional case insensitive parameters can be given via arbitrary case insensitive keyword arguments. Where there is overlap with the parameters set by the other arguments to this function, these keywords will override.
Returns: SCSQuery
the query instance
See also
-
search
(pos, radius=1.0, verbosity=2, **keywords)[source]¶ submit a simple Cone Search query that requests objects or observations whose positions fall within some distance from a search position.
Parameters: pos : astropy.coordinates.SkyCoord
a SkyCoord instance defining the position of the center of the circular search region. converted if it’s a iterable containing scalars, assuming icrs degrees.
radius :
Quantity
or floata Quantity instance defining the radius of the circular search region, in degrees. converted if it is another unit.
verbosity : int
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columns, 3 means as many columns as are available.
**keywords :
additional case insensitive parameters can be given via arbitrary case insensitive keyword arguments. Where there is overlap with the parameters set by the other arguments to this function, these keywords will override.
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.
-