ESA JWST

ESA James Webb Space Telescope archive.

• Module name: esa_jwst

• Python class: astroquery.esa.jwst.Jwst

• Functions: 26

Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.

Function	Summary
clear_cache	Removes all cache files.
cone_search	Cone search sorted by distance in sync/async mode
download_files_from_program	Get JWST products given its proposal ID.
get_decoded_string	Jwst.get_decoded_string
get_obs_products	Get a JWST product given its observation ID.
get_product	Get a JWST product given its Artifact ID or File name.
get_product_list	Get the list of products of a given JWST observation_id.
get_related_observations	In case of processing levels < 3, get the list of level 3
get_status_messages	Retrieve the messages to inform users about
gzip_uncompress	Jwst.gzip_uncompress
gzip_uncompress_and_rename_single_file	Jwst.gzip_uncompress_and_rename_single_file
is_gz_file	Jwst.is_gz_file
launch_job	Launches a synchronous or asynchronous job
list_async_jobs	Returns all the asynchronous jobs
load_async_job	Loads an asynchronous job
load_table	Loads the specified table
load_tables	Loads all public tables
login	Performs a login.
logout	Performs a logout
query_region	Launches a query region job in sync/async mode
query_target	Searches for a specific target defined by its name and other parameters
remove_jobs	Removes the specified jobs
reset_cache_location	Resets the cache location to the default astropy cache
resolve_target_coordinates	Jwst.resolve_target_coordinates
save_results	Saves job results
search_async_jobs	Searches for jobs applying the specified filter

Functions

clear_cache

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="clear_cache",
    params={},
)

JwstClass.clear_cache()

Removes all cache files.

cone_search

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="cone_search",
    params={"coordinate": "<coordinate>", "radius": "<radius>"},
)

JwstClass.cone_search(coordinate, radius, *, observation_id=None, cal_level='Top', prod_type=None, instrument_name=None, filter_name=None, proposal_id=None, only_public=False, show_all_columns=False, async_job=False, background=False, output_file=None, output_format='votable', verbose=False, dump_to_file=False)

Cone search sorted by distance in sync/async mode TAP & TAP+

Parameters:

• coordinate (astropy.coordinate, mandatory) – coordinates center point

• radius (astropy.units, mandatory) – radius

• observation_id (str, optional, default None) – get the observation given by its ID.

• cal_level (object, optional, default 'Top') – get the planes with the given calibration level. Options are: ‘Top’: str, only the planes with the highest calibration level 1,2,3: int, the given calibration level

• prod_type (str, optional, default None) – get the observations providing the given product type. Options are: ‘image’,’cube’,’measurements’,’spectrum’: str, only results of the given product type

• instrument_name (str, optional, default None) – get the observations corresponding to the given instrument name. Options are: ‘NIRISS’, ‘NIRSPEC’, ‘NIRCAM’, ‘MIRI’, ‘FGS’: str, only results of the given instrument

• filter_name (str, optional, default None) – get the observations made with the given filter.

• proposal_id (str, optional, default None) – get the observations from the given proposal ID.

• only_public (bool, optional, default 'False') – flag to show only metadata corresponding to public observations

• show_all_columns (bool, optional, default 'False') – flag to show all available columns in the output. Default behaviour is to show the most representative columns only

• async_job (bool, optional, default 'False') – executes the job in asynchronous/synchronous mode (default synchronous)

• background (bool, optional, default 'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available

• output_file (str, 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_format (str, optional, default 'votable') – results format. Options are: ‘votable’: str, binary VOTable format ‘csv’: str, comma-separated values format ‘fits’: str, FITS format

• verbose (bool, optional, default 'False') – flag to display information about the process

• dump_to_file (bool, optional, default 'False') – if True, the results are saved in a file instead of using memory

Return type:

A Job object

download_files_from_program

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="download_files_from_program",
    params={"proposal_id": "<proposal_id>"},
)

JwstClass.download_files_from_program(proposal_id, *, product_type=None, verbose=False)

Get JWST products given its proposal ID.

Parameters:

• proposal_id (int, mandatory) – Program or Proposal ID associated to the observations.

• product_type (str or list, optional, default None) – If the string or at least one element of the list is empty, the value is replaced by None. With None, all products will be downloaded. Possible string values: ‘thumbnail’, ‘preview’, ‘auxiliary’, ‘science’ or ‘info’. Posible list values: any combination of string values.

• verbose (bool, optional, default 'False') – flag to display information about the process

Returns:

allobs – Returns the observationsid included into the proposal_id.

Return type:

list

get_decoded_string

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_decoded_string",
    params={"str": "<str>"},
)

static JwstClass.get_decoded_string(str)

get_obs_products

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_obs_products",
    params={},
)

JwstClass.get_obs_products(*, observation_id=None, cal_level='ALL', product_type=None, output_file=None)

Get a JWST product given its observation ID.

Parameters:

• observation_id (str, mandatory) – Observation identifier.

• cal_level (str or int, optional) – Calibration level. Default value ia ‘ALL’, to download all the products associated to this observation_id and lower levels. Requesting more accurate levels than the one associated to the observation_id is not allowed (as level 3 observations are composite products based on level 2 products). To request upper levels, please use get_related_observations functions first. Possible values: ‘ALL’, 3, 2, 1, -1

• product_type (str or list, optional, default None) – If the string or at least one element of the list is empty, the value is replaced by None. With None, all products will be downloaded. Possible string values: ‘thumbnail’, ‘preview’, ‘auxiliary’, ‘science’ or ‘info’. Posible list values: any combination of string values.

• output_file (str, optional) – Output file. If no value is provided, a temporary one is created.

Returns:

local_path – Returns the local path where the product(s) are saved.

Return type:

str

get_product

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_product",
    params={},
)

JwstClass.get_product(*, artifact_id=None, file_name=None)

Get a JWST product given its Artifact ID or File name.

Parameters:

• artifact_id (str, mandatory (if no file_name is provided)) – Artifact ID of the product.

• file_name (str, mandatory (if no artifact_id is provided))

Returns:

local_path – Returns the local path that the file was downloaded to.

Return type:

str

get_product_list

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_product_list",
    params={},
)

JwstClass.get_product_list(*, observation_id=None, cal_level='ALL', product_type=None)

Get the list of products of a given JWST observation_id.

Parameters:

• observation_id (str, mandatory) – Observation identifier.

• cal_level (str or int, optional) – Calibration level. Default value is ‘ALL’, to download all the products associated to this observation_id and lower processing levels. Requesting more accurate levels than the one associated to the observation_id is not allowed (as level 3 observations are composite products based on level 2 products). To request upper levels, please use get_related_observations functions first. Possible values: ‘ALL’, 3, 2, 1, -1

• product_type (str, optional, default None) – List only products of the given type. If None, all products are listed. Possible values: ‘thumbnail’, ‘preview’, ‘info’, ‘auxiliary’, ‘science’.

Return type:

The list of products (astropy.table).

get_related_observations

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_related_observations",
    params={"observation_id": "<observation_id>"},
)

JwstClass.get_related_observations(observation_id)

In case of processing levels < 3, get the list of level 3 products that make use of a given JWST observation_id. In case of processing level 3, retrieves the list of products used to create this composite observation

Parameters:

observation_id (str, mandatory) – Observation identifier.

Returns:

• A list of strings with the observation_id of the associated

• observations that can be used in get_product_list and

• get_obs_products functions

get_status_messages

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="get_status_messages",
    params={},
)

JwstClass.get_status_messages()

Retrieve the messages to inform users about the status of JWST TAP

gzip_uncompress

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="gzip_uncompress",
    params={"input_file": "<input_file>", "output_file": "<output_file>"},
)

static JwstClass.gzip_uncompress(input_file, output_file)

gzip_uncompress_and_rename_single_file

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="gzip_uncompress_and_rename_single_file",
    params={"input_file": "<input_file>"},
)

static JwstClass.gzip_uncompress_and_rename_single_file(input_file)

is_gz_file

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="is_gz_file",
    params={"filepath": "<filepath>"},
)

static JwstClass.is_gz_file(filepath)

launch_job

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="launch_job",
    params={"query": "<query>"},
)

JwstClass.launch_job(query, *, name=None, output_file=None, output_format='votable', verbose=False, dump_to_file=False, background=False, upload_resource=None, upload_table_name=None, async_job=False)

Launches a synchronous or asynchronous job TAP & TAP+

Parameters:

• query (str, mandatory) – query to be executed

• name (str, optional, default None) – name of the job to be executed

• output_file (str, 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_format (str, optional, default 'votable') – results format. Options are: ‘votable’: str, binary VOTable format ‘csv’: str, comma-separated values format ‘fits’: str, FITS format

• verbose (bool, optional, default 'False') – flag to display information about the process

• dump_to_file (bool, optional, default 'False') – if True, the results are saved in a file instead of using memory

• background (bool, optional, default 'False') – when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available

• upload_resource (str, optional, default None) – resource to be uploaded to UPLOAD_SCHEMA

• upload_table_name (str, required if uploadResource is provided) – Default None resource temporary table name associated to the uploaded resource

• async_job (bool, optional, default 'False') – tag to execute the job in sync or async mode

Return type:

A Job object

list_async_jobs

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="list_async_jobs",
    params={},
)

JwstClass.list_async_jobs(*, verbose=False)

Returns all the asynchronous jobs TAP & TAP+

Parameters:

verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

A list of Job objects

load_async_job

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="load_async_job",
    params={},
)

JwstClass.load_async_job(*, jobid=None, name=None, verbose=False)

Loads an asynchronous job TAP & TAP+

Parameters:

• jobid (str, mandatory if no name is provided, default None) – job identifier

• name (str, mandatory if no jobid is provided, default None) – job name

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

A Job object

load_table

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="load_table",
    params={"table": "<table>"},
)

JwstClass.load_table(table, *, verbose=False)

Loads the specified table TAP+ only

Parameters:

• table (str, mandatory) – full qualified table name (i.e. schema name + table name)

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

A table object

load_tables

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="load_tables",
    params={},
)

JwstClass.load_tables(*, only_names=False, include_shared_tables=False, verbose=False)

Loads all public tables TAP & TAP+

Parameters:

• only_names (bool, TAP+ only, optional, default 'False') – True to load table names only

• include_shared_tables (bool, TAP+, optional, default 'False') – True to include shared tables

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

A list of table objects

login

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="login",
    params={},
)

JwstClass.login(*, user=None, password=None, credentials_file=None, token=None, verbose=False)

Performs a login. TAP+ only User and password can be used or a file that contains user name and password (2 lines: one for user name and the following one for the password)

Parameters:

• user (str, mandatory if 'file' is not provided, default None) – login name

• password (str, mandatory if 'file' is not provided, default None) – user password

• credentials_file (str, mandatory if no 'user' & 'password' are) – provided file containing user and password in two lines

• token (str, optional) – MAST token to have access to propietary data

• verbose (bool, optional, default 'False') – flag to display information about the process

logout

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="logout",
    params={},
)

JwstClass.logout(*, verbose=False)

Performs a logout TAP+ only

Parameters:

verbose (bool, optional, default 'False') – flag to display information about the process

query_region

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="query_region",
    params={"coordinate": "<coordinate>"},
)

JwstClass.query_region(coordinate, *, radius=None, width=None, height=None, observation_id=None, cal_level='Top', prod_type=None, instrument_name=None, filter_name=None, proposal_id=None, only_public=False, show_all_columns=False, async_job=False, verbose=False)

Launches a query region job in sync/async mode TAP & TAP+

Parameters:

• coordinate (astropy.coordinate, mandatory) – coordinates center point

• radius (astropy.units, required if no 'width' nor 'height') – are provided radius (deg)

• width (astropy.units, required if no 'radius' is provided) – box width

• height (astropy.units, required if no 'radius' is provided) – box height

• observation_id (str, optional, default None) – get the observation given by its ID.

• cal_level (object, optional, default 'Top') – get the planes with the given calibration level. Options are: ‘Top’: str, only the planes with the highest calibration level 1,2,3: int, the given calibration level

• prod_type (str, optional, default None) – get the observations providing the given product type. Options are: ‘image’,’cube’,’measurements’,’spectrum’: str, only results of the given product type

• instrument_name (str, optional, default None) – get the observations corresponding to the given instrument name. Options are: ‘NIRISS’, ‘NIRSPEC’, ‘NIRCAM’, ‘MIRI’, ‘FGS’: str, only results of the given instrument

• filter_name (str, optional, default None) – get the observations made with the given filter.

• proposal_id (str, optional, default None) – get the observations from the given proposal ID.

• show_all_columns (bool, optional, default 'False') – flag to show all available columns in the output. Default behaviour is to show the most representative columns only

• only_public (bool, optional, default 'False') – flag to show only metadata corresponding to public observations

• async_job (bool, optional, default 'False') – executes the query (job) in asynchronous/synchronous mode (default synchronous)

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

The job results (astropy.table).

query_target

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="query_target",
    params={"target_name": "<target_name>"},
)

JwstClass.query_target(target_name, *, target_resolver='ALL', radius=None, width=None, height=None, observation_id=None, cal_level='Top', prod_type=None, instrument_name=None, filter_name=None, proposal_id=None, only_public=False, show_all_columns=False, async_job=False, verbose=False)

Searches for a specific target defined by its name and other parameters TAP & TAP+

Parameters:

• target_name (str, mandatory) – name of the target that will be used as center point

• target_resolver (str, optional, default ALL) – resolver used to associate the target name with its coordinates. The ALL option evaluates a “SIMBAD then NED then VIZIER” approach. Options are: ALL, SIMBAD, NED, VIZIER.

• radius (astropy.units, required if no 'width' nor 'height' are) – provided. radius (deg)

• width (astropy.units, required if no 'radius' is provided) – box width

• height (astropy.units, required if no 'radius' is provided) – box height

• observation_id (str, optional, default None) – get the observation given by its ID.

• cal_level (object, optional, default 'Top') – get the planes with the given calibration level. Options are: ‘Top’: str, only the planes with the highest calibration level 1,2,3: int, the given calibration level

• prod_type (str, optional, default None) – get the observations providing the given product type. Options are: ‘image’,’cube’,’measurements’,’spectrum’: str, only results of the given product type

• instrument_name (str, optional, default None) – get the observations corresponding to the given instrument name. Options are: ‘NIRISS’, ‘NIRSPEC’, ‘NIRCAM’, ‘MIRI’, ‘FGS’: str, only results of the given instrument

• filter_name (str, optional, default None) – get the observations made with the given filter.

• proposal_id (str, optional, default None) – get the observations from the given proposal ID.

• only_public (bool, optional, default 'False') – flag to show only metadata corresponding to public observations

• show_all_columns (bool, optional, default 'False') – flag to show all available columns in the output. Default behaviour is to show the most representative columns only

• async_job (bool, optional, default 'False') – executes the query (job) in asynchronous/synchronous mode (default synchronous)

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

The job results (astropy.table).

remove_jobs

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="remove_jobs",
    params={"jobs_list": "<jobs_list>"},
)

JwstClass.remove_jobs(jobs_list, *, verbose=False)

Removes the specified jobs TAP+

Parameters:

• jobs_list (str, mandatory) – jobs identifiers to be removed

• verbose (bool, optional, default 'False') – flag to display information about the process

reset_cache_location

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="reset_cache_location",
    params={},
)

JwstClass.reset_cache_location()

Resets the cache location to the default astropy cache

resolve_target_coordinates

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="resolve_target_coordinates",
    params={"target_name": "<target_name>", "target_resolver": "<target_resolver>"},
)

JwstClass.resolve_target_coordinates(target_name, target_resolver)

save_results

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="save_results",
    params={"job": "<job>"},
)

JwstClass.save_results(job, *, verbose=False)

Saves job results TAP & TAP+

Parameters:

• job (Job, mandatory) – job

• verbose (bool, optional, default 'False') – flag to display information about the process

search_async_jobs

Call via MCP

astroquery_execute(
    module_name="esa_jwst",
    function_name="search_async_jobs",
    params={},
)

JwstClass.search_async_jobs(*, jobfilter=None, verbose=False)

Searches for jobs applying the specified filter TAP+ only

Parameters:

• jobfilter (JobFilter, optional, default None) – job filter

• verbose (bool, optional, default 'False') – flag to display information about the process

Return type:

A list of Job objects