Note
This is an old version of the documentation. See http://docs.astropy.org/en/stable for the latest version.
Searches for pairs of points that have an angular separation at least as close as a specified angle.
This is intended for use on coordinate objects with arrays of coordinates, not scalars. For scalar coordinates, it is better to use the separation methods.
Parameters:  coords1 : BaseCoordinateFrame or SkyCoord
coords2 : BaseCoordinateFrame or SkyCoord
seplimit : Quantity with angle units
storekdtree : bool or str, optional


Returns:  idx1 : integer array
idx2 : integer array
sep2d : Angle
dist3d : Quantity

Notes
This function requires SciPy (>=0.12.0) to be installed or it will fail.
In the current implementation, the return values are always sorted in the same order as the coords1 (so idx1 is in ascending order). This is considered an implementation detail, though, so it could change in a future release.