pygsti.report.polar_eigenval_plot

pygsti.report.polar_eigenval_plot(gate, targetGate, size=(4, 4), title=None, save_to=None, fontSize=20, showNormal=True, showRelative=True)

Creates a color box plot of a the error generator of a gate matrix.

The error generator is given by log( inv(targetMatrix) * gateMatrix ). This can be a useful way to display large matrices which have so many entries that their entries cannot easily fit within the width of a page.

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.
  • 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
  • showNormal (bool, optional) – whether to display the actual eigenvalues of the gate and the target gate on the plot.
  • showRelative (bool, optional) – whether to display the relative eigenvalues of the gate relative to the target gate on the plot.
Returns:

Return type:

ReportFigure