TESS#
- dace_query.tess.tess.Tess: TessClass = <dace_query.tess.tess.TessClass object>#
This is a singleton instance of the
TessClassclass.To use it, simply import it :
from dace_query.tess import Tess
- class dace_query.tess.tess.TessClass(dace_instance=None)#
Bases:
objectThe tess class. Use to retrieve data from the tess module.
Tip
A tess instance is already provided, to use it:
from dace_query.tess import Tess
- get_flux(target, flux_type='raw_flux', output_format=None)#
Retrieve tess photometry data for a specified target in the chosen format.
All available formats are defined in this section (see Output formats).
Avalable flux types are [ ‘raw_flux’, ‘corr_flux’ ].
- Parameters:
target (str) – The target to retrieve data from. (usually a TIC or TOI id)
flux_type (Optional[str]) – The flux type to use
output_format (Optional[str]) – Type of data returns
- Returns:
The desired data in the chosen output format
- Return type:
dict[str, ndarray] or DataFrame or Table or dict
Getting flux data for a given target
from dace_query.tess import Tess target_to_search = 'TIC381400181' values = Tess.get_flux(target=target_to_search)
- query_database(limit=10000, filters=None, sort=None, output_format=None)#
Query the tess database to retrieve data in the chosen format.
Filters and sorting order can be applied to the query via named arguments (see Filtering and sorting).
All available formats are defined in this section (see Output formats).
- Parameters:
limit (Optional[int]) – Maximum number of rows to return
filters (Optional[dict]) – Filters to apply to the query
sort (Optional[dict]) – Sort order to apply to the query
output_format (Optional[str]) – The desired data in the chosen output format
- Returns:
A dict containing lists of values for each visit
- Return type:
dict[str, ndarray] or DataFrame or Table or dict
Getting all available observations
from dace_query.tess import Tess values = Tess.query_database()
- query_region(sky_coord, angle, limit=10000, filters=None, output_format=None, catalog=None)#
Query a region, based on SkyCoord and Angle objects, in the tess database and retrieve data in the chosen format.
Filters can be applied to the query via named arguments (see Filtering and sorting).
All available formats are defined in this section (see Output formats).
- Parameters:
sky_coord (SkyCoord) – Sky coordinates object from the astropy module
angle (Angle) – Angle object from the astropy module
limit (Optional[int]) – Maximum number of rows to return
filters (Optional[dict]) – Filters to apply to the query
output_format (Optional[str]) – Type of data returns
catalog (Optional[str]) – Allows to search in a specific catalog instead of the tess observation database (can be
'TIC'or'TOI')
- Returns:
The desired data in the chosen output format
- Return type:
dict[str, ndarray] or DataFrame or Table or dict
Finding observations using a cone search
from dace_query.tess import Tess from astropy.coordinates import SkyCoord, Angle sky, a = SkyCoord('13h50m24s', '-60d21m11s', frame='icrs'), Angle('0.005d') values = Tess.query_region(sky_coord=sky, angle=a)
Finding targets in the TOI catalog using a cone search
from dace_query.tess import Tess from astropy.coordinates import SkyCoord, Angle sky, a = SkyCoord('13h50m24s', '-60d21m11s', frame='icrs'), Angle('0.005d') values = Tess.query_region(sky_coord=sky, angle=a, catalog='TOI')
- query_tic_catalog(limit=10000, filters=None, sort=None, output_format=None)#
Query the Tess Input Catalog (TIC) to retrieve data in the chosen format.
Filters and sorting order can be applied to the query via named arguments (see Filtering and sorting).
All available formats are defined in this section (see Output formats).
- Parameters:
limit (Optional[int]) – Maximum number of rows to return
filters (Optional[dict]) – Filters to apply to the query
sort (Optional[dict]) – Sort order to apply to the query
output_format (Optional[str]) – The desired data in the chosen output format
- Returns:
A dict containing lists of values for each target in the TIC
- Return type:
dict[str, ndarray] or DataFrame or Table or dict
Getting the TIC catalog
from dace_query.tess import Tess values = Tess.query_tic_catalog()
- query_toi_catalog(limit=10000, filters=None, sort=None, output_format=None)#
Query the Tess Object of Interest (TOI) catalog to retrieve data in the chosen format.
Filters and sorting order can be applied to the query via named arguments (see Filtering and sorting).
All available formats are defined in this section (see Output formats).
- Parameters:
limit (Optional[int]) – Maximum number of rows to return
filters (Optional[dict]) – Filters to apply to the query
sort (Optional[dict]) – Sort order to apply to the query
output_format (Optional[str]) – The desired data in the chosen output format
- Returns:
A dict containing lists of values for each target in the TOI catalog
- Return type:
dict[str, ndarray] or DataFrame or Table or dict
Getting the TOI catalog
from dace_query.tess import Tess values = Tess.query_toi_catalog()