SIAResults¶

class pyvo.dal.SIAResults(votable, *, url=None, session=None)[source]¶

Bases: DatalinkResultsMixin, DALResults

The list of matching images resulting from an image (SIA) query. Each record contains a set of metadata that describes an available image matching the query constraints. The number of records in the results is available by passing it to the Python built-in len() function.

This class supports iterable semantics; thus, individual records (in the form of SIARecord instances) are typically accessed by iterating over an SIAResults instance.

Alternatively, records can be accessed randomly via getrecord() or through a Python Database API (v2) Cursor (via cursor()). Column-based data access is possible via the getcolumn() method.

SIAResults is essentially a wrapper around an Astropy votable TableElement instance where the columns contain the various metadata describing the images. One can access that VOTable directly via the votable attribute. Thus, when one retrieves a whole column via getcolumn(), the result is a Numpy array. Alternatively, one can manipulate the results as an Astropy Table via the following conversion:

table = results.votable.to_table()

SIAResults supports the array item operator [...] in a read-only context. When the argument is numerical, the result is an SIARecord instance, representing the record at the position given by the numerical index. If the argument is a string, it is interpreted as the name of a column, and the data from the column matching that name is returned as a Numpy array.

initialize the cursor. This constructor is not typically called by directly applications; rather an instance is obtained from calling a DALQuery’s execute().

Parameters:

votablestr: the service response parsed into an astropy.io.votable.tree.VOTableFile instance.
urlstr: the URL that produced the response
sessionobject: optional session to use for network requests

Raises:

DALFormatError: if the response VOTable does not contain a response table

Navigation

SIAResults¶