dace_query.catalog package

Submodules

dace_query.catalog.catalog module

dace_query.catalog.catalog.Catalog: CatalogClass = <dace_query.catalog.catalog.CatalogClass object>

Catalog instance

class dace_query.catalog.catalog.CatalogClass(dace_instance: DaceClass | None = None)

Bases: object

The catalog clas. Use to retrieve data from the catalog module.

A catalog instance is already provided, to use it:

>>> from dace_query.catalog import Catalog
query_database(catalog: str, limit: int | None = 10000, filters: dict | None = None, sort: dict | None = None, output_format: str | None = None) → dict[str, ndarray] | DataFrame | Table | dict

Query the catalog 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).

Names of available catalogs are : [ ‘tess’, ‘k2’, ‘toi’, ‘714’, ‘703’, ‘gaiataskforce’, ‘koi’, ‘cascades’ ].

Parameters:

  • catalog (str) – The catalog name to retrieve

  • 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 (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

>>> from dace_query.catalog import Catalog
>>> catalog_to_search = 'k2'
>>> values = Catalog.query_database(catalog=catalog_to_search)

Module contents