Evaluation and QA#

Overcorrection#

quantify_overcorrection

Compute source-topography distortion metrics for a spatial operator.

Quality-assurance metrics#

peak_attenuation_db

Compute peak attenuation around a target frequency.

suppression_ratio

Compute the dB ratio of mean band power before and after cleaning.

noise_surround_ratio

Compute target-band power divided by surrounding power.

below_noise_distortion_db

Compute mean absolute log-power distortion outside excluded bands.

spectral_distortion

Compute RMS log-power distortion away from line-noise harmonics.

overclean_proportion

Compute the fraction of channels whose surrounding floor is over-suppressed.

underclean_proportion

Compute the fraction of channels with a residual target peak.

geometric_mean_psd_ratio

Compute the geometric mean of psd_after / psd_before over a frequency range.

variance_removed

Compute percentage of total variance removed.

compute_all_qa_metrics

Compute the package QA summary for two MNE Raw objects.

rms_change

Compute the RMS of data_before - data_after.

max_abs_change

Compute the largest absolute sample-wise change.

channel_variance_ratio

Compute after/before variance for each channel.