astropy:docs

conesearch

astropy.vo.client.conesearch.conesearch(center, radius, verb=1, **kwargs)[source] [edit on github]

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

Parameters :

center : tuple of float or Astronomical Coordinate Systems (astropy.coordinates)

Right-ascension and declination for the position of the center of the cone to search:

  • If tuple of float is given, it is assumed to be (RA, DEC) in the ICRS coordinate system, given in decimal degrees.
  • If astropy coordinates object is given, it will be converted internally to ICRS.

radius : float or Angle object

Radius of the cone to search:

  • If float is given, it is assumed to be in decimal degrees.
  • If astropy angle object or angular 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 astropy.vo.client.conesearch.CONESEARCH_DBNAME catalogs is downloaded from astropy.vo.client.vos_catalog.BASEURL. The first catalog in the database to successfully return a result is used.
  • catalog name: A name in the database of astropy.vo.client.conesearch.CONESEARCH_DBNAME catalogs at astropy.vo.client.vos_catalog.BASEURL is used. For a list of acceptable names, use list_catalogs().
  • url: The prefix of a URL to a IVOA Service for astropy.vo.client.conesearch.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.

pedantic : bool or None

When True, raise an error when the file violates the spec, otherwise issue a warning. Warnings may be controlled using warnings module. When not provided, uses the configuration setting astropy.io.votable.table.PEDANTIC, which defaults to False.

verbose : bool

Verbose output.

cache : bool

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

Returns :

obj : astropy.io.votable.tree.Table object

First table from first successful VO service request.

Raises :

ConeSearchError :

When invalid inputs are passed into Cone Search.

VOSError :

If VO service request fails.

Page Contents