pygsti.report.Results.create_full_report_pdf¶
-
Results.
create_full_report_pdf
(confidenceLevel=None, filename='auto', title='auto', datasetLabel='auto', suffix='', debugAidsAppendix=False, gaugeOptAppendix=False, pixelPlotAppendix=False, whackamoleAppendix=False, m=0, M=10, tips=False, verbosity=0, comm=None)¶ Create a “full” GST report. This report is the most detailed of any of the GST reports, and includes background and explanation text to help the user interpret the contained results.
Parameters: - confidenceLevel (float, optional) – If not None, then the confidence level (between 0 and 100) used in the computation of confidence regions/intervals. If None, no confidence regions or intervals are computed.
- filename (string, optional) – The output filename where the report file(s) will be saved. Specifying “auto” will use the default directory and base name (specified in set_additional_info) if given, otherwise the file “GSTReport.pdf” will be output to the current directoy.
- title (string, optional) – The title of the report. “auto” uses a default title which specifyies the label of the dataset as well.
- datasetLabel (string, optional) – A label given to the dataset. If set to “auto”, then the label will be the base name of the dataset filename without extension (if given) or “$mathcal{D}$” (if not).
- suffix (string, optional) – A suffix to add to the end of the report filename. Useful when filename is “auto” and you generate different reports using the same dataset.
- debugAidsAppendix (bool, optional) – Whether to include the “debugging aids” appendix. This appendix contains comparisons of GST and Direct-GST and small- eigenvalue error rates among other quantities potentially useful for figuring out why the GST estimate did not fit the data as well as expected.
- gaugeOptAppendix (bool, optional) – Whether to include the “gauge optimization” appendix. This appendix shows the results of gauge optimizing GST’s best estimate gate set in several different ways, and thus shows how various report quantities can vary by a different gauge choice.
- pixelPlotAppendix (bool, optional) – Whether to include the “pixel plots” appendix, which shows the goodness of fit, in the form of color box plots, for the intermediate iterations of the GST algortihm.
- whackamoleAppendix (bool, optional) – Whether to include the “whack-a-mole” appendix, which contains colr box plots showing the effect of reducing (“whacking”) one particular part of the overall goodness of fit box plot.
- M (m,) – Minimum and Maximum values of the color scale used in the report’s color box plots.
- tips (boolean, optional) – If True, additional markup and tooltips are included in the produced PDF which indicate how tables and figures in the report correspond to members of this Results object. These “tips” can be useful if you want to further manipulate the data contained in a table or figure.
- verbosity (int, optional) – How much detail to send to stdout.
- comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator for distributing the computation across multiple processors.
Returns: Return type: None