Repository navigation
Archive IRSA
NASA/IPAC Infrared Science Archive.
-
Module name:
irsa -
Python class:
astroquery.ipac.irsa.Irsa - Functions: 7
Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.
| Function | Summary |
|---|---|
list_catalogs |
Return information of available IRSA catalogs. |
list_collections |
Return information of available IRSA SIAv2 collections to be used in query_sia queries. |
list_columns |
Return list of columns of a given IRSA catalog. |
query_region |
Queries the IRSA TAP server around a coordinate and returns a Table object. |
query_sia |
Use standard SIA2 attributes to query the IRSA SIA service. |
query_ssa |
Use standard SSA attributes to query the IRSA SSA service. |
query_tap |
Send query to IRSA TAP. Results in TAPResults format. |
Return information of available IRSA catalogs.
Irsa.list_catalogs(*, full=False, filter=None, include_metadata_tables=False, cache=False)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="list_catalogs",
params={},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
full |
bool | False |
If True returns the full schema as a Table. If False returns a dictionary of the table names and their description. |
filter |
str or None | None |
If specified we only return catalogs when their catalog_name or the short description contains the filter string (case-insensitive). Note this may not be all the relevant catalogs from a given mission, do consult the unfiltered list when in doubt. |
include_metadata_tables |
bool | False |
If True returns not just the catalogs but all table holdings including the image metadata tables. These are not suitable for spatial queries with e.g. query_region. |
cache |
False |
Return information of available IRSA SIAv2 collections to be used in query_sia queries.
Irsa.list_collections(*, servicetype=None, filter=None)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="list_collections",
params={},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
servicetype |
str or None | None |
Service type to list collections for. Returns all collections when not provided. Currently supported service types are: 'SIA', 'SSA'. |
filter |
str or None | None |
If specified we only return collections then their collection_name contains the filter string. |
Returns
A Table object. — A table listing all the possible collections for IRSA SIA queries.
Return list of columns of a given IRSA catalog.
Irsa.list_columns(catalog, *, full=False)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="list_columns",
params={"catalog": "<catalog>"},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
catalog (required)
|
str | The name of the catalog. | |
full |
bool | False |
If True returns the full schema as a Table. If False returns a dictionary of the column names and their description. |
Queries the IRSA TAP server around a coordinate and returns a Table object.
Irsa.query_region(coordinates=None, *, catalog=None, spatial='Cone', radius=<Quantity 10. arcsec>, width=None, polygon=None, get_query_payload=False, columns='*', async_job=False, verbose=False, cache=True)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="query_region",
params={},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
coordinates |
str, astropy.coordinates object |
None |
Gives the position of the center of the cone or box if performing a cone or box search. Required if spatial is 'Cone' or 'Box'. Ignored if spatial is 'Polygon' or 'All-Sky'. |
catalog |
str | None |
The catalog to be used. To list the available catalogs, use list_catalogs. |
spatial |
str | 'Cone' |
Type of spatial query: 'Cone', 'Box', 'Polygon', and 'All-Sky'. Defaults to 'Cone'. |
radius |
str or Quantity object, [optional for spatial is 'Cone'] |
<Quantity 10. arcsec> |
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 'Box'.] |
None |
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'] |
None |
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 | False |
If True then returns the dictionary sent as the HTTP request. Defaults to False. |
columns |
str | '*' |
Target column list with value separated by a comma(,) |
async_job |
bool | False |
if True query is run in asynchronous mode |
verbose |
False |
||
cache |
True |
Returns
A Table object. —
Use standard SIA2 attributes to query the IRSA SIA service.
Irsa.query_sia(*, pos=None, band=None, time=None, pol=None, field_of_view=None, spatial_resolution=None, spectral_resolving_power=None, exptime=None, timeres=None, publisher_did=None, facility=None, collection=None, instrument=None, data_type=None, calib_level=None, target_name=None, res_format=None, maxrec=None, **kwargs)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="query_sia",
params={},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
pos |
single or list of tuples | None |
angle units (default: deg) the positional region(s) to be searched for data. Each region can be expressed as a tuple representing a CIRCLE, RANGE or POLYGON as follows: (ra, dec, radius) - for CIRCLE. (angle units - defaults to) (long1, long2, lat1, lat2) - for RANGE (angle units required) (ra, dec, ra, dec, ra, dec ... ) ra/dec points for POLYGON all in angle units |
band |
scalar, tuple(interval) or list of tuples | None |
(spectral units (default: meter) the energy interval(s) to be searched for data. |
time |
single or list of Time or compatible strings |
None |
the time interval(s) to be searched for data. |
pol |
single or list of str from pyvo.dam.obscore.POLARIZATION_STATES
|
None |
the polarization state(s) to be searched for data. |
field_of_view |
single or list of tuples | None |
angle units (default arcsec) the range(s) of field of view (size) to be searched for data |
spatial_resolution |
single or list of tuples | None |
angle units required the range(s) of spatial resolution to be searched for data |
spectral_resolving_power |
single or list of tuples | None |
the range(s) of spectral resolving power to be searched for data |
exptime |
single or list of tuples | None |
time units (default: second) the range(s) of exposure times to be searched for data |
timeres |
single of list of tuples | None |
time units (default: second) the range(s) of temporal resolution to be searched for data |
publisher_did |
single or list of str | None |
specifies the unique identifier of dataset(s). It is global because it must include information regarding the publisher (obs_publisher_did in ObsCore) |
facility |
single or list of str | None |
specifies the name of the facility (usually telescope) where the data was acquired. |
collection |
single or list of str | None |
name of the collection that the data belongs to |
instrument |
single or list of str | None |
specifies the name of the instrument with which the data was acquired. |
data_type |
'image'|'cube' | None |
specifies the type of the data |
calib_level |
single or list from enum | None |
pyvo.dam.obscore.CALIBRATION_LEVELS specifies the calibration level of the data. Can be a single value or a list of values |
target_name |
single or list of str | None |
specifies the name of the target (e.g. the intention of the original science program or observation) |
res_format |
single or list of strings | None |
specifies response format(s). |
maxrec |
None |
||
**kwargs |
Returns
Results in Table format. —
Use standard SSA attributes to query the IRSA SSA service.
Irsa.query_ssa(*, pos=None, radius=None, band=None, time=None, collection=None)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="query_ssa",
params={},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
pos |
SkyCoord class or sequence of two floats |
None |
the position of the center of the circular search region. assuming icrs decimal degrees if unit is not specified. |
radius |
None |
||
band |
Quantity class or sequence of two floats |
None |
the bandwidth range the observations belong to. assuming meters if unit is not specified. |
time |
Time class or sequence of two strings |
None |
the datetime range the observations were made in. assuming iso 8601 if format is not specified. |
collection |
str | None |
Name of the collection that the data belongs to. |
Returns
Results in Table format. —
Send query to IRSA TAP. Results in TAPResults format.
Irsa.query_tap(query, *, async_job=False, maxrec=None)Call via MCP
astroquery_execute(
module_name="irsa",
function_name="query_tap",
params={"query": "<query>"},
)result.to_qtable in QTable format
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
query (required)
|
str | ADQL query to be executed | |
async_job |
bool | False |
if True query is run in asynchronous mode |
maxrec |
int | None |
maximum number of records to return |
Returns
TAPResults — TAP query result.
Auto-generated from source docstrings on each release. Do not edit here — changes are overwritten.