SIAService¶
- class pyvo.dal.SIAService(baseurl, *, capability_description=None, session=None)[source]¶
Bases:
DALService
a representation of an SIA service
instantiate an SIA 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.
the service parameters.
Methods Summary
create_query
([pos, size, format, intersect, ...])create a query object that constraints can be added to and then executed.
describe
()describe the general information about the DAL service
search
(pos[, size, format, intersect, verbosity])submit a SIA query to this service with the given parameters.
Attributes Documentation
- columns¶
the available columns on this service
- description¶
the service description.
- params¶
the service parameters.
Methods Documentation
- create_query(pos=None, size=None, *, format=None, intersect=None, verbosity=None, **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 rectangular search region. assuming icrs decimal degrees if unit is not specified.
- size
Quantity
class or up to 2 floats. the full rectangular size of the search region along the RA and Dec directions. converted if it’s a iterable containing scalars, assuming decimal degrees.
- size
Quantity
class or scalar float the size of the rectangular region around pos. assuming icrs decimal degrees if unit is not specified.
- formatstr
the image format(s) of interest. “all” (server-side default) 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; “image/*” indicates a particular image format where * can have values like “fits”, “jpeg”, “png”, etc.
- intersectstr
a token indicating how the returned images should intersect with the search region; recognized values include:
COVERS
select images that completely cover the search region
ENCLOSED
select images that are complete enclosed by the region
OVERLAPS
select any image that overlaps the search region (server-side default)
CENTER
select images whose center is within the search region
- verbosityint
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columsn, 3 means as many columns as are available.
- **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.
- pos
- Returns
- SIAQuery
the query instance
See also
- search(pos, size=1.0, *, format=None, intersect=None, verbosity=2, **keywords)[source]¶
submit a SIA query to this service with the given parameters.
- Parameters
- pos
SkyCoord
class or sequence of two floats the position of the center of the rectangular search region. assuming icrs decimal degrees if unit is not specified.
- size
Quantity
class or up to 2 floats. the full rectangular size of the search region along the RA and Dec directions. converted if it’s a iterable containing scalars, assuming decimal degrees.
- size
Quantity
class or scalar float the size of the rectangular region around pos. assuming icrs decimal degrees if unit is not specified.
- formatstr
the image format(s) of interest. “all” (server-side default) 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; “image/*” indicates a particular image format where * can have values like “fits”, “jpeg”, “png”, etc.
- intersectstr
a token indicating how the returned images should intersect with the search region; recognized values include:
COVERS
select images that completely cover the search region
ENCLOSED
select images that are complete enclosed by the region
OVERLAPS
select any image that overlaps the search region (server-side default)
CENTER
select images whose center is within the search region
- verbosityint
an integer value that indicates the volume of columns to return in the result table. 0 means the minimum set of columns, 3 means as many columns as are available. (client-side default == 2)
- **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.
- pos
- Returns
- SIAResults
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 a query syntax error.