astro py:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- Astropy v1.1.1 »
- Virtual Observatory Access (`astropy.vo`) »
- VO Simple Cone Search »
- conesearch

# conesearch

`astropy.vo.client.conesearch.``conesearch`(center, radius, verb=1, **kwargs)

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

  Parameters:

  center : `SkyCoord`, `BaseCoordinateFrame`, or sequence of length 2

  > Position of the center of the cone to search. It may be specified as an object from the Astronomical Coordinate Systems (astropy.coordinates) package, or as a length 2 sequence. If a sequence, it is assumed to be `(RA, DEC)` in the ICRS coordinate frame, given in decimal degrees.

  radius : float 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 `astropy.vo.Conf.conesearch_dbname` catalogs is downloaded from `astropy.vo.Conf.vos_baseurl`. The first catalog in the database to successfully return a result is used.
  > > - catalog name: A name in the database of `astropy.vo.Conf.conesearch_dbname` catalogs at `astropy.vo.Conf.vos_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.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.

  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.Conf.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`

  > First table from first successful VO service request.

  Raises:

  ConeSearchError

  > When invalid inputs are passed into Cone Search.

  VOSError

  > If VO service request fails.