treble_tsdk.collections.postprocessing_collection

Functions

apply_filters_to_irs(ir_collection[, ...])

Apply the filters to the IRs within the IR collection.

set_filters_for_irs(ir_collection, filters)

Prescribe a chain of filters for a set of IRs within the IR collection.
treble_tsdk.collections.postprocessing_collection.apply_filters_to_irs(ir_collection: IRCollection, ir_subset: pl.DataFrame = None, work_dir: str = None, behaviour: IRDataLoaderBehaviour = IRDataLoaderBehaviour.eager)

Apply the filters to the IRs within the IR collection.

Parameters:

  • ir_collection (IRCollection) – The IR collection to apply the filters to.

  • ir_subset (pl.DataFrame) – A subset of the IR collection to apply the filters to. Defaults to None, which means all IRs in the collection.

  • work_dir (str) – The work directory to store the processed IRs.

  • behaviour (IRDataLoaderBehaviour) – The behaviour of the IR data loader.

treble_tsdk.collections.postprocessing_collection.set_filters_for_irs(ir_collection: IRCollection, filters: list[FilterDefinition], ir_subset: pl.DataFrame | None = None)

Prescribe a chain of filters for a set of IRs within the IR collection.

Parameters:

  • ir_collection (IRCollection) – The IR collection to set the filters for.

  • filters (list[FilterDefinition]) – A list of filter definitions to apply to the IRs.

  • ir_subset (pl.DataFrame | None) – A subset of the IR collection to set the filters for. Defaults to None, which means all IRs.