Skip to content

Utils Qa Summary

Module: spectralbridge.utils.qa_summary.

Compact, restart-safe drone QA dashboard and report assembly.

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_drone_qa_report

render_drone_qa_report(base_dir: str | Path, *, qa_summary: dict[str, Any] | None = None, output_pdf: str | Path | None = None, force: bool = False) -> dict[str, Any]

Render/reuse the final dashboard and PDF using compact QA products only.

Audience: public. Also exported as spectralbridge.utils.build_drone_qa_summary.

build_drone_qa_summary

build_drone_qa_summary(base_dir: Path, output_html: Path | None = None, pattern: str = '*__qa.png', *, qa_summary: dict[str, Any] | None = None, force: bool = False) -> Path

Backward-compatible wrapper returning the final drone QA PDF path.

Parameters:

Name Type Description Default
base_dir Path

Directory containing completed drone QA products to summarize.

required
output_html Path | None

Legacy report destination argument forwarded to the established QA report writer; the wrapper returns its final PDF path.

None
pattern str

Glob selecting legacy per-flight QA PNG products when no structured QA summary is supplied.

'*__qa.png'
qa_summary dict[str, Any] | None

Optional structured drone QA payload; None discovers the established on-disk summary/products.

None
force bool

Regenerate the requested outputs instead of reusing an otherwise valid checkpoint or report.

False

Returns:

Type Description
Path

Final drone QA PDF path produced by the compatibility report wrapper.

See Also

spectralbridge.pipelines.pipeline.process_one_flightline : Related source-derived API contract.