Skip to content

Commit 1eda4c4

Browse files
bsipoczbsipocz
authored
Merge pull request #1871 from mfonism/fix-1760 [nodeploy]
Update documentation for the gaia query object (#1760)
2 parents 7e615e4 + 4c17354 commit 1eda4c4

File tree

1 file changed

+91
-21
lines changed

1 file changed

+91
-21
lines changed

‎docs/gaia/gaia.rst

+91-21
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,85 @@ degrees around an specific point in RA/Dec coordinates.
9292
>>> r = Gaia.query_object_async(coordinate=coord, width=width, height=height)
9393
>>> r.pprint()
9494
95-
dist solution_id ... ecl_lat
96-
... Angle[deg]
97-
--------------------- ------------------- ... -------------------
98-
0.0026029414438061079 1635378410781933568 ... -36.779151653783892
99-
0.0038537557334594502 1635378410781933568 ... -36.773899692008634
100-
0.0045451702670639632 1635378410781933568 ... -36.772645786277522
101-
0.0056131312891700424 1635378410781933568 ... -36.781488832325074
102-
... ... ... ...
103-
Length = 152 rows
95+
dist solution_id ... epoch_photometry_url
96+
...
97+
--------------------- ------------------- ... --------------------
98+
0.0026034636994048854 1635721458409799680 ...
99+
0.0038518741347606357 1635721458409799680 ...
100+
0.00454542650096783 1635721458409799680 ...
101+
0.005613919443965546 1635721458409799680 ...
102+
0.005846434715822121 1635721458409799680 ...
103+
0.006209042666371929 1635721458409799680 ...
104+
0.007469463683838576 1635721458409799680 ...
105+
0.008202004514524316 1635721458409799680 ...
106+
0.008338509690874027 1635721458409799680 ...
107+
0.008406677772258921 1635721458409799680 ...
108+
... ... ... ...
109+
0.01943176697471851 1635721458409799680 ...
110+
0.019464719601172412 1635721458409799680 ...
111+
0.019467068628703368 1635721458409799680 ...
112+
0.019752561500226976 1635721458409799680 ...
113+
0.01991656886177004 1635721458409799680 ...
114+
0.020149589233310516 1635721458409799680 ...
115+
0.020307185970548904 1635721458409799680 ...
116+
0.020454730686780127 1635721458409799680 ...
117+
0.020802655215768254 1635721458409799680 ...
118+
0.021615117161838747 1635721458409799680 ...
119+
Length = 50 rows
120+
121+
Queries return a limited number of rows controlled by ``Gaia.ROW_LIMIT``. To change the default behaviour set this appropriately.
122+
123+
.. code-block:: python
124+
125+
>>> Gaia.ROW_LIMIT = 8
126+
>>> r = Gaia.query_object_async(coordinate=coord, width=width, height=height)
127+
>>> r.pprint()
128+
129+
dist solution_id ... epoch_photometry_url
130+
...
131+
--------------------- ------------------- ... --------------------
132+
0.0026034636994048854 1635721458409799680 ...
133+
0.0038518741347606357 1635721458409799680 ...
134+
0.00454542650096783 1635721458409799680 ...
135+
0.005613919443965546 1635721458409799680 ...
136+
0.005846434715822121 1635721458409799680 ...
137+
0.006209042666371929 1635721458409799680 ...
138+
0.007469463683838576 1635721458409799680 ...
139+
0.008202004514524316 1635721458409799680 ...
140+
141+
To return an unlimited number of rows set ``Gaia.ROW_LIMIT`` to -1.
142+
143+
.. code-block:: python
144+
145+
>>> Gaia.ROW_LIMIT = -1
146+
>>> r = Gaia.query_object_async(coordinate=coord, width=width, height=height)
147+
>>> r.pprint()
148+
149+
dist solution_id ... epoch_photometry_url
150+
...
151+
--------------------- ------------------- ... --------------------
152+
0.0026034636994048854 1635721458409799680 ...
153+
0.0038518741347606357 1635721458409799680 ...
154+
0.00454542650096783 1635721458409799680 ...
155+
0.005613919443965546 1635721458409799680 ...
156+
0.005846434715822121 1635721458409799680 ...
157+
0.006209042666371929 1635721458409799680 ...
158+
0.007469463683838576 1635721458409799680 ...
159+
0.008202004514524316 1635721458409799680 ...
160+
0.008338509690874027 1635721458409799680 ...
161+
0.008406677772258921 1635721458409799680 ...
162+
... ... ... ...
163+
0.049718018073992835 1635721458409799680 ...
164+
0.04977869666747251 1635721458409799680 ...
165+
0.05006096698512638 1635721458409799680 ...
166+
0.05038566478030134 1635721458409799680 ...
167+
0.050827895451955894 1635721458409799680 ...
168+
0.050860907684754444 1635721458409799680 ...
169+
0.051038347209386326 1635721458409799680 ...
170+
0.05121063325107872 1635721458409799680 ...
171+
0.051957226883925664 1635721458409799680 ...
172+
0.05320916763883812 1635721458409799680 ...
173+
Length = 176 rows
104174
105175
106176
1.2. Cone search
@@ -121,16 +191,16 @@ radius argument.
121191
>>> r = j.get_results()
122192
>>> r.pprint()
123193
124-
dist solution_id ... ecl_lat
125-
... Angle[deg]
126-
--------------------- ------------------- ... -------------------
127-
0.0026029414438061079 1635378410781933568 ... -36.779151653783892
128-
0.0038537557334594502 1635378410781933568 ... -36.773899692008634
129-
0.0045451702670639632 1635378410781933568 ... -36.772645786277522
130-
0.0056131312891700424 1635378410781933568 ... -36.781488832325074
131-
... ... ... ...
132-
Length = 2000 rows
133-
194+
solution_id designation ... dist
195+
...
196+
------------------- ---------------------------- ... ---------------------
197+
1635721458409799680 Gaia DR2 6636090334814214528 ... 0.0026034636994048854
198+
1635721458409799680 Gaia DR2 6636090339113063296 ... 0.0038518741347606357
199+
1635721458409799680 Gaia DR2 6636090334814217600 ... 0.00454542650096783
200+
1635721458409799680 Gaia DR2 6636089583198816640 ... 0.005613919443965546
201+
1635721458409799680 Gaia DR2 6636090334814218752 ... 0.005846434715822121
202+
... ... ... ...
203+
Length = 50 rows
134204
135205
136206
1.3. Getting public tables metadata
@@ -257,7 +327,7 @@ available formats are: 'votable', 'votable_plain', 'fits', 'csv' and 'json', def
257327
... "matched_observations,duplicated_source,phot_variable_flag "
258328
... "from gaiadr2.gaia_source order by source_id",
259329
... dump_to_file=True, output_format='votable')
260-
>>> print(job.outputFile)
330+
>>> print(job.outputFile)
261331
262332
1592474300458O-result.vot.gz
263333
@@ -541,7 +611,7 @@ Your schema name will be automatically added to the provided table name.
541611
>>> url = ("http://tapvizier.u-strasbg.fr/TAPVizieR/tap/sync/?"
542612
... "REQUEST=doQuery&lang=ADQL&FORMAT=votable&"
543613
... "QUERY=select+*+from+TAP_SCHEMA.columns+where+table_name='II/336/apass9'")
544-
614+
545615
>>> job = Gaia.upload_table(upload_resource=url, table_name="table_test_from_url",
546616
... table_description="Some description")
547617

0 commit comments

Comments
 (0)