report.h File Reference

HTML report builder — mne-cpp's equivalent of mne.Report for summarising analysis pipelines. More...

#include "utils_global.h"
#include <QString>
#include <QStringList>
#include <QList>
#include <QPair>

Include dependency graph for report.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	UTILSLIB::ReportSection
	A section in the report (title + HTML content). More...
class	UTILSLIB::Report
	Simple HTML report builder for MEG/EEG analysis results. More...

Namespaces
namespace	UTILSLIB
	Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Detailed Description

HTML report builder — mne-cpp's equivalent of mne.Report for summarising analysis pipelines.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2026 MNE-CPP Authors

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

2.2.1

Date

May 2026

UTILSLIB::Report collects titled sections (free text, tables, key-value pairs, preformatted code) and emits a self-contained HTML document that can be opened directly in a browser or attached to an email. The output is dependency- free — inline CSS, no JavaScript — so the file remains readable in restricted enterprise environments where the MEG/EEG processing reports are typically reviewed.

Used by the demo applications in src/applications and by the integration tests in tools/ to produce a one-page summary of each pipeline run (input files, channel counts, forward / inverse parameters, output checksums).

Definition in file report.h.