SLAService¶
- class pyvo.dal.SLAService(baseurl, *, capability_description=None, session=None)[source]¶
Bases:
DALService
a representation of an spectral line catalog (SLA) service
instantiate an SLA service
- Parameters:
- baseurlstr
the base URL for submitting search queries to the service.
- sessionobject
optional session to use for network requests
Attributes Summary
the available columns on this service
the service description.
Methods Summary
create_query
([wavelength, request])create a query object that constraints can be added to and then executed.
describe
()describe the general information about the DAL service
search
(wavelength, **keywords)submit a simple SLA query to this service with the given constraints.
Attributes Documentation
- columns¶
the available columns on this service
- description¶
the service description.
If this is not provided during instantiation, this method will download a sample from the service and read the description in the sample’s metadata instead.
Methods Documentation
- create_query(wavelength=None, *, request='queryData', **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:
- wavelength
Quantity
class or sequence of two floats the bandwidth range the observations belong to. assuming meters if unit is not specified.
- **keywords
additional 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.
- wavelength
- Returns:
- SLAQuery
the query instance
See also
- search(wavelength, **keywords)[source]¶
submit a simple SLA query to this service with the given constraints.
This method is provided for a simple but typical SLA queries. For more complex queries, one should create an SLAQuery object via create_query()
- Parameters:
- wavelength
Quantity
class or sequence of two floats the bandwidth range the observations belong to. assuming meters if unit is not specified.
- **keywords
additional 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.
- wavelength
- Returns:
- SLAResults
a container holding a table of matching spectral lines
- Raises:
- DALServiceError
for errors connecting to or communicating with the service
- DALQueryError
if the service responds with an error, including a query syntax error.
See also
SLAResults
pyvo.dal.query.DALServiceError
pyvo.dal.query.DALQueryError