exa.common.sweep.util.convert_sweeps_to_list_of_tuples

convert_sweeps_to_list_of_tuples(sweeps)

Validate sweeps and convert it to format accepted by the station control.

Converts a more convenient sweep definition list to a strict list of tuples of sweeps. The sweep instances themselves are the same, except single sweep instances are turned into a tuple containing a single sweep.

Verify that: * sweeps list element is either Sweep or ParallelSweep * tuple_of_sweep element is a Sweep * tuple of sweeps contains at least one element * length of a data is identical in all tuples of sweeps

Parameters:

sweeps (list[Sweep | tuple[Sweep, ...]]) – More user-friendly definition of a list of sweeps.

Returns:

List of tuples of sweeps.

Raises:

ValueError if sweeps parameter does not follow the contract. –

Return type:

list[tuple[Sweep, …]]