est.core.split.split_bliss_scan#
- est.core.split.split_bliss_scan(filename: str, scan_number: int, monotonic_channel: str, out_filename: str, subscan_size: int | None = None, trim_n_points: int | None = None, wait_finished: bool = True, counter_group: str | None = None, **retry_args) List[str][source]#
Split a Bliss scan in subscans as determined by a channel which is monotonically increasing or descreasing in each subscan or determined by subscan size.
- Parameters:
filename – HDF5 file name containing the Bliss scan.
scan_number – The Bliss scan number.
monotonic_channel – HDF5 path relative to the scan group.
out_filename – HDF5 file name to save subscans as a result of splitting the Bliss scan.
subscan_size – Fix length subscan size.
trim_n_points – Trim N points from the start and end of each subscan.
wait_finished – Wait for the Bliss scan to be complete in HDF5.
counter_group – Group with counters to determine the number of scan points.
retry_timeout – Timeout of waiting for the Bliss scan to be complete in HDF5.
retry_period – Check period of waiting for the Bliss scan to be complete in HDF5.
- Returns:
HDF5 URL’s of the subscans as a result of splitting the Bliss scan.