vallenae.io.PriDatabase.iread_hits

PriDatabase.iread_hits(*, channel=None, time_start=None, time_stop=None, set_id=None, query_filter=None)[source]

Stream hits with returned iterable.

Parameters:

  • channel (Union[None, int, Sequence[int]]) – None if all channels should be read. Otherwise specify the channel number or a list of channel numbers

  • time_start (Optional[float]) – Start reading at relative time (in seconds). Start at beginning if None

  • time_stop (Optional[float]) – Stop reading at relative time (in seconds). Read until end if None

  • set_id (Union[None, int, Sequence[int]]) – Read by SetID

  • query_filter (Optional[str]) – Optional query filter provided as SQL clause, e.g. “Amp > 5000 AND RiseT < 1000”

Return type:

SizedIterable[HitRecord]

Returns:

Sized iterable to sequential read hits