sunpeek.core_methods.pc_method.plotting.create_pdf_report

sunpeek.core_methods.pc_method.plotting.create_pdf_report(pc_output, settings=None, fig_list=None, filename=None, export_folder=None, add_page_numbers=True, add_page_number_first_page=False, **kwargs)

Create PC method report, with page numbers and metadata.

Parameters:

• pc_output (results.PCMethodOutput) – Main object to hold the data used to create the plots.

• settings (pu.PlotSettings) – Settings used by the various PCPlots methods.

• fig_list (List[matplotlib.figure.Figure]) – List of matplotlib figures used to create If fig_list is None, will create all figures using plot_all().

• filename (str = 'pc_report', optional) – The generated pdf report will be saved under this name, with extension “.pdf”. If None, a default filename is generated, based on the PC settings.

• export_folder (Union[str, Path], optional) – Folder to which the pdf file is saved. If None, a temporary folder is used.

• add_page_numbers (bool, optional) – If True, page numbers are added

• add_page_number_first_page (bool, optional) – If False, first report page (cover page, see plot_cover()) has no page number.

Return type:

Optional[Path]

Notes

• kwargs are passed to individual plot methods of PCPlots class via plot_all().

• square_axis_rangeList

  Axes limits (minimum and maximum), used for x and y axis in plot_square().

• y_ratio_limitsList

  Axes limits (minimum and maximum), used for y axis in plot_time().

• axes_limits_interval_plotsdict

  Maximum y axis limits, used for the subplot axes in plot_intervals(). Must contain keys ‘te_max’, ‘rd_max’, ‘tp_max’, ‘vf_sp_max’.