dace_query.lossy package

Submodules

dace_query.lossy.lossy module

dace_query.lossy.lossy.Lossy: LossyClass = <dace_query.lossy.lossy.LossyClass object>

Lossy instance

class dace_query.lossy.lossy.LossyClass(dace_instance: DaceClass | None = None)

Bases: object

The lossy class. Use to retrieve data from the lossy module.

A lossy instance is already provided, to use it :

>>> from dace_query.lossy import Lossy
get_sample(sample_id: str, output_format: str | None = None) → dict[str, ndarray] | DataFrame | Table | dict

Get the data for a specific sample.

Parameters:

  • sample_id (str) – The sample to retrieve data from.

  • output_format (dict[str, ndarray] or DataFrame or Table or dict) – 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.lossy import Lossy
>>> sample_id_to_retrieve = 'SAMPLE_Ice_LN2_11_20140221_000'
>>> values = Lossy.get_sample(sample_id=sample_id_to_retrieve)
query_database(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 lossy 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]) – 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.lossy import Lossy
>>> values = Lossy.query_database()

Module contents