SCSQuery

class pyvo.dal.SCSQuery(baseurl, pos=None, radius=None, verbosity=None, session=None, **keywords)[source]

Bases: pyvo.dal.DALQuery

a class for preparing an query to a Cone Search service. Query constraints are added via its service type-specific methods. The various execute() functions will submit the query and return the results.

The base URL for the query, which controls where the query will be sent when one of the execute functions is called, is typically set at construction time; however, it can be updated later via the baseurl to send a configured query to another service.

In addition to the search constraint attributes described below, search parameters can be set generically by name via dict semantics.

The typical function for submitting the query is execute(); however, alternate execute functions provide the response in different forms, allowing the caller to take greater control of the result processing.

initialize the query object with a baseurl and the given parameters

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 float

a 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.

session : object

optional session to use for network requests

Attributes Summary

pos the position of the center of the circular search region as a SkyCoord instance.
radius the radius of the circular region around pos as a Quantity instance.
verbosity an integer value that indicates the volume of columns to return in the result table.

Methods Summary

execute(self) submit the query and return the results as a SCSResults instance

Attributes Documentation

pos

the position of the center of the circular search region as a SkyCoord instance.

radius

the radius of the circular region around pos as a Quantity instance.

verbosity

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.

Methods Documentation

execute(self)[source]

submit the query and return the results as a SCSResults instance

Raises:
DALServiceError

for errors connecting to or communicating with the service

DALQueryError

for errors either in the input query syntax or other user errors detected by the service

DALFormatError

for errors parsing the VOTable response