Skip to content

Commit 5f7adff

Browse files
Jorge Fernandez HernandezJorge Fernandez Hernandez
authored andcommitted
GAIASWRQ-25 Include extra comment at the end for section 2.6
1 parent 01db07e commit 5f7adff

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/gaia/gaia.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ This query searches for all the objects contained in an arbitrary rectangular pr
8282
WARNING: This method implements the ADQL BOX function that is deprecated in the latest version of the standard
8383
(ADQL 2.1, see: https://ivoa.net/documents/ADQL/20231107/PR-ADQL-2.1-20231107.html#tth_sEc4.2.9).
8484

85-
It is possible to choose which data release to query, by default the Gaia DR3 catalogue is used. For example::
85+
It is possible to choose which data release to query, by default the Gaia DR3 catalogue is used. For example
8686

8787
.. doctest-remote-data::
8888

@@ -796,12 +796,21 @@ The previous 3-step cross-match can be executed in one step by the following met
796796
Owner: None
797797
Output file: 1611860482314O-result.vot.gz
798798
Results: None
799+
>>> result = job.get_results()
799800

800801
This method updates the user table metadata to flag the positional RA/Dec columns and launches the positional
801802
cross-match as an asynchronous query. Unlike the previous 3-step cross-match method, the returned job provides direct
802803
access to the output of the cross-match information: for each matched source, all the columns from the input tables plus
803804
the angular distance (degrees). Therefore, the size of the output can be quite large.
804805

806+
By default, this method targets the main catalogue of the Gaia DR3 ("gaiadr3.gaia_source") using a cone search radius
807+
of 1.0 arcseconds. Therefore, the above example can also be simplified as follows::
808+
809+
>>> from astroquery.gaia import Gaia
810+
>>> Gaia.login()
811+
>>> job = Gaia.cross_match_basic(table_a_full_qualified_name=full_qualified_table_name, table_a_column_ra='raj2000',
812+
table_a_column_dec='dej2000')
813+
>>> result = job.get_results()
805814

806815
2.7. Tables sharing
807816
^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)