GaiaClass¶
- class astroquery.gaia.GaiaClass(*, tap_plus_conn_handler=None, datalink_handler=None, gaia_tap_server='https://gea.esac.esa.int/', gaia_data_server='https://gea.esac.esa.int/', tap_server_context='tap-server', data_server_context='data-server', verbose=False, show_server_messages=True)[source]¶
Bases:
TapPlus
Proxy class to default TapPlus object (pointing to Gaia Archive)
Constructor
- Parameters:
- urlstr, mandatory if no host is specified, default None
TAP URL
- hoststr, optional, default None
host name
- server_contextstr, optional, default None
server context
- tap_contextstr, optional, default None
tap context
- upload_contextstr, optional, default None
upload context
- table_edit_contextstr, optional, default None
context for all actions to be performed over a existing table
- data_contextstr, optional, default None
data context
- datalink_contextstr, optional, default None
datalink context
- portint, optional, default ‘80’
HTTP port
- sslportint, optional, default ‘443’
HTTPS port
- default_protocol_is_httpsbool, optional, default False
Specifies whether the default protocol to be used is HTTPS
- connhandlerconnection handler object, optional, default None
HTTP(s) connection hander (creator). If no handler is provided, a new one is created.
- verbosebool, optional, default ‘True’
flag to display information about the process
Attributes Summary
Methods Summary
cone_search
(coordinate, *[, radius, ...])Cone search sorted by distance (sync.) TAP & TAP+
cone_search_async
(coordinate, *[, radius, ...])Cone search sorted by distance (async) TAP & TAP+
correct_table_units
(table)Correct format in the units of the columns TAP & TAP+
cross_match
(*, full_qualified_table_name_a, ...)Performs a cross-match between the specified tables The result is a join table (stored in the user storage area) with the identifies of both tables and the distance.
get_datalinks
(ids, *[, linking_parameter, ...])Gets datalinks associated to the provided identifiers TAP+ only
Retrieve the messages to inform users about the status of Gaia TAP
launch_job
(query, *[, name, output_file, ...])Launches a synchronous job
launch_job_async
(query, *[, name, ...])Launches an asynchronous job
load_data
(ids, *[, data_release, ...])Loads the specified table TAP+ only
load_user
(user_id, *[, verbose])Loads the specified user TAP+ only
login
(*[, user, password, credentials_file, ...])Performs a login.
login_gui
(*[, verbose])Performs a login using a GUI dialog
logout
(*[, verbose])Performs a logout
query_object
(coordinate, *[, radius, width, ...])Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
query_object_async
(coordinate, *[, radius, ...])Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
Attributes Documentation
- GAIA_MESSAGES = 'notification?action=GetNotifications'¶
- MAIN_GAIA_TABLE = None¶
- MAIN_GAIA_TABLE_DEC = 'dec'¶
- MAIN_GAIA_TABLE_RA = 'ra'¶
- ROW_LIMIT = 50¶
- VALID_DATALINK_RETRIEVAL_TYPES = ['EPOCH_PHOTOMETRY', 'XP_CONTINUOUS', 'XP_SAMPLED', 'RVS', 'MCMC_GSPPHOT', 'MCMC_MSC', 'EPOCH_ASTROMETRY', 'RV_EPOCH_SINGLE', 'RV_EPOCH_DOUBLE', 'RVS_EPOCH', 'RVS_TRANSIT']¶
- VALID_LINKING_PARAMETERS = {'IMAGE_ID', 'SOURCE_ID', 'TRANSIT_ID'}¶
Methods Documentation
- cone_search(coordinate, *, radius=None, table_name=None, ra_column_name='ra', dec_column_name='dec', output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, columns=())[source]¶
Cone search sorted by distance (sync.) TAP & TAP+
- Parameters:
- coordinatestr or astropy.coordinate, mandatory
coordinates center point
- radiusstr or astropy.units, mandatory
radius
- table_namestr, optional, default main gaia table name doing the cone search against
- ra_column_namestr, optional, default ra column in main gaia table
ra column doing the cone search against
- dec_column_namestr, optional, default dec column in main gaia table
dec column doing the cone search against
- output_filestr, optional, default None
file name where the results are saved if
dump_to_file
is True. If this parameter is not provided, the jobid is used instead- output_formatstr, optional, default ‘votable_gzip’
- results format. Available formats are: ‘votable’, ‘votable_plain’,
‘fits’, ‘csv’, ‘ecsv’ and ‘json’, default is ‘votable’.
- verbosebool, optional, default ‘False’
flag to display information about the process
- dump_to_filebool, optional, default ‘False’
if True, the results are saved in a file instead of using memory
- columns: list, optional, default ()
if empty, all columns will be selected
- Returns:
- A Job object
- cone_search_async(coordinate, *, radius=None, table_name=None, ra_column_name='ra', dec_column_name='dec', background=False, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, columns=())[source]¶
Cone search sorted by distance (async) TAP & TAP+
- Parameters:
- coordinatestr or astropy.coordinate, mandatory
coordinates center point
- radiusstr or astropy.units, mandatory
radius
- table_namestr, optional, default main gaia table name doing the cone search against
- ra_column_namestr, optional, default ra column in main gaia table
ra column doing the cone search against
- dec_column_namestr, optional, default dec column in main gaia table
dec column doing the cone search against
- backgroundbool, optional, default ‘False’
when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
- output_filestr, optional, default None
file name where the results are saved if
dump_to_file
is True. If this parameter is not provided, the jobid is used instead- output_formatstr, optional, default ‘votable_gzip’
- results format. Available formats are: ‘votable’, ‘votable_plain’,
‘fits’, ‘csv’, ‘ecsv’ and ‘json’, default is ‘votable’.
- verbosebool, optional, default ‘False’
flag to display information about the process
- dump_to_filebool, optional, default ‘False’
if True, the results are saved in a file instead of using memory
- columns: list, optional, default ()
if empty, all columns will be selected
- Returns:
- A Job object
- static correct_table_units(table)[source]¶
Correct format in the units of the columns TAP & TAP+
- Parameters:
- table
Table
, mandatory change the format of the units in the columns of the input table: ‘.’ by ‘ ‘ and “’” by “”
- table
- cross_match(*, full_qualified_table_name_a, full_qualified_table_name_b, results_table_name, radius=1.0, background=False, verbose=False)[source]¶
Performs a cross-match between the specified tables The result is a join table (stored in the user storage area) with the identifies of both tables and the distance. TAP+ only
- Parameters:
- full_qualified_table_name_astr, mandatory
a full qualified table name (i.e. schema name and table name)
- full_qualified_table_name_bstr, mandatory
a full qualified table name (i.e. schema name and table name)
- results_table_namestr, mandatory
a table name without schema. The schema is set to the user one
- radiusfloat (arc. seconds), optional, default 1.0
radius (valid range: 0.1-10.0)
- backgroundbool, optional, default ‘False’
when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A Job object
- get_datalinks(ids, *, linking_parameter='SOURCE_ID', verbose=False)[source]¶
Gets datalinks associated to the provided identifiers TAP+ only
- Parameters:
- idsstr, int, str list or int list, mandatory
list of identifiers
- linking_parameterstr, optional, default SOURCE_ID, valid values: SOURCE_ID, TRANSIT_ID, IMAGE_ID
By default, all the identifiers are considered as source_id SOURCE_ID: the identifiers are considered as source_id TRANSIT_ID: the identifiers are considered as transit_id IMAGE_ID: the identifiers are considered as sif_observation_id
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A table object
Examples
Id formats.
– Gaia.get_datalinks(iids=1104405489608579584) # single id as an int
– Gaia.get_datalinks(ids=’1104405489608579584, 1809140662896080256’) # multiple ids as a str
– Gaia.get_datalinks(ids=(1104405489608579584, 1809140662896080256)) # multiple ids as an int list
– Gaia.get_datalinks(ids=(‘1104405489608579584’,’1809140662896080256’)) # multiple ids as str list
– Gaia.get_datalinks(ids=’4295806720-38655544960’) # range of ids as a str
– Gaia.get_datalinks(ids=’4295806720-38655544960, 549755818112-1275606125952’) # multiple ranges of ids as a str
– Gaia.get_datalinks(ids=(‘4295806720-38655544960’, ‘549755818112-1275606125952’) # multiple ranges of ids as a str list
– Gaia.get_datalinks(ids=’Gaia DR3 1104405489608579584’) # single designator
– Gaia.get_datalinks(ids=’Gaia DR3 1104405489608579584, Gaia DR3 1809140662896080256’) # multiple designators as a str
– Gaia.get_datalinks(ids=(‘Gaia DR3 1104405489608579584’,’Gaia DR3 1809140662896080256’)) # multiple designators as a str list
– Gaia.get_datalinks(ids=’Gaia DR3 4295806720-Gaia DR3 38655544960’) # range of designators as a str
– Gaia.get_datalinks(ids=’Gaia DR3 4295806720-Gaia DR3 38655544960, Gaia DR3 549755818112-Gaia DR3 1275606125952’) # multiple ranges of designators as a str
– Gaia.get_datalinks(ids=(‘Gaia DR3 4295806720-Gaia DR3 38655544960’, ‘Gaia DR3 549755818112-Gaia DR3 1275606125952’)) # multiple ranges of designators as a str list
– Gaia.get_datalinks(ids=’Gaia DR3 4295806720-Gaia DR3 38655544960, Gaia DR2 549755818112-Gaia DR2 1275606125952’) # multiple ranges of designators with different releases as a str
– Gaia.get_datalinks(ids=(‘Gaia DR3 4295806720-Gaia DR3 38655544960’, ‘Gaia DR2 549755818112-Gaia DR2 1275606125952’)) # multiple ranges of designators with different releases as a str list
- launch_job(query, *, name=None, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, upload_resource=None, upload_table_name=None)[source]¶
Launches a synchronous job
- Parameters:
- querystr, mandatory
query to be executed
- namestr, optional, default None
custom name defined by the user for the job that is going to be created
- output_filestr, optional, default None
file name where the results are saved if
dump_to_file
is True. If this parameter is not provided, the jobid is used instead- output_formatstr, optional, default ‘votable_gzip’
- results format. Available formats are: ‘votable_gzip’, ‘votable’, ‘votable_plain’,
‘fits’, ‘csv’, ‘ecsv’ and ‘json’, default is ‘votable_gzip’. Returned results for ‘votable_gzip’, ‘ecsv’ and ‘fits’ formats are compressed gzip files.
- verbosebool, optional, default ‘False’
flag to display information about the process
- dump_to_filebool, optional, default ‘False’
if True, the results are saved in a file instead of using memory
- upload_resourcestr, optional, default None
resource to be uploaded to UPLOAD_SCHEMA
- upload_table_namestr, optional, default None
resource temporary table name associated to the uploaded resource. This argument is required if
upload_resource
is provided.
- Returns:
- A Job object
- launch_job_async(query, *, name=None, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, background=False, upload_resource=None, upload_table_name=None, autorun=True)[source]¶
Launches an asynchronous job
- Parameters:
- querystr, mandatory
query to be executed
- namestr, optional, default None
custom name defined by the user for the job that is going to be created
- output_filestr, optional, default None
file name where the results are saved if
dump_to_file
is True. If this parameter is not provided, the jobid is used instead- output_formatstr, optional, default ‘votable_gzip’
- results format. Available formats are: ‘votable_gzip’, ‘votable’, ‘votable_plain’,
‘fits’, ‘csv’ and ‘json’, default is ‘votable_gzip’. Returned results for ‘votable_gzip’ ‘ecsv’ and ‘fits’ format are compressed gzip files.
- verbosebool, optional, default ‘False’
flag to display information about the process
- dump_to_filebool, optional, default ‘False’
if True, the results are saved in a file instead of using memory
- backgroundbool, optional, default ‘False’
when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
- upload_resourcestr, optional, default None
resource to be uploaded to UPLOAD_SCHEMA
- upload_table_namestr, optional, default None
resource temporary table name associated to the uploaded resource. This argument is required if
upload_resource
is provided.- autorunboolean, optional, default True
if ‘True’, sets ‘phase’ parameter to ‘RUN’, so the framework can start the job.
- Returns:
- A Job object
- load_data(ids, *, data_release=None, data_structure='INDIVIDUAL', retrieval_type='ALL', linking_parameter='SOURCE_ID', valid_data=False, band=None, avoid_datatype_check=False, format='votable_gzip', output_file=None, overwrite_output_file=False, verbose=False)[source]¶
Loads the specified table TAP+ only
- Parameters:
- idsstr, int, str list or int list, mandatory
list of identifiers
- data_release: str, optional, default None
data release from which data should be taken. E.g. ‘Gaia DR3’ By default, it takes the current default one.
- data_structure: str, optional, default ‘INDIVIDUAL’
it can be ‘INDIVIDUAL’, ‘COMBINED’, ‘RAW’: ‘INDIVIDUAL’ means products are provided in separate files for each sourceId. All files are zipped in a single bundle, even if only one source/file is considered ‘COMBINED’ means products are provided in a single file concatenating the data of all sourceIds together. How this is organised depends on the chosen format ‘RAW’ means products are provided following a Data Model similar to that used in the MDB, meaning in 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
- retrieval_typestr, optional, default ‘ALL’ to retrieve all data from the list of sources
retrieval type identifier. For GAIA DR2 possible values are [‘EPOCH_PHOTOMETRY’] For GAIA DR3, possible values are [‘EPOCH_PHOTOMETRY’, ‘RVS’, ‘XP_CONTINUOUS’, ‘XP_SAMPLED’, ‘MCMC_GSPPHOT’ or ‘MCMC_MSC’] For GAIA DR4, possible values will be [‘EPOCH_PHOTOMETRY’, ‘RVS’, ‘XP_CONTINUOUS’, ‘XP_SAMPLED’, ‘MCMC_GSPPHOT’, ‘MCMC_MSC’, ‘EPOCH_ASTROMETRY’, ‘RV_EPOCH_SINGLE’, ‘RV_EPOCH_DOUBLE’, ‘RVS_EPOCH’ or ‘RVS_TRANSIT’]
- linking_parameterstr, optional, default SOURCE_ID, valid values: SOURCE_ID, TRANSIT_ID, IMAGE_ID
By default, all the identifiers are considered as source_id SOURCE_ID: the identifiers are considered as source_id TRANSIT_ID: the identifiers are considered as transit_id IMAGE_ID: the identifiers are considered as sif_observation_id
- valid_databool, optional, default False
By default, the epoch photometry service returns all available data, including data rows where flux is null and/or the rejected_by_photometry flag is set to True. In order to retrieve only valid data (data rows where flux is not null and/or the rejected_by_photometry flag is set to False) this request parameter should be included with valid_data=True.
- bandstr, optional, default None, valid values: G, BP, RP
By default, the epoch photometry service returns all the available photometry bands for the requested source. This parameter allows to filter the output lightcurve by its band.
- avoid_datatype_check: boolean, optional, default False.
By default, this value will be set to False. If it is set to ‘true’ the Datalink items tags will not be checked.
- formatstr, optional, default ‘votable_gzip’
loading format. Other available formats are ‘votable’, ‘csv’, ‘ecsv’,’votable_plain’ and ‘fits’
- output_filestring or pathlib.PosixPath, optional, default None
file where the results are saved. If it is not provided, the http response contents are returned.
- overwrite_output_fileboolean, optional, default False
To overwrite the output_file if it already exists.
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A table object
- load_user(user_id, *, verbose=False)[source]¶
Loads the specified user TAP+ only
- Parameters:
- user_idstr, mandatory
user id to load
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A user
- login(*, user=None, password=None, credentials_file=None, verbose=False)[source]¶
Performs a login. User and password arguments can be used or a file that contains username and password (2 lines: one for username and the following one for the password). If no arguments are provided, a prompt asking for username and password will appear.
- Parameters:
- userstr, default None
login name
- passwordstr, default None
user password
- credentials_filestr, default None
file containing user and password in two lines
- verbosebool, optional, default ‘False’
flag to display information about the process
- login_gui(*, verbose=False)[source]¶
Performs a login using a GUI dialog
- Parameters:
- verbosebool, optional, default ‘False’
flag to display information about the process
- logout(*, verbose=False)[source]¶
Performs a logout
- Parameters:
- verbosebool, optional, default ‘False’
flag to display information about the process
- query_object(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())[source]¶
Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
- Parameters:
- coordinatestr or astropy.coordinates, mandatory
coordinates center point
- radiusstr or astropy.units if no ‘width’/’height’ are provided
radius (deg)
- widthstr or astropy.units if no ‘radius’ is provided
box width
- heightstr or astropy.units if no ‘radius’ is provided
box height
- verbosebool, optional, default ‘False’
flag to display information about the process
- columns: list, optional, default ()
if empty, all columns will be selected
- Returns:
- The job results (astropy.table).
- query_object_async(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())[source]¶
Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
- Parameters:
- coordinatestr or astropy.coordinates, mandatory
coordinates center point
- radiusstr or astropy.units if no ‘width’/’height’ are provided
radius
- widthstr or astropy.units if no ‘radius’ is provided
box width
- heightstr or astropy.units if no ‘radius’ is provided
box height
- verbosebool, optional, default ‘False’
flag to display information about the process
- columns: list, optional, default ()
if empty, all columns will be selected
- Returns:
- The job results (astropy.table).