conesearch

astroquery.vo_conesearch.conesearch.conesearch(center, radius, *, verb=1, catalog_db=None, verbose=True, cache=True, query_all=False, return_astropy_table=True, use_names_over_ids=False)[source]

Perform Cone Search and returns the result of the first successful query.

Note

Use astroquery.vo_conesearch.conf.pedantic to control pedantry. When True, will raise an error when the result violates the spec, otherwise issue a warning. Warnings may be controlled using warnings module.

Note

Use astroquery.vo_conesearch.conf.timeout to control timeout limit in seconds for each service being queried.

Parameters
centerstr, astropy.coordinates object, list, or tuple

Position of the center of the cone to search. It may be specified as an object from the Astronomical Coordinate Systems (astropy.coordinates) package, string as accepted by parse_coordinates(), or tuple/list. If given as tuple or list, it is assumed to be (RA, DEC) in the ICRS coordinate frame, given in decimal degrees.

radiusfloat or Quantity

Radius of the cone to search:

  • If float is given, it is assumed to be in decimal degrees.

  • If astropy quantity is given, it is internally converted to degrees.

verb{1, 2, 3}

Verbosity indicating how many columns are to be returned in the resulting table. Support for this parameter by a Cone Search service implementation is optional. If the service supports the parameter:

  1. Return the bare minimum number of columns that the provider considers useful in describing the returned objects.

  2. Return a medium number of columns between the minimum and maximum (inclusive) that are considered by the provider to most typically useful to the user.

  3. Return all of the columns that are available for describing the objects.

If not supported, the service should ignore the parameter and always return the same columns for every request.

catalog_db

May be one of the following, in order from easiest to use to most control:

  • None: A database of astroquery.vo_conesearch.conf.conesearch_dbname catalogs is downloaded from astroquery.vo_conesearch.conf.vos_baseurl. The first catalog in the database to successfully return a result is used.

  • catalog name: A name in the database of astroquery.vo_conesearch.conf.conesearch_dbname catalogs at astroquery.vo_conesearch.conf.vos_baseurl is used. For a list of acceptable names, use astroquery.vo_conesearch.vos_catalog.list_catalogs().

  • url: The prefix of a URL to a IVOA Service for astroquery.vo_conesearch.conf.conesearch_dbname. Must end in either ‘?’ or ‘&’.

  • VOSCatalog object: A specific catalog manually downloaded and selected from the database (see General VO Services Access).

  • Any of the above 3 options combined in a list, in which case they are tried in order.

verbosebool

Verbose output.

cachebool

Use caching for VO Service database. Access to actual VO websites referenced by the database still needs internet connection.

query_allbool

This is used by search_all().

return_astropy_tablebool

Returned obj will be astropy.table.Table rather than astropy.io.votable.tree.Table.

use_names_over_idsbool

When True use the name attributes of columns as the names of columns in the Table instance. Since names are not guaranteed to be unique, this may cause some columns to be renamed by appending numbers to the end. Otherwise (default), use the ID attributes as the column names.

Returns
objastropy.table.Table or astropy.io.votable.tree.Table

First table from first successful VO service request. See return_astropy_table parameter for the kind of table returned.

Raises
ConeSearchError

When invalid inputs are passed into Cone Search.