Gaia
ESA Gaia mission archive (astrometry, photometry, spectra).
Module name:
gaiaPython class:
astroquery.gaia.GaiaFunctions: 40
Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.
Function |
Summary |
|---|---|
Cone search sorted by distance (sync.) |
|
Cone search sorted by distance (async) |
|
Correct format in the units of the columns |
|
Performs a positional cross-match between the specified tables. |
|
Performs a positional cross-match between the specified tables. |
|
Removes a user table |
|
Gaia.get_args_4_rename_table |
|
Gaia.get_current_column_values_for_update |
|
Gets datalinks associated to the provided identifiers |
|
Gaia.get_new_column_values_for_update |
|
Retrieve the messages to inform users about |
|
Gaia.get_table_update_arguments |
|
Launches a synchronous job |
|
Launches an asynchronous job |
|
Returns all the asynchronous jobs |
|
Loads an asynchronous job |
|
Loads the specified table |
|
Load group with title being group_name |
|
Loads groups |
|
Loads shared items |
|
Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a |
|
Loads all public tables |
|
Loads the specified user |
|
Performs a login. |
|
Performs a login using a GUI dialog |
|
Performs a logout |
|
Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular |
|
Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular |
|
Removes the specified jobs |
|
This method allows you to update the column names of a user table. |
|
Saves job results |
|
Searches for jobs applying the specified filter |
|
Adds user to a group |
|
Creates a group |
|
Deletes a group |
|
Deletes user from a group |
|
Shares a table with a group |
|
Stop sharing a table |
|
Uploads a table to the user private space |
|
Creates a table to the user private space from a job |
Functions
cone_search
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="cone_search",
params={"coordinate": "<coordinate>"},
)
- GaiaClass.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=())
Cone search sorted by distance (sync.) TAP & TAP+
- Parameters:
coordinate (
strorastropy.coordinate,mandatory) – coordinates center pointradius (
strorastropy.units,mandatory) – radiustable_name (
str, optional, defaultmain gaia table name doing the cone search against)ra_column_name (
str, optional, defaultra column in main gaia table) – ra column doing the cone search againstdec_column_name (
str, optional, defaultdec column in main gaia table) – dec column doing the cone search againstoutput_file (
str, optional, defaultNone) – file name where the results are saved ifdump_to_fileis True. If this parameter is not provided, the jobid is used insteadoutput_format (
str, optional, default'votable_gzip') –- results format. Available formats are: ‘votable’, ‘votable_plain’,
’fits’, ‘csv’, ‘ecsv’ and ‘json’, default is ‘votable’.
verbose (
bool, optional, default'False') – flag to display information about the processdump_to_file (
bool, optional, default'False') – if True, the results are saved in a file instead of using memorycolumns (
list, optional, default()) – if empty, all columns will be selected
- Return type:
A Job object
cone_search_async
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="cone_search_async",
params={"coordinate": "<coordinate>"},
)
- GaiaClass.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=())
Cone search sorted by distance (async) TAP & TAP+
- Parameters:
coordinate (
strorastropy.coordinate,mandatory) – coordinates center pointradius (
strorastropy.units,mandatory) – radiustable_name (
str, optional, defaultmain gaia table name doing the cone search against)ra_column_name (
str, optional, defaultra column in main gaia table) – ra column doing the cone search againstdec_column_name (
str, optional, defaultdec column in main gaia table) – dec column doing the cone search againstbackground (
bool, optional, default'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are availableoutput_file (
str, optional, defaultNone) – file name where the results are saved ifdump_to_fileis True. If this parameter is not provided, the jobid is used insteadoutput_format (
str, optional, default'votable_gzip') –- results format. Available formats are: ‘votable’, ‘votable_plain’,
’fits’, ‘csv’, ‘ecsv’ and ‘json’, default is ‘votable’.
verbose (
bool, optional, default'False') – flag to display information about the processdump_to_file (
bool, optional, default'False') – if True, the results are saved in a file instead of using memorycolumns (
list, optional, default()) – if empty, all columns will be selected
- Return type:
A Job object
correct_table_units
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="correct_table_units",
params={"table": "<table>"},
)
- static GaiaClass.correct_table_units(table)
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 “”
cross_match
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="cross_match",
params={"full_qualified_table_name_a": "<full_qualified_table_name_a>", "full_qualified_table_name_b": "<full_qualified_table_name_b>", "results_table_name": "<results_table_name>"},
)
- GaiaClass.cross_match(*, full_qualified_table_name_a, full_qualified_table_name_b, results_table_name, radius=1.0, background=False, verbose=False)
Performs a positional 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_a (
str,mandatory) – a full qualified table name (i.e. schema name and table name)full_qualified_table_name_b (
str,mandatory) – a full qualified table name (i.e. schema name and table name)results_table_name (
str,mandatory) – a table name without schema. The schema is set to the user oneradius (
float (arc. seconds),strorastropy.coordinate, optional, default1.0) – radius (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc sec must be contained within the valid range.background (
bool, optional, default'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are availableverbose (
bool, optional, default'False') – flag to display information about the process
- Return type:
A Job object
cross_match_basic
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="cross_match_basic",
params={"table_a_full_qualified_name": "<table_a_full_qualified_name>", "table_a_column_ra": "<table_a_column_ra>", "table_a_column_dec": "<table_a_column_dec>"},
)
- GaiaClass.cross_match_basic(*, table_a_full_qualified_name, table_a_column_ra, table_a_column_dec, table_b_full_qualified_name=None, table_b_column_ra='ra', table_b_column_dec='dec', results_name=None, radius=1.0, background=False, verbose=False)
Performs a positional cross-match between the specified tables.
This method simples the execution of the method
cross_matchsince it carries out the following steps in one step:updates the user table metadata to flag the positional RA/Dec columns;
launches a positional cross-match as an asynchronous query;
returns all the columns from both tables plus the angular distance (deg) for the cross-matched sources.
The result is a join table with the identifies of both tables and the distance (degrees), that is returned without metadata units. If desired, units can be added using the Units package of Astropy as follows: results[‘separation’].unit = u.degree. To speed up the cross-match, pass the biggest table to the
table_b_full_qualified_nameparameter. TAP+ only- Parameters:
table_a_full_qualified_name (
str,mandatory) – a full qualified table name (i.e. schema name and table name)table_a_column_ra (
str,mandatory) – the ‘ra’ column in the table table_a_full_qualified_nametable_a_column_dec (
str,mandatory) – the ‘dec’ column in the table table_a_full_qualified_nametable_b_full_qualified_name (
str, optional, defaultMAIN_GAIA_TABLE) – a full qualified table name (i.e. schema name and table name)table_b_column_ra (
str, optional, defaultMAIN_GAIA_TABLE_RA) – the ‘ra’ column in the table table_b_full_qualified_nametable_b_column_dec (
str, defaultMAIN_GAIA_TABLE_DEC) – the ‘dec’ column in the table table_b_full_qualified_nameresults_name (
str, optional, defaultNone) – custom name defined by the user for the job that is going to be createdradius (
float (arc. seconds),strorastropy.coordinate, optional, default1.0) – radius (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc sec must be contained within the valid range.background (
bool, optional, default'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are availableverbose (
bool, optional, default'False') – flag to display information about the process
- Return type:
A Job object
delete_user_table
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="delete_user_table",
params={},
)
- GaiaClass.delete_user_table(*, table_name=None, force_removal=False, verbose=False)
Removes a user table
get_args_4_rename_table
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_args_4_rename_table",
params={"table_name": "<table_name>", "new_table_name": "<new_table_name>"},
)
- GaiaClass.get_args_4_rename_table(table_name, new_table_name, new_column_names_dict={})
get_current_column_values_for_update
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_current_column_values_for_update",
params={"column": "<column>"},
)
- static GaiaClass.get_current_column_values_for_update(column)
get_datalinks
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_datalinks",
params={"ids": "<ids>"},
)
- GaiaClass.get_datalinks(ids, *, linking_parameter='SOURCE_ID', verbose=False)
Gets datalinks associated to the provided identifiers TAP+ only
- Parameters:
ids (
str,int,str listorint list,mandatory) – list of identifierslinking_parameter (
str, optional, defaultSOURCE_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_idverbose (
bool, optional, default'False') – flag to display information about the process
- Return type:
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
get_new_column_values_for_update
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_new_column_values_for_update",
params={"list_of_changes": "<list_of_changes>", "column_name": "<column_name>", "c_flags": "<c_flags>", "c_indexed": "<c_indexed>", "c_ucd": "<c_ucd>", "c_utype": "<c_utype>"},
)
- static GaiaClass.get_new_column_values_for_update(list_of_changes, column_name, c_flags, c_indexed, c_ucd, c_utype)
get_status_messages
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_status_messages",
params={},
)
- GaiaClass.get_status_messages()
Retrieve the messages to inform users about the status of Gaia TAP
get_table_update_arguments
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="get_table_update_arguments",
params={"table_name": "<table_name>", "columns": "<columns>", "list_of_changes": "<list_of_changes>"},
)
- static GaiaClass.get_table_update_arguments(table_name, columns, list_of_changes)
launch_job
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="launch_job",
params={"query": "<query>"},
)
- GaiaClass.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)
Launches a synchronous job
- Parameters:
query (
str,mandatory) – query to be executedname (
str, optional, defaultNone) – custom name defined by the user for the job that is going to be createdoutput_file (
str, optional, defaultNone) – file name where the results are saved ifdump_to_fileis True. If this parameter is not provided, the jobid is used insteadoutput_format (
str, 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.
verbose (
bool, optional, default'False') – flag to display information about the processdump_to_file (
bool, optional, default'False') – if True, the results are saved in a file instead of using memoryupload_resource (
str, optional, defaultNone) – resource to be uploaded to UPLOAD_SCHEMAupload_table_name (
str, optional, defaultNone) – resource temporary table name associated to the uploaded resource. This argument is required ifupload_resourceis provided.
- Return type:
A Job object
launch_job_async
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="launch_job_async",
params={"query": "<query>"},
)
- GaiaClass.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)
Launches an asynchronous job
- Parameters:
query (
str,mandatory) – query to be executedname (
str, optional, defaultNone) – custom name defined by the user for the job that is going to be createdoutput_file (
str, optional, defaultNone) – file name where the results are saved ifdump_to_fileis True. If this parameter is not provided, the jobid is used insteadoutput_format (
str, 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.
verbose (
bool, optional, default'False') – flag to display information about the processdump_to_file (
bool, optional, default'False') – if True, the results are saved in a file instead of using memorybackground (
bool, optional, default'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are availableupload_resource (
str, optional, defaultNone) – resource to be uploaded to UPLOAD_SCHEMAupload_table_name (
str, optional, defaultNone) – resource temporary table name associated to the uploaded resource. This argument is required ifupload_resourceis provided.autorun (
boolean, optional, defaultTrue) – if ‘True’, sets ‘phase’ parameter to ‘RUN’, so the framework can start the job.
- Return type:
A Job object
list_async_jobs
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="list_async_jobs",
params={},
)
- GaiaClass.list_async_jobs(*, verbose=False)
Returns all the asynchronous jobs
- Parameters:
verbose (
bool, optional, default'False') – flag to display information about the process- Return type:
A listofJob objects
load_async_job
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_async_job",
params={},
)
- GaiaClass.load_async_job(*, jobid=None, name=None, verbose=False, load_results=True)
Loads an asynchronous job
- Parameters:
jobid (
str,mandatory if no name is provided, defaultNone) – job identifiername (
str,mandatory if no jobid is provided, defaultNone) – job nameverbose (
bool, optional, default'False') – flag to display information about the processload_results (
bool, optional, default'True') – load results associated to this job
- Return type:
A Job object
load_data
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_data",
params={"ids": "<ids>"},
)
- GaiaClass.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', dump_to_file=False, overwrite_output_file=False, verbose=False, output_file=None)
Loads the specified table TAP+ only
- Parameters:
ids (
str,int,str listorint list,mandatory) – List of identifiersdata_release (
str, optional, defaultNone) – 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’ or ‘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 ‘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. 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_type (
str, optional, default‘ALL’toretrieve all data from the listofsources) – Retrieval type identifier: For Gaia DR2, the only possible values is [‘EPOCH_PHOTOMETRY’] For Gaia DR3, the possible values are [‘EPOCH_PHOTOMETRY’, ‘RVS’, ‘XP_CONTINUOUS’, ‘XP_SAMPLED’, ‘MCMC_GSPPHOT’, ‘MCMC_MSC’] For Gaia DR4, the possible values will be [‘EPOCH_PHOTOMETRY’, ‘MEAN_SPECTRUM_RVS’, ‘MCMC_GSP_PHOT’, ‘EPOCH_ASTROMETRY’, ‘EPOCH_SPECTRUM_RVS’, ‘EPOCH_ASTROMETRY_CROWDED_FIELD’, ‘EPOCH_PHOTOMETRY_CROWDED_FIELD’, ‘EPOCH_IMAGE’, ‘EPOCH_PHOTOMETRY_CCD’, ‘EPOCH_SPECTRUM_XP_SSO’, ‘EPOCH_SPECTRUM_XP_CROWDING’, ‘MEAN_SPECTRUM_XP’, ‘EPOCH_SPECTRUM_XP’, ‘CROWDED_FIELD_IMAGE’, ‘EPOCH_ASTROMETRY_BRIGHT’, ‘MEAN_SPECTRUM_XP_GRAVLENS’, ‘EPOCH_FLAGS_NSS’, ‘EPOCH_PARAMETERS_RVS_SINGLE’, ‘EPOCH_PARAMETERS_RVS_DOUBLE’, ‘EPOCH_FLAGS_VARI’]. Note that for ‘CROWDED_FIELD_IMAGE’, only the format ‘fits’ can be used, and its image, in the principal header, will not be available in the returned dictionary. Set ‘output_file’ to retrieve all data: image + tables.linking_parameter (
str, optional, defaultSOURCE_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_idvalid_data (
bool, optional, defaultFalse) – 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.avoid_datatype_check (
boolean, optional, defaultFalse.) – By default, this value will be set to False. If it is set to ‘true’ the Datalink items tags will not be checked.format (
str, optional, default'votable') – Loading format. Other available formats are ‘csv’, ‘ecsv’,’votable_plain’, ‘json’ and ‘fits’dump_to_file (
boolean, optional, defaultFalse.) – If it is true, a compressed directory named “datalink_output_<time_stamp>.zip” with all the DataLink files is made in the current working directory. The <time_stamp> format follows the ISO 8601 standard: “YYYYMMDD_HHMMSS.mmmmmm”.overwrite_output_file (
boolean, optional, defaultFalse) – To overwrite the output file (“datalink_output.zip”) if it already exists.verbose (
bool, optional, default'False') – Flag to display information about the process
- Return type:
A dictionary where the keys are the file namesandits value is a listofastropy.table.table.Table objects
load_group
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_group",
params={},
)
load_groups
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_groups",
params={},
)
- GaiaClass.load_groups(*, verbose=False)
Loads groups
- Parameters:
verbose (
bool, optional, default'False') – flag to display information about the process- Return type:
A setofgroupsofa user
load_table
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_table",
params={"table": "<table>"},
)
- GaiaClass.load_table(table, *, verbose=False)
Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a table in the user’s private area.
load_tables
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_tables",
params={},
)
- GaiaClass.load_tables(*, only_names=False, include_shared_tables=False, verbose=False)
Loads all public tables
- Parameters:
- Return type:
A listoftable objects
load_user
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="load_user",
params={"user_id": "<user_id>"},
)
login
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="login",
params={},
)
- GaiaClass.login(*, user=None, password=None, credentials_file=None, verbose=False)
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.
login_gui
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="login_gui",
params={},
)
- GaiaClass.login_gui(*, verbose=False)
Performs a login using a GUI dialog
- Parameters:
verbose (
bool, optional, default'False') – flag to display information about the process
logout
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="logout",
params={},
)
- GaiaClass.logout(*, verbose=False)
Performs a logout
- Parameters:
verbose (
bool, optional, default'False') – flag to display information about the process
query_object
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="query_object",
params={"coordinate": "<coordinate>"},
)
- GaiaClass.query_object(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())
Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
- Parameters:
coordinate (
strorastropy.coordinates,mandatory) – coordinates center pointradius (
stror astropy.units if no'width'/``’height’`` are provided) – radius (deg)width (
stror astropy.units if no'radius'is provided) – box widthheight (
stror astropy.units if no'radius'is provided) – box heightverbose (
bool, optional, default'False') – flag to display information about the processcolumns (
list, optional, default()) – if empty, all columns will be selected
- Return type:
The job results (astropy.table).
query_object_async
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="query_object_async",
params={"coordinate": "<coordinate>"},
)
- GaiaClass.query_object_async(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())
Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular separation TAP & TAP+
- Parameters:
coordinate (
strorastropy.coordinates,mandatory) – coordinates center pointradius (
stror astropy.units if no'width'/``’height’`` are provided) – radiuswidth (
stror astropy.units if no'radius'is provided) – box widthheight (
stror astropy.units if no'radius'is provided) – box heightverbose (
bool, optional, default'False') – flag to display information about the processcolumns (
list, optional, default()) – if empty, all columns will be selected
- Return type:
The job results (astropy.table).
remove_jobs
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="remove_jobs",
params={"jobs_list": "<jobs_list>"},
)
rename_table
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="rename_table",
params={},
)
- GaiaClass.rename_table(*, table_name=None, new_table_name=None, new_column_names_dict=None, verbose=False)
This method allows you to update the column names of a user table.
- Parameters:
table_name (
str,required) – old name of the user’s tablenew_table_name (
str,required) – new name of the user’s tablenew_column_names_dict (
dict str:str) – dict with pairs “old_column1_name:new_column1_name”verbose (
bool, optional, default'False') – flag to display information about the process
save_results
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="save_results",
params={"job": "<job>"},
)
- GaiaClass.save_results(job, *, verbose=False)
Saves job results
- Parameters:
job (
Job,mandatory) – jobverbose (
bool, optional, default'False') – flag to display information about the process
search_async_jobs
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="search_async_jobs",
params={},
)
- GaiaClass.search_async_jobs(*, jobfilter=None, verbose=False)
Searches for jobs applying the specified filter
upload_table
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="upload_table",
params={},
)
- GaiaClass.upload_table(*, upload_resource=None, table_name=None, table_description=None, format=None, verbose=False)
Uploads a table to the user private space
- Parameters:
upload_resource (
object,mandatory) – table to be uploaded: pyTable, file or URL.table_name (
str,required if uploadResource is provided, defaultNone) – resource temporary table name associated to the uploaded resourcetable_description (
str, optional, defaultNone) – table descriptionformat (
str, optional, default'votable') – resource format. Only formats described in https://docs.astropy.org/en/stable/io/unified.html#built-in-table-readers-writers are accepted.verbose (
bool, optional, default'False') – flag to display information about the process
upload_table_from_job
Call via MCP
astroquery_execute(
module_name="gaia",
function_name="upload_table_from_job",
params={},
)
- GaiaClass.upload_table_from_job(*, job=None, table_name=None, table_description=None, verbose=False)
Creates a table to the user private space from a job
- Parameters:
job (
job,mandatory) – job used to create a table. Could be a string with the jobid or a job itselftable_name (
str, default't'+jobid) – resource temporary table name associated to the uploaded resourcetable_description (
str, optional, defaultNone) – table descriptionverbose (
bool, optional, default'False') – flag to display information about the process