imagesearch

pyvo.dal.imagesearch(url, pos, size=1.0, format='all', intersect='overlaps', verbosity=2, **keywords)

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

Parameters:
url : str

the base URL for the SIA service

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.

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 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 case insensitive keyword arguments. 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