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.

CurveData

class CurveData(x, y, y_err, shots, data_allocation, labels)

A dataclass that manages the multiple arrays comprising the dataset for fitting.

This dataset can consist of X, Y values from multiple series. To extract curve data of the particular series, get_subset_of() can be used.

x

X-values that experiment sweeps.

y

Y-values that observed and processed by the data processor.

y_err

Uncertainty of the Y-values which is created by the data processor. Usually this assumes standard error.

shots

Number of shots used in the experiment to obtain the Y-values.

data_allocation

List with identical size with other arrays. The value indicates the series index of the corresponding element. This is classified based upon the matching of SeriesDef.filter_kwargs with the circuit metadata of the corresponding data index. If metadata doesn’t match with any series definition, element is filled with -1.

labels

List of curve labels. The list index corresponds to the series index.

Methods

CurveData.get_subset_of(index)

Filter data by series name or index.