SSAService¶

class pyvo.dal.SSAService(baseurl)[source]¶

a representation of an SSA service

instantiate an SSA service

Parameters:	baseurl : str the base URL for submitting search queries to the service.

Attributes Summary

`columns`	the available columns on this service
`description`	the service description.

Methods Summary

`create_query`([pos, diameter, band, time, …])	create a query object that constraints can be added to and then executed.
`describe`()
`search`([pos, diameter, band, time, format])	submit a SSA query to this service with the given constraints.

Attributes Documentation

Methods Documentation

create_query(pos=None, diameter=None, band=None, time=None, format=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:

pos : SkyCoord class or sequence of two floats: the position of the center of the circular search region. assuming icrs decimal degrees if unit is not specified.
diameter : Quantity class or scalar float: the diameter of the circular region around pos in which to search. assuming icrs decimal degrees if unit is not specified.
band : Quantity class or sequence of two floats: the bandwidth range the observations belong to. assuming meters if unit is not specified.
time : Time class or sequence of two strings: the datetime range the observations were made in. assuming iso 8601 if format is not specified.
format : str: the image format(s) of interest. “all” indicates all available formats; “graphic” indicates graphical images (e.g. jpeg, png, gif; not FITS); “metadata” indicates that no images should be returned–only an empty table with complete metadata.
**keywords :: additional case insensitive 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.

Returns:

See also

search(pos=None, diameter=None, band=None, time=None, format='all', **keywords)[source]¶

submit a SSA query to this service with the given constraints.

Parameters:	pos : `SkyCoord` class or sequence of two floats the position of the center of the circular search region. assuming icrs decimal degrees if unit is not specified. diameter : `Quantity` class or scalar float the diameter of the circular region around pos in which to search. assuming icrs decimal degrees if unit is not specified. band : `Quantity` class or sequence of two floats the bandwidth range the observations belong to. assuming meters if unit is not specified. time : `Time` class or sequence of two strings the datetime range the observations were made in. assuming iso 8601 if format is not specified. format : str the image format(s) of interest. “all” indicates all available formats; “graphic” indicates graphical images (e.g. jpeg, png, gif; not FITS); “metadata” indicates that no images should be returned–only an empty table with complete metadata. **keywords : additional case insensitive 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.
Returns:	SSAResults a container holding a table of matching catalog records
Raises:	DALServiceError for errors connecting to or communicating with the service DALQueryError if the service responds with an error, including query syntax errors