SCSQuery¶
-
class
pyvo.dal.scs.
SCSQuery
(baseurl, version='1.0')[source]¶ Bases:
pyvo.dal.query.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 class attribute,
std_parameters
, list the parameters defined by the SCS standard.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
Attributes Summary
dec
the declination part of the position constraint (default: None). pos
the position (POS) constraint as a 2-element tuple denoting RA and dec ra
the right ascension part of the position constraint (default: None). radius
the radius of the circular (cone) search region. sr
a synonym for radius std_parameters
verbosity
a parameter for controling the volume of columns returned. Methods Summary
execute_votable
()submit the query and return the results as an AstroPy votable instance Attributes Documentation
-
dec
¶ the declination part of the position constraint (default: None).
-
pos
¶ the position (POS) constraint as a 2-element tuple denoting RA and dec in decimal degrees. This defaults to None.
-
ra
¶ the right ascension part of the position constraint (default: None).
-
radius
¶ the radius of the circular (cone) search region.
-
sr
¶ a synonym for radius
-
std_parameters
= ['RA', 'DEC', 'SR']¶
-
verbosity
¶ a parameter for controling the volume of columns returned. The value of 0 means the minimum set of columsn, 3 means as many columns as are available.
Methods Documentation
-