PlatoClass#

class astroquery.esa.plato.PlatoClass(*, auth_session=None, tap_url=None)[source]#

Bases: EsaTap

This module connects with ESA Plato TAP

Set the session, alternative TAP url, initial parameter for the TAP connection

Parameters:

auth_sessionpyvo.auth.authsession.AuthSession, optional, default None: Authentication session to manage login
tap_urlstr, optional, default None: In case an alternative URL for the TAP needs to be defined

Returns:

A list of table objects

Attributes Summary

`ESA_ARCHIVE_NAME`
`LOGIN_URL`
`LOGOUT_URL`
`TAP_URL`

Methods Summary

`plot_plato_results`(x, y, x_label, y_label, ...)	Draw two columns in a 2D plot with/without a third column drawn with a colormap
`search_catalogue`(table_name, *[, ...])	Execute a search in one of the catalogues and associated tables available in PLATO TAP.
`search_pic_contaminant_go`(*[, target_name, ...])	Execute a search for contaminant sources in the PLATO Input Catalogue (PIC).
`search_pic_target_go`(*[, target_name, ...])	Execute a search for sources in the PLATO Input Catalogue (PIC).

Attributes Documentation

ESA_ARCHIVE_NAME: str = 'PLATO'#

LOGIN_URL: str = 'https://pax.esac.esa.int/tap/login'#

LOGOUT_URL: str = 'https://pax.esac.esa.int/tap/logout'#

TAP_URL: str = 'https://pax.esac.esa.int/tap/tap'#

Methods Documentation

plot_plato_results(x, y, x_label, y_label, plot_title, *, z=None, z_label=None, error_x=None, error_y=None, log_scale=False, color='gray', fig=None, ax=None)[source]#

Draw two columns in a 2D plot with/without a third column drawn with a colormap

Parameters:

xarray of numbers, mandatory: values for the X series
yarray of numbers, mandatory: values for the Y series
x_labelstr, mandatory: title of the X axis
y_labelstr, mandatory: title of the Y axis
plot_titlestr, mandatory: title of the plot
zarray of numbers, optional: values to assign a color to each dot
z_labelstr, optional: title of the colormap
error_xarray of numbers, optional: error on the X series
error_yarray of numbers, optional: error on the Y series
log_scaleboolean, optional, default False: Draw X and Y axes using log scale
colorstr, optional, default gray: Color to be used in the 2D plot or a colormap if Z axis is defined
figmatplotlib.figure.Figure, optional: Existing figure to draw on. If None, a new figure is created.
axmatplotlib.axes.Axes, optional: Existing axes to draw on. If None, a new axes object is created.

Returns:

figmatplotlib.figure.Figure: The figure containing the plot.
axmatplotlib.axes.Axes: The axes object used for plotting.

search_catalogue(table_name, *, target_name=None, coordinates=None, radius=<Quantity 1. arcmin>, columns=None, get_metadata=False, output_file=None, **filters)[source]#

Execute a search in one of the catalogues and associated tables available in PLATO TAP.

Parameters:

table_name: str, mandatory: Table name of the catalogue to be searched
target_name: str, optional: Name of the target to be resolved against SIMBAD/NED/VIZIER
coordinates: str or SkyCoord, optional: coordinates of the center in the cone search
radius: float or quantity, optional, default value 14 degrees: radius in degrees (int, float) or quantity of the cone_search
columnsstr or list of str, optional, default None: Columns from the table to be retrieved. They can be checked using get_metadata=True
get_metadatabool, optional, default False: Get the table metadata to verify the columns that can be filtered
output_filestr, optional, default None: file name where the results are saved. If this parameter is not provided, the jobid is used instead
**filtersstr, optional, default None: Filters to be applied to the search. The column name is the keyword and the value is any value accepted by the column datatype. They will be used to generate the SQL filters for the query. Some examples are described below, where the left side is the parameter defined for this method and the right side the SQL filter generated: StarName=’star1’ -> StarName = ‘star1’ StarName=’star*’ -> StarName ILIKE ‘star%’ StarName=’star%’ -> StarName ILIKE ‘star%’ StarName=[‘star1’, ‘star2’] -> StarName = ‘star1’ OR StarName - ‘star2’ ra=(‘>’, 30) -> ra > 30 ra=(20, 30) -> ra >= 20 AND ra <= 30

Returns:

An astropy.table object containing the results of the filters in the PIC target catalogue

search_pic_contaminant_go(*, target_name=None, coordinates=None, radius=<Quantity 1. arcmin>, columns=None, get_metadata=False, output_file=None, **filters)[source]#

Execute a search for contaminant sources in the PLATO Input Catalogue (PIC).

Parameters:

target_name: str, optional: Name of the target to be resolved against SIMBAD/NED/VIZIER
coordinates: str or SkyCoord, optional: coordinates of the center in the cone search
radius: float or quantity, optional, default value 14 degrees: radius in degrees (int, float) or quantity of the cone_search
columnsstr or list of str, optional, default None: Columns from the table to be retrieved. They can be checked using get_metadata=True
get_metadatabool, optional, default False: Get the table metadata to verify the columns that can be filtered
output_filestr, optional, default None: file name where the results are saved. If this parameter is not provided, the jobid is used instead
**filtersstr, optional, default None: Filters to be applied to the search. The column name is the keyword and the value is any value accepted by the column datatype. They will be used to generate the SQL filters for the query. Some examples are described below, where the left side is the parameter defined for this method and the right side the SQL filter generated: StarName=’star1’ -> StarName = ‘star1’ StarName=’star*’ -> StarName ILIKE ‘star%’ StarName=’star%’ -> StarName ILIKE ‘star%’ StarName=[‘star1’, ‘star2’] -> StarName = ‘star1’ OR StarName - ‘star2’ ra=(‘>’, 30) -> ra > 30 ra=(20, 30) -> ra >= 20 AND ra <= 30

Returns:

An astropy.table object containing the results of the filters in the PIC target catalogue

search_pic_target_go(*, target_name=None, coordinates=None, radius=<Quantity 1. arcmin>, columns=None, get_metadata=False, output_file=None, **filters)[source]#

Execute a search for sources in the PLATO Input Catalogue (PIC).

Parameters:

target_name: str, optional: Name of the target to be resolved against SIMBAD/NED/VIZIER
coordinates: str or SkyCoord, optional: coordinates of the center in the cone search
radius: float or quantity, optional, default value 14 degrees: radius in degrees (int, float) or quantity of the cone_search
columnsstr or list of str, optional, default None: Columns from the table to be retrieved. They can be checked using get_metadata=True
get_metadatabool, optional, default False: Get the table metadata to verify the columns that can be filtered
output_filestr, optional, default None: file name where the results are saved. If this parameter is not provided, the jobid is used instead
**filtersstr, optional, default None: Filters to be applied to the search. The column name is the keyword and the value is any value accepted by the column datatype. They will be used to generate the SQL filters for the query. Some examples are described below, where the left side is the parameter defined for this method and the right side the SQL filter generated: StarName=’star1’ -> StarName = ‘star1’ StarName=’star*’ -> StarName ILIKE ‘star%’ StarName=’star%’ -> StarName ILIKE ‘star%’ StarName=[‘star1’, ‘star2’] -> StarName = ‘star1’ OR StarName - ‘star2’ ra=(‘>’, 30) -> ra > 30 ra=(20, 30) -> ra >= 20 AND ra <= 30

Returns:

An astropy.table object containing the results of the filters in the PIC target catalogue