astropy:docs
  • Index
  • Modules

Navigation

  • next »
  • « previous |
  • pyvo v0.5.2 »
  • PyVO User’s Guide »
  • PyVO Reference Guide »
  • The pyvo.dal Package »
  • search

search¶

pyvo.dal.sia.search(url, pos, size, format='all', intersect='overlaps', verbosity=2, **keywords)[source]¶

submit a simple SIA query that requests images overlapping a given region

Parameters:

url : str

the base URL for the SIA service

pos : 2-element sequence of floats

the ICRS RA and DEC in decimal degrees

size : a float or a 2-element sequence of floats

the size of the rectangular region around pos to search for images, given in decimal degrees. If a single value is given, the region is a “square”.

format : str

the image format(s) of interest. “all” (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.

intersect : str

a case-insensitive 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 with the search region
CENTER select images whose center is within the search region

verbosity : int

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 keyword arguments. These can be either standard parameters (with names drown from the SIAQuery.std_parameters list) or paramters custom to the service. Where there is overlap with the parameters set by the other arguments to this function, these keywords will override.

Returns:

SIAResults

a container holding a table of matching image 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.

See also

SIAResults, pyvo.dal.query.DALServiceError, pyvo.dal.query.DALQueryError

Page Contents

  • search

Page Source   Back to Top

© Copyright 2017, the Virtual Astronomical Observatory (VAO).
Created using Sphinx 1.5.1.   Last built 09 Feb 2017.