Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

ExperimentData.cancel_analysis

ExperimentData.cancel_analysis(ids=None)

Cancel any queued analysis callbacks.

Note

A currently running analysis callback cannot be cancelled.

Parameters:

ids (Union[str, List[str], None]) – Analysis callback(s) to cancel. If None all non-finished analysis will be cancelled.

Return type:

bool

Returns:

True if the specified analysis callbacks were successfully cancelled otherwise false.