ISOClass¶
- class astroquery.esa.iso.ISOClass(tap_handler=None)[source]¶
Bases:
BaseQuery
Attributes Summary
Methods Summary
download_data
(tdt, *[, retrieval_type, ...])Download data from ISO
get_columns
(table_name, *[, only_names, verbose])Get the available columns for a table in XSA TAP service
get_download_link
(tdt, retrieval_type, ...)Get download link for ISO
get_postcard
(tdt, *[, filename, verbose])Download postcards from ISO Data Archive
get_postcard_link
(tdt[, filename, verbose])Get postcard link for ISO
get_tables
(*[, only_names, verbose])Get the available table in XSA TAP service
query_ida_tap
(query, *[, output_file, ...])Launches a synchronous job to query ISO Tabular Access Protocol Service
Attributes Documentation
- TIMEOUT = 60¶
- data_url = 'https://nida.esac.esa.int/nida-sl-tap/data?'¶
- metadata_url = 'https://nida.esac.esa.int/nida-sl-tap/tap/'¶
Methods Documentation
- download_data(tdt, *, retrieval_type=None, filename=None, verbose=False, **kwargs)[source]¶
Download data from ISO
- Parameters:
- tdtstring
id of the Target Dedicated Time (observation identifier) to be downloaded, mandatory The identifier of the observation we want to retrieve, 8 digits example: 40001501
- product_levelstring
level to download, optional, by default everything is selected values: DEFAULT_DATA_SET, FULLY_PROC, RAW_DATA, BASIC_SCIENCE, QUICK_LOOK, DEFAULT_DATA_SET, HPDP, ALL
- retrieval_typestring
type of retrieval: OBSERVATION for full observation or STANDALONE for single files
- filenamestring
file name to be used to store the file
- verbosebool
optional, default ‘False’ flag to display information about the process
- Returns:
- File name of downloaded data
- get_columns(table_name, *, only_names=True, verbose=False)[source]¶
Get the available columns for a table in XSA TAP service
- Parameters:
- table_namestring, mandatory, default None
table name of which, columns will be returned
- only_namesbool, TAP+ only, optional, default ‘True’
True to load table names only
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A list of columns
- get_download_link(tdt, retrieval_type, filename, verbose, **kwargs)[source]¶
Get download link for ISO
- Parameters:
- tdtstring
id of the Target Dedicated Time (observation identifier) to be downloaded, mandatory The identifier of the observation we want to retrieve, 8 digits example: 40001501
- product_levelstring
level to download, optional, by default everything is selected values: DEFAULT_DATA_SET, FULLY_PROC, RAW_DATA, BASIC_SCIENCE, QUICK_LOOK, DEFAULT_DATA_SET, HPDP, ALL
- retrieval_typestring
type of retrieval: OBSERVATION for full observation or STANDALONE for single files
- filenamestring
file name to be used to store the file
- verbosebool
optional, default ‘False’ flag to display information about the process
- Returns:
- None if not verbose. It downloads the observation indicated
- If verbose returns the filename
- get_postcard(tdt, *, filename=None, verbose=False)[source]¶
Download postcards from ISO Data Archive
- Parameters:
- tdtstring
id of the observation for which download the postcard, mandatory The identifier of the observation we want to retrieve, regardless of whether it is simple or composite.
- filenamestring
file name to be used to store the postcard, optional, default None
- verbosebool
optional, default ‘False’ Flag to display information about the process
- Returns:
- File name to be used to store the postcard
- get_postcard_link(tdt, filename=None, verbose=False)[source]¶
Get postcard link for ISO
- Parameters:
- tdtstring
id of the Target Dedicated Time (observation identifier) to be downloaded, mandatory The identifier of the observation we want to retrieve, 8 digits example: 40001501
- product_levelstring
level to download, optional, by default everything is selected values: DEFAULT_DATA_SET, FULLY_PROC, RAW_DATA, BASIC_SCIENCE, QUICK_LOOK, DEFAULT_DATA_SET, HPDP, ALL
- retrieval_typestring
type of retrieval: OBSERVATION for full observation or STANDALONE for single files
- filenamestring
file name to be used to store the file
- verbosebool
optional, default ‘False’ flag to display information about the process
- Returns:
- The postcard filename
- get_tables(*, only_names=True, verbose=False)[source]¶
Get the available table in XSA TAP service
- Parameters:
- only_namesbool, TAP+ only, optional, default ‘True’
True to load table names only
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A list of tables
- query_ida_tap(query, *, output_file=None, output_format='votable', verbose=False)[source]¶
Launches a synchronous job to query ISO Tabular Access Protocol Service
- Parameters:
- querystr, mandatory
query (adql) to be executed
- output_filestr, optional, default None
file name where the results are saved if dumpToFile is True. If this parameter is not provided, the jobid is used instead
- output_formatstr, optional, default ‘votable’
possible values ‘votable’ or ‘csv’
- verbosebool, optional, default ‘False’
flag to display information about the process
- Returns:
- A table object