Skip to content

Commit a039440

Browse files
mhsarmientojespinosaar
authored andcommitted
This new commit implements ticket GAIAPCR-1003 and improves the help information for method 'gaia_load' data.
1 parent 2a6b34c commit a039440

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

astroquery/gaia/core.py

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
European Space Agency (ESA)
1212
1313
Created on 30 jun. 2016
14-
14+
Modified on 18 Ene. 2022 by mhsarmiento
1515
1616
"""
1717
from requests import HTTPError
@@ -173,16 +173,18 @@ def load_data(self, ids, data_release=None, data_structure='INDIVIDUAL', retriev
173173
By default, it takes the current default one.
174174
data_structure: str, optional, default 'INDIVIDUAL'
175175
it can be 'INDIVIDUAL', 'COMBINED', 'RAW':
176-
'INDIVIDUAL' products are provided in separate files for each sourceId. All files are zipped in a single
177-
bundle, even if only one source/file is considered
178-
'COMBINED' products are provided in a single file concatenating the data of all sourceIds together.
179-
How this is organised depends on the chosen format
180-
'RAW' products are provided following a Data Model similar to that used in the MDB, meaning in
181-
particular that parameters stored as arrays will remain as such. Like in the COMBINED structure, a single file is provided for the data of all sourceIds together, but in this case there will be always be one row per sourceId
182-
retrieval_type : str, optional, default 'ALL'
183-
retrieval type identifier. It can be either 'epoch_photometry'
184-
for compatibility reasons or 'ALL' to retrieve all data from
185-
the list of sources.
176+
'INDIVIDUAL' means products are provided in separate files for each sourceId. All files are zipped in a single
177+
bundle, even if only one source/file is considered
178+
'COMBINED' means products are provided in a single file concatenating the data of all sourceIds together.
179+
How this is organised depends on the chosen format
180+
'RAW' means products are provided following a Data Model similar to that used in the MDB, meaning in
181+
particular that parameters stored as arrays will remain as such. Like in the COMBINED structure, a single
182+
file is provided for the data of all sourceIds together, but in this case there will be always be one
183+
row per sourceId
184+
retrieval_type : str, optional, default 'ALL' to retrieve all data from the list of sources
185+
retrieval type identifier. For GAIA DR2 possible values are ['EPOCH_PHOTOMETRY']
186+
For future GAIA DR3 (Once published), possible values will be ['EPOC_PHOTOMETRY', 'RVS', 'XP_CONTINUOUS',
187+
'XP_SAMPLED', 'MCMC_GSPPHOT' or 'MCMC_MSC']
186188
valid_data : bool, optional, default True
187189
By default, the epoch photometry service returns only valid data,
188190
that is, all data rows where flux is not null and
@@ -197,7 +199,7 @@ def load_data(self, ids, data_release=None, data_structure='INDIVIDUAL', retriev
197199
By default, this value will be set to False. If it is set to 'true'
198200
the Datalink items tags will not be checked.
199201
format : str, optional, default 'votable'
200-
loading format. Other available formats are 'csv' and 'fits'
202+
loading format. Other available formats are 'csv', 'ecsv', 'votable_plain' and 'fits'
201203
output_file : string, optional, default None
202204
file where the results are saved.
203205
If it is not provided, the http response contents are returned.
@@ -210,6 +212,7 @@ def load_data(self, ids, data_release=None, data_structure='INDIVIDUAL', retriev
210212
-------
211213
A table object
212214
"""
215+
213216
if retrieval_type is None:
214217
raise ValueError("Missing mandatory argument 'retrieval_type'")
215218

0 commit comments

Comments
 (0)