pygsti.report.small_eigval_err_rate_boxplot¶
-
pygsti.report.
small_eigval_err_rate_boxplot
(xvals, yvals, xy_gatestring_dict, dataset, directGSTgatesets, xlabel='', ylabel='', m=None, M=None, scale=1.0, prec=-1, title='Error rate, extrap. from small eigenvalue of Direct GST estimate', boxLabels=True, histogram=False, histBins=50, save_to=None, ticSize=14)¶ Create a color box plot of per-gate error rates.
Parameters: - yvals (xvals,) – List of x and y values. Elements can be any hashable quantity, and will be converted into x and y tic labels. Tuples of strings are converted specially for nice latex rendering of gate strings.
- xy_gatestring_dict (dict) – Dictionary with keys == (x_value,y_value) tuples and values == gate strings, where a gate string can either be a GateString object or a tuple of gate labels. Provides the mapping between x,y pairs and gate strings. None values are allowed, and indicate that there is not data for that x,y pair and nothing should be plotted.
- dataset (DataSet) – The data used to specify frequencies and counts
- directGSTgatesets (dict) – Dictionary with keys == gate strings and values == GateSets linking a gate string to correponding direct-GST gate set.
- ylabel (xlabel,) – X and Y axis labels
- M (m,) – Min and max values of the color scale.
- scale (float, optional) – Scaling factor to adjust the size of the final figure.
- prec (int, optional) – Precision for box labels. Allowed values are: ‘compact’ = round to nearest whole number using at most 3 characters ‘compacthp’ = show as much precision as possible using at most 3 characters int >= 0 = fixed precision given by int int < 0 = number of significant figures given by -int
- title (string, optional) – Plot title (latex can be used)
- boxLabels (bool, optional) – Whether box labels are displayed. It takes much longer to generate the figure when this is set to True.
- histogram (bool, optional) – Whether a histogram of the matrix element values or summed matrix values (depending on sumUp) should also be computed and displayed.
- histBins (int, optional) – The number of bins to use in the histogram.
- save_to (str, optional) – save figure to this filename (usually ending in .pdf)
- ticSize (int, optional) – size of tic marks
Returns: rptFig – The encapsulated matplotlib figure that was generated. Extra figure info is a dict with keys:
- nUsedXs : int
The number of used X-values, proportional to the overall final figure width
- nUsedYs : int
The number of used Y-values, proportional to the overall final figure height
Return type: ReportFigure