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.

DataProcessor.call_with_history¶

DataProcessor.call_with_history(data, history_nodes=None)[source]¶

Call self on the given datum. This method sequentially calls the stored data actions on the datum and also returns the history of the processed data.

Parameters:

data (Union[Dict, List[Dict]]) – The data, typically from ExperimentData.data(...), that needs to be processed. This dict or list of dicts also contains the metadata of each experiment.
history_nodes (Optional[Set]) – The nodes, specified by index in the data processing chain, to include in the history. If None is given then all nodes will be included in the history.

Return type:

Tuple[ndarray, List]

Returns:

A tuple of (processed data, history), that are the data processed by the processor and its intermediate state in each specified node, respectively.