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.

multi_mean_xy_data

multi_mean_xy_data(series, xdata, ydata, sigma=None, shots=None, method='sample')[source]

Take mean of multi series data set. See mean_xy_data().

Deprecated since version 0.6_pending: The function qiskit_experiments.curve_analysis.utils.multi_mean_xy_data() is pending deprecation as of qiskit-experiments 0.6. It will be marked deprecated in a future release, and then removed no earlier than 3 months after the release date. The curve data representation has been replaced by the DataFrame format.

Parameters:

  • series (ndarray) – Series index.

  • xdata (ndarray) – 1D or 2D array of xdata from curve_fit_data or multi_curve_fit_data

  • ydata (ndarray) – array of ydata returned from curve_fit_data or multi_curve_fit_data

  • sigma (ndarray | None) – Optional, array of standard deviations in ydata.

  • shots (ndarray | None) – Optional, array of shots used to get a data point.

  • method (str) – The method to use for computing y means and standard deviations sigma (default: “sample”).

Returns:

Tuple of (series, xdata, ydata, sigma, shots).

Return type:

Tuple[ndarray, ndarray, ndarray, ndarray, ndarray]