pygsti.report.Results.create_presentation_ppt¶
-
Results.
create_presentation_ppt
(confidenceLevel=None, filename='auto', title='auto', datasetLabel='auto', suffix='', debugAidsAppendix=False, pixelPlotAppendix=False, whackamoleAppendix=False, m=0, M=10, verbosity=0, pptTables=False, comm=None)¶ Create a GST Microsoft Powerpoint presentation.
These slides can contain most (but not all) of the tables and figures from the “full” report but contain only minimal descriptive text. This method uses the python-pptx package to write Powerpoint files. The resulting powerpoint slides are meant to parallel those of the PDF presentation but are not as nice and clean. This method exists because the Powerpoint format is an industry standard and makes it very easy to shamelessly co-opt GST figures or entire slides for incorporation into other presentations.
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 presentation 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 “GSTSlides.pptx” will be output to the current directoy.
- title (string, optional) – The title of the presentation. “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 “D” (if not).
- suffix (string, optional) – A suffix to add to the end of the presentation filename. Useful when filename is “auto” and you generate different presentations 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.
- 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 presentation’s color box plots.
- verbosity (int, optional) – How much detail to send to stdout.
- pptTables (bool, optional) – If True, native powerpoint-format tables are placed in slides instead of creating the prettier-looking PNG images of latex-ed tables (which are used when False). This option can be useful when you want to modify or extract a part of a table.
- comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator for distributing the computation across multiple processors.
Returns: Return type: None