Bulk Reporting¶
Module: spectralbridge.bulk.reporting.
Publication and summary reporting from compact bulk result products.
API glossary ยท Workflow / scientific context
Signatures and documentation below are collected from the current source. Advanced objects are not newly declared stable by inclusion here.
Audience: advanced.
render_bulk_summary_dashboard ¶
render_bulk_summary_dashboard(overview: dict[str, Any], *, output_stem: str | Path, figure_dpi: int = DEFAULT_QA_STYLE.figure_dpi) -> dict[str, str]
Render a one-page population QA dashboard from machine-readable metrics.
Audience: advanced.
render_bulk_publication_figures ¶
render_bulk_publication_figures(*, weighting: Sequence[dict[str, Any]], pair_summaries: Sequence[dict[str, Any]], flightline: Sequence[dict[str, Any]], site: Sequence[dict[str, Any]], loso: Sequence[dict[str, Any]], output_dir: str | Path, figure_dpi: int = DEFAULT_QA_STYLE.figure_dpi) -> dict[str, dict[str, str]]
Render three manuscript-width figures from compact result tables only.
Audience: advanced.
render_bulk_pdf_report ¶
render_bulk_pdf_report(*, summary_png: str | Path, publication_figures: dict[str, dict[str, str]], diagnostic_figures: Sequence[str], overview: dict[str, Any], flags: Sequence[dict[str, Any]], output_pdf: str | Path) -> Path
Assemble a self-contained PDF from already-computed compact QA outputs.
Explicitly exported constants and type aliases¶
These values describe package metadata, schemas or configuration; they are not observations from a production dataset.
| Name | Source expression |
|---|---|
BULK_PUBLICATION_FIGURE_NAMES |
('translation_performance', 'translation_stability', 'generalization_and_failures') |
BULK_PUBLICATION_PANEL_COUNT |
3 |