Archive XMM Newton

ESA XMM-Newton Science Archive.

• Module name: xmm_newton
• Python class: astroquery.esa.xmm_newton.XMMNewton
• Functions: 11

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.
download_data	Download data from XMM-Newton
get_columns	Get the available columns for a table in XSA TAP service
get_epic_images	Extracts the EPIC images from a given TAR file
get_epic_lightcurve	Extracts the EPIC sources light curve products from a given TAR file
get_epic_metadata	Downloads the European Photon Imaging Camera (EPIC)
get_epic_spectra	Extracts in path (when set) the EPIC sources spectral products from a
get_postcard	Download postcards from XSA
get_tables	Get the available table in XSA TAP service
query_xsa_tap	Launches a synchronous job to query the XSA tap
reset_cache_location	Resets the cache location to the default astropy cache

Functions

clear_cache

Removes all cache files.

XMMNewton.clear_cache()

Call via MCP

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

Parameters

No parameters.

download_data

Download data from XMM-Newton

XMMNewton.download_data(observation_id, *, filename=None, verbose=False, cache=True, prop=False, credentials_file=None, **kwargs)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="download_data",
    params={"observation_id": "<observation_id>"},
)

Parameters

Parameter	Type	Default	Description
observation_id (required)	string		id of the observation to be downloaded, mandatory The identifier of the observation we want to retrieve, 10 digits example: 0144090201
filename	string	None	file name to be used to store the file
verbose	bool	False	optional, default 'False' flag to display information about the process
cache	bool	True	Defaults to True. If set overrides global caching behavior. See astroquery_cache.
prop	boolean	False	optional, default 'False' flag to download proprietary data, the method will then ask the user to input their username and password either manually or using the credentials_file
credentials_file	string	None	optional, default None path to where the users config.ini file is stored with their username and password
**kwargs

Returns

None if not verbose. It downloads the observation indicated —

get_columns

Get the available columns for a table in XSA TAP service

XMMNewton.get_columns(table_name, *, only_names=True, verbose=False)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_columns",
    params={"table_name": "<table_name>"},
)

Parameters

Parameter	Type	Default	Description
table_name (required)	string, mandatory, default None		table name of which, columns will be returned
only_names	bool, TAP+ only, optional, default 'True'	True	True to load table names only
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A list of columns —

get_epic_images

Extracts the EPIC images from a given TAR file

XMMNewton.get_epic_images(filename, band=[], instrument=[], get_detmask=False, get_exposure_map=False, path='', **kwargs)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_epic_images",
    params={"filename": "<filename>"},
)

This function extracts the EPIC images in a given band (or bands) and instrument (or instruments) from it

The result is a dictionary containing the paths to the extracted EPIC images with keys being the band and the instrument

If the band or the instrument are not specified this function will return all the available bands and instruments

Additionally, get_detmask and get_exposure_map can be set to True. If so, this function will also extract the exposure maps and detector masks within the specified bands and instruments

Parameters

Parameter	Type	Default	Description
filename (required)	string, mandatory		The name of the tarfile to be proccessed
band	array of integers, optional, default []	[]	An array of intergers indicating the desired bands
instrument		[]
get_detmask	bool	False	If True, also extracts the detector masks
get_exposure_map	bool	False	If True, also extracts the exposure maps
path	string	''	If set, extracts the EPIC images in the indicated path
**kwargs

Returns

A dictionary of dictionaries with the full paths of the extracted —

Notes

The structure and the content of the extracted compressed FITS files are described in details in the Pipeline Products Description XMM-SOC-GEN-ICD-0024.

get_epic_lightcurve

Extracts the EPIC sources light curve products from a given TAR file

XMMNewton.get_epic_lightcurve(filename, source_number, *, instrument=[], path='')

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_epic_lightcurve",
    params={"filename": "<filename>", "source_number": "<source_number>"},
)

For a given TAR file obtained with XMMNewton.download_data.

This function extracts the EPIC sources light curve products in a given instrument (or instruments) from said TAR file

The result is a dictionary containing the paths to the extracted EPIC sources light curve products with the key being the instrument

If the instrument is not specified, this function will return all available instruments

Parameters

Parameter	Type	Default	Description
filename (required)	string, mandatory		The name of the tarfile to be proccessed
source_number (required)	integer, mandatory		The source number, in decimal, in the observation
instrument		[]
path	string	''	If set, extracts the EPIC images in the indicated path

Returns

A dictionary with the full paths of the extracted EPIC sources —

Notes

The filenames will contain the source number in hexadecimal, as this is the convention used by the pipeline.

The structure and the content of the extracted compressed FITS files are described in details in the Pipeline Products Description XMM-SOC-GEN-ICD-0024.

get_epic_metadata

Downloads the European Photon Imaging Camera (EPIC)

XMMNewton.get_epic_metadata(*, target_name=None, coordinates=None, radius=None)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_epic_metadata",
    params={},
)

metadata from a given target

Parameters

Parameter	Type	Default	Description
target_name	string, optional, default None	None	The name of the target
coordinates	SkyCoord, optinal, default None	None	The coordinates of the target in a SkyCoord object
radius	float, optional, default None	None	The radius to query the target in degrees

Returns

``Table objects — Tables containing the metadata of the target

get_epic_spectra

Extracts in path (when set) the EPIC sources spectral products from a

XMMNewton.get_epic_spectra(filename, source_number, *, instrument=[], path='', verbose=False)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_epic_spectra",
    params={"filename": "<filename>", "source_number": "<source_number>"},
)

given TAR file.

This function extracts the EPIC sources spectral products in a given instrument (or instruments) from it The result is a dictionary containing the paths to the extracted EPIC sources spectral products with key being the instrument If the instrument is not specified this function will return all the available instruments

Parameters

Parameter	Type	Default	Description
filename (required)	string, mandatory		The name of the tarfile to be processed
source_number (required)	integer, mandatory		The source number, in decimal, in the observation
instrument		[]
path	string	''	If set, extracts the EPIC images in the indicated path
verbose	bool	False	optional, default 'False' flag to display information about the process

Returns

A dictionary with the full paths of the extracted EPIC sources —

Notes

The filenames will contain the source number in hexadecimal, as this is the convention used by the pipeline. The structure and the content of the extracted compressed FITS files are described in details in the Pipeline Products Description [XMM-SOC-GEN-ICD-0024] (https://xmm-tools.cosmos.esa.int/external/xmm_obs_info/odf/data/docs/XMM-SOC-GEN-ICD-0024.pdf).

The RMF to be used for the spectral analysis should be generated with the same PPS version as the spectrum, background and ARF. The PPS version can be found in SASVERS keyword in the SPECTRUM file, characters [-6:-3]. Once the sas version is determined, the code should look for the proper version of RMF in the FTP tree. However, for the current PPS versions available in the archive, i.e v18.0, v19.0, v20.0 and v21.0, all RMF matrices are equal among the versions and for all instruments, so it is possible to download the last one, v21.0, available in the root FTP stored in 'rmf_ftp'. In the future, the FTP tree and/or PPS keywords will be modified to make it easier to download the appropriate RMF file for each spectrum.

get_postcard

Download postcards from XSA

XMMNewton.get_postcard(observation_id, *, image_type='OBS_EPIC', filename=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_postcard",
    params={"observation_id": "<observation_id>"},
)

Parameters

Parameter	Type	Default	Description
observation_id (required)	string		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.
image_type	string	'OBS_EPIC'	image type, optional, default 'OBS_EPIC' The image_type to be returned. It can be: OBS_EPIC, OBS_RGS_FLUXED, OBS_RGS_FLUXED_2, OBS_RGS_FLUXED_3, OBS_EPIC_MT, OBS_RGS_FLUXED_MT, OBS_OM_V, OBS_OM_B, OBS_OM_U, OBS_OM_L, OBS_OM_M, OBS_OM_S, OBS_OM_W
filename	string	None	file name to be used to store the postcard, optional, default None
verbose	bool	False	optional, default 'False' Flag to display information about the process

Returns

None. It downloads the observation postcard indicated —

get_tables

Get the available table in XSA TAP service

XMMNewton.get_tables(*, only_names=True, verbose=False)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="get_tables",
    params={},
)

Parameters

Parameter	Type	Default	Description
only_names	bool, TAP+ only, optional, default 'True'	True	True to load table names only
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A list of tables —

query_xsa_tap

Launches a synchronous job to query the XSA tap

XMMNewton.query_xsa_tap(query, *, output_file=None, output_format='votable', verbose=False)

Call via MCP

astroquery_execute(
    module_name="xmm_newton",
    function_name="query_xsa_tap",
    params={"query": "<query>"},
)

Parameters

Parameter	Type	Default	Description
query (required)	str, mandatory		query (adql) to be executed
output_file	str, optional, default None	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'	'votable'	possible values 'votable' or 'csv'
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A table object —

reset_cache_location

Resets the cache location to the default astropy cache

XMMNewton.reset_cache_location()

Call via MCP

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

Parameters

No parameters.