SCSResults¶
- class pyvo.dal.SCSResults(votable, *, url=None, session=None)[source]¶
- Bases: - DatalinkResultsMixin,- DALResults- The list of matching catalog records resulting from a catalog (SCS) query. Each record contains a set of metadata that describes a source or observation within the requested circular region (i.e. a “cone”). 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 - SCSRecordinstances) are typically accessed by iterating over an- SCSResultsinstance.- 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.- SCSResultsis essentially a wrapper around an Astropy- votable- TableElementinstance where the columns contain the various metadata describing the images. One can access that VOTable directly via the- votableattribute. Thus, when one retrieves a whole column via- getcolumn(), the result is a Numpy array. Alternatively, one can manipulate the results as an Astropy- Tablevia the following conversion:- table = results.votable.to_table()- SCSResultssupports the array item operator- [...]in a read-only context. When the argument is numerical, the result is an- SCSRecordinstance, 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:
- votableastropy.io.votable.tree.VOTableFile
- 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 
 
 - See also - Methods Summary - getrecord(index)- return a representation of a conesearch result record that follows dictionary semantics. - Methods Documentation - getrecord(index)[source]¶
- return a representation of a conesearch result record that follows dictionary semantics. The keys of the dictionary are those returned by this instance’s fieldnames attribute. The returned record has the following additional properties: id, ra, dec - Parameters:
- indexint
- the integer index of the desired record where 0 returns the first record 
 
- Returns:
- SCSRecord
- a dictionary-like wrapper containing the result record metadata. 
 
- Raises:
- IndexError
- if index is negative or equal or larger than the number of rows in the result table. 
 
 - See also