treble_tsdk.collections.collection_library

Classes

CollectionsLibrary

class treble_tsdk.collections.collection_library.CollectionsLibrary

__init__(client: TSDKClient)

ir_collection(simulations: list[Simulation]) → IRCollection

ir_collection_from_df(df: polars.DataFrame) → IRCollection

ir_collection_from_file(file_path: str | Path) → IRCollection

Create an IRCollection from a file.

Reads the file into a Polars DataFrame and creates an IRCollection from it. The file must contain at least the required columns for an IRCollection (id, source_id, receiver_id, simulation_id, simulation_type).

Parameters:

file_path – Path to the file. Supported formats: .parquet, .csv, .ndjson, .json, .ipc, .arrow.

Returns IRCollection:

An IRCollection created from the file data.

ir_data_loader(work_dir: str | None = None, behaviour: IRDataLoaderBehaviour = IRDataLoaderBehaviour.lazy)

scene_collection_from_df(df: polars.DataFrame) → SceneCollection

simulation_collection(simulations: list[Simulation] = []) → SimulationCollection

simulation_collection_from_df(df: polars.DataFrame) → SimulationCollection

simulation_collection_from_file(file_path: str | Path) → SimulationCollection

Create a SimulationCollection from a file.

Reads the file into a Polars DataFrame and creates a SimulationCollection from it. The file must contain at least the required columns for a SimulationCollection (id).

Parameters:

file_path – Path to the file. Supported formats: .parquet, .csv, .ndjson, .json, .ipc, .arrow.

Returns SimulationCollection:

A SimulationCollection created from the file data.