EstimatorPubResult

class EstimatorPubResult(data, metadata=None)

Result of Estimator Pub.

Initialize a pub result.

Parameters

data (DataBin) – Result data.
metadata (dict[str, Any] | None) – Metadata specific to this pub. Keys are expected to be strings.

Attributes

Result data for the pub.

Metadata for the pub.

draw_zne_evs(indices=None, names=None, num_stds=1, max_mag=10, max_std=0.2, height=500, width=1000, num_cols=4, colorscale='Aggrnyl')

Plot the zero noise extrapolation data contained in this estimator pub result.

This method generates a subfigure for each expectation value.

Parameters

indices (Sequence[tuple[int, ...]] | None) – The indices of the expectation values to include in the plot. If None, includes all values. See ZneOptions for information on the indexing scheme.
names (Sequence[str] | None) – The names to assign to the expectation values. If None, the names correspond to the indices.
num_stds (int) – The number of standard deviations to include around each fit.
max_mag (float) – The maximum magnitude of expectation values to include. If evs_extrapolated has a greater magnitude than this value, the expectation value is omitted from the plot.
max_std (float) – The maximum standard deviation to include. If stds_extrapolated is greater than this value for an expectation value and extrapolator, the fit is omitted from the plot.
height (int) – The height of the plot in pixels.
width (int) – The width of the plot in pixels.
num_cols (int) – The maximum number of columns in the figure.
colorscale (str) – The colorscale to use.

Returns

A plotly figure.

Return type

PlotlyFigure

draw_zne_extrapolators(indices=None, names=None, num_stds=1, max_mag=10, max_std=0.2, height=500, width=1000, colorscale='Aggrnyl')

Plot the zero noise extrapolation data contained in this estimator pub result.

This method generates a subfigure for each extrapolator.

Parameters

indices (Sequence[tuple[int, ...]] | None) – The indices of the expectation values to include in the plot. If None, includes all values. See ZneOptions for information on the indexing scheme.
names (Sequence[str] | None) – The names to assign to the expectation values. If None, the names correspond to the indices.
num_stds (int) – The number of standard deviations to include around each fit.
max_mag (float) – The maximum magnitude of expectation values to include. If evs_extrapolated has a greater magnitude than this value, the expectation value is omitted from the plot.
max_std (float) – The maximum standard deviation to include. If stds_extrapolated is greater than this value for an expectation value and extrapolator, the fit is omitted from the plot.
height (int) – The height of the plot in pixels.
width (int) – The width of the plot in pixels.
colorscale (str) – The colorscale to use.

Returns

A plotly figure.

Return type

PlotlyFigure

Was this page helpful?

Report a bug, typo, or request content on GitHub.