pygsti.report.pauliprod_hamiltonian_boxplot

pygsti.report.pauliprod_hamiltonian_boxplot(gate, targetGate, size=None, title=None, save_to=None, fontSize=15, mxBasis='gm', boxLabels=False, prec='compacthp')

Creates a color box plot showing the projection of the error generator of gateMatrix onto each of the Pauli or Pauli-product Hamiltonian generators.

Parameters:
  • gate (ndarray) – The gate matrix data used when constructing the generator.
  • targetGate (ndarray) – The target gate matrix data to use when constructing the the generator.
  • size (tuple, optional) – The (width,height) figure size in inches. None enables automatic calculation based on gateMatrix size.
  • title (str, optional) – A title for the plot.
  • save_to (str, optional) – save figure as this filename (usually ending in .pdf)
  • fontSize (int, optional) – size of font for title
  • mxBasis ({‘std’, ‘gm’,’pp’}, optional) – Which basis the gateset is represented in. Allowed options are Matrix-unit (std), Gell-Mann (gm) and Pauli-product (pp).
  • boxLabels (bool, optional) – Whether box labels are displayed. If False, then a colorbar is displayed to the right of the box plot.
  • prec (int or {‘compact’,’compacthp’}, optional) –

    Precision for box labels. Only relevant when boxLabels == True. 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
Returns:

Return type:

ReportFigure