mne_denoise.progress.ProgressEvent

class mne_denoise.progress.ProgressEvent(method: str, stage: str, current: int | None = None, total: int | None = None, component: int | None = None, metric: float | None = None)

Immutable description of one completed progress unit.

Parameters:

methodstr

Algorithm identifier. The value is an open string.

stagestr

Semantic phase identifier. The value is an open string.

currentint or None, default=None

Completed-unit count, normally 1-based.

totalint or None, default=None

Planned unit count when known.

componentint or None, default=None

Optional 1-based component index.

metricfloat or None, default=None

Optional method- and stage-specific diagnostic.

Notes

Events are emitted after work and its metric complete. Callback return values are ignored; callback exceptions propagate unchanged.