5.6.7. AcquisitionModule¶

5.6.7.1.1. Synchronous mode:¶

The working principle in synchronous mode is the following:

1. setup(**kwds): kwds can be used to specify new attribute values (otherwise, the current values are used)

2. (optional) curve_ready(): returns True if the acquisition is finished, False otherwise.

3. curve(timeout=None): returns a curve (numpy arrays). The function only returns when the acquisition is done, or a timeout occurs. The parameter timeout (only available for scope and specan) has the following meaning:

   timeout>0: timeout value in seconds

   timeout<=0: returns immediately the current buffer without checking for trigger status.

   timeout is None: timeout is auto-set to twice the normal curve duration

No support for averaging, or saving of curves is provided in synchronous mode

5.6.7.1.2. Asynchronous mode¶

The asynchronous mode is supported by a sub-object “run” of the module. When an asynchronous acquisition is running and the widget is visible, the current averaged data are automatically displayed. Also, the run object provides a function save_curve to store the current averaged curve on the hard-drive.

The full API of the “run” object is the following.

5.6.7.1.3. public methods (All methods return immediately)¶

• single(): performs an asynchronous acquisition of avg curves. The function returns a promise of the result: an object with a ready() function, and a get() function that blocks until data is ready.
• continuous(): continuously acquires curves, and performs a moving average over the avg last ones.
• pause(): stops the current acquisition without restarting the averaging
• stop(): stops the current acquisition and restarts the averaging.
• save_curve(): saves the currently averaged curve (or curves for scope)
• curve(): the currently averaged curve

5.6.7.1.4. Public attributes:¶

• curve_name: name of the curve to create upon saving
• avg: number of averages (not to confuse with averaging per point)
• data_last: array containing the last curve acquired
• data_averaged: array containing the current averaged curve
• current_average: current number of averages

—> I also wonder if we really want to keep the running_state/running_continuous property (will be uniformized) inside the _setup_attribute. Big advantage: no risk of loading a state with a continuous acquisition running without noticing/big disadvantage: slaving/restoring a running module would also stop it...