write_metric_plot_overview_pdf#

mhm_tools.common.plotter.write_metric_plot_overview_pdf(output_file: Path, plot_files: Sequence[Path], summary_rows: Sequence[Mapping[str, object]], append_pdf_files: Sequence[Path] | None = None, title: str | None = None, dpi: int = 150) → Path[source]#

Write a PDF overview with summary table and plot pages.

Parameters:

  • output_file (str or Path) – PDF file to write.

  • plot_files (Sequence[str or Path]) – Plot image files to include.

  • summary_rows (Sequence[Mapping[str, object]]) – Metric summary rows for the table page.

  • append_pdf_files (Sequence[str or Path], optional) – Existing PDF files appended after the generated overview pages.

  • title (str, optional) – Overview title.

  • dpi (int, optional) – PDF image resolution.

Returns:

Written PDF file.

Return type:

Path