ewoksdata.data.bliss.iter_bliss_data#

ewoksdata.data.bliss.iter_bliss_data(filename, scan_nr, subscan=None, scan_key=None, lima_names=None, counter_names=None, start_index=None, retry_timeout=None, retry_period=None, buffer_in_memory=True, **options)[source]#

Iterate over a Bliss scan and also return the scan-point index.

Parameters:

  • filename (str) – Bliss dataset filename.

  • scan_nr (Integral) – Scan number inside the dataset.

  • subscan (Optional[Integral]) – Sub-scan number (e.g. 10.2 -> scan_nr=10 and subscan=2).

  • scan_key (Optional[str]) – Identifier of a scan for blissdata. Iterate scan data from blissdata-cache.

  • lima_names (Optional[List[str]]) – List of LIMA detector names.

  • counter_names (Optional[List[str]]) – List of non-LIMA counter names.

  • start_index (Optional[int]) – First point to yield (default 0 -> all points).

  • retry_timeout (Optional[float]) – Timeout for the retry mechanism.

  • retry_period (Optional[float]) – Interval between retries.

  • buffer_in_memory (bool) – Blissdata buffering in memory. Only applies when scan_key is provided. Use only when you have enough memory or the data processing can keep up with the scan.

  • **hdf5_options –

    Additional options forwarded to blissdata.h5api.dynamic_hdf5.File.

  • options (Any)

Yields:

(point_index, data_dict) where point_index is the zero-based scan-point number and data_dict maps detector names to values.

Return type:

Iterator[Tuple[int, Dict[str, Any]]]