IrsaClass

class astroquery.irsa.IrsaClass[source]

Bases: astroquery.query.BaseQuery

Attributes Summary

GATOR_LIST_URL
IRSA_URL
ROW_LIMIT
TIMEOUT

Methods Summary

list_catalogs() Return a dictionary of the catalogs in the IRSA Gator tool.
print_catalogs() Display a table of the catalogs in the IRSA Gator tool.
query_region([coordinates, catalog, …]) This function can be used to perform either cone, box, polygon or all-sky search in the catalogs hosted by the NASA/IPAC Infrared Science Archive (IRSA).
query_region_async([coordinates, catalog, …]) This function serves the same purpose as query_region(), but returns the raw HTTP response rather than the results in a Table.

Attributes Documentation

GATOR_LIST_URL = 'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-scan'
IRSA_URL = 'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query'
ROW_LIMIT = 500
TIMEOUT = 60

Methods Documentation

list_catalogs()[source]

Return a dictionary of the catalogs in the IRSA Gator tool.

Returns:
catalogs : dict

A dictionary of catalogs where the key indicates the catalog name to be used in query functions, and the value is the verbose description of the catalog.

print_catalogs()[source]

Display a table of the catalogs in the IRSA Gator tool.

query_region(coordinates=None, catalog=None, spatial='Cone', radius=<Quantity 10. arcsec>, width=None, polygon=None, get_query_payload=False, verbose=False, selcols=None)[source]

This function can be used to perform either cone, box, polygon or all-sky search in the catalogs hosted by the NASA/IPAC Infrared Science Archive (IRSA).

Parameters:
coordinates : str, astropy.coordinates object

Gives the position of the center of the cone or box if performing a cone or box search. The string can give coordinates in various coordinate systems, or the name of a source that will be resolved on the server (see here for more details). Required if spatial is 'Cone' or 'Box'. Optional if spatial is 'Polygon'.

catalog : str

The catalog to be used. To list the available catalogs, use print_catalogs().

spatial : str

Type of spatial query: 'Cone', 'Box', 'Polygon', and 'All-Sky'. If missing then defaults to 'Cone'.

radius : str or Quantity object, [optional for spatial is 'Cone']

The string must be parsable by Angle. The appropriate Quantity object from astropy.units may also be used. Defaults to 10 arcsec.

width : str, Quantity object [Required for spatial is 'Polygon'.]

The string must be parsable by Angle. The appropriate Quantity object from astropy.units may also be used.

polygon : list, [Required for spatial is 'Polygon']

A list of (ra, dec) pairs (as tuples), in decimal degrees, outlining the polygon to search in. It can also be a list of astropy.coordinates object or strings that can be parsed by astropy.coordinates.ICRS.

get_query_payload : bool, optional

If True then returns the dictionary sent as the HTTP request. Defaults to False.

verbose : bool, optional.

If True then displays warnings when the returned VOTable does not conform to the standard. Defaults to False.

selcols : str, optional

Target column list with value separated by a comma(,)

Returns:
table : Table

A table containing the results of the query

query_region_async(coordinates=None, catalog=None, spatial='Cone', radius=<Quantity 10. arcsec>, width=None, polygon=None, get_query_payload=False, selcols=None)[source]

This function serves the same purpose as query_region(), but returns the raw HTTP response rather than the results in a Table.

Parameters:
coordinates : str, astropy.coordinates object

Gives the position of the center of the cone or box if performing a cone or box search. The string can give coordinates in various coordinate systems, or the name of a source that will be resolved on the server (see here for more details). Required if spatial is 'Cone' or 'Box'. Optional if spatial is 'Polygon'.

catalog : str

The catalog to be used. To list the available catalogs, use print_catalogs().

spatial : str

Type of spatial query: 'Cone', 'Box', 'Polygon', and 'All-Sky'. If missing then defaults to 'Cone'.

radius : str or Quantity object, [optional for spatial is 'Cone']

The string must be parsable by Angle. The appropriate Quantity object from astropy.units may also be used. Defaults to 10 arcsec.

width : str, Quantity object [Required for spatial is 'Polygon'.]

The string must be parsable by Angle. The appropriate Quantity object from astropy.units may also be used.

polygon : list, [Required for spatial is 'Polygon']

A list of (ra, dec) pairs (as tuples), in decimal degrees, outlining the polygon to search in. It can also be a list of astropy.coordinates object or strings that can be parsed by astropy.coordinates.ICRS.

get_query_payload : bool, optional

If True then returns the dictionary sent as the HTTP request. Defaults to False.

selcols : str, optional

Target column list with value separated by a comma(,)

Returns:
response : requests.Response

The HTTP response returned from the service