mne_denoise.asr.GuidedASR#

class mne_denoise.asr.GuidedASR(sfreq: float | None = None, cutoff: float = 20.0, window_length: float = 0.5, window_overlap: float = 0.66, max_dropout_fraction: float = 0.1, min_clean_fraction: float = 0.25, picks: str | list[str] | list[int] | None = 'eeg', calibration: str = 'auto', calibration_window_length: float = 1.0, calibration_window_overlap: float = 0.66, ref_max_bad_channels: float = 0.075, ref_tolerances: tuple[float, float] = (-inf, 5.5), blocksize: int = 10, max_dims: float | int = 0.66, reject_by_annotation: bool = True, skip_by_annotation: tuple[str, ...] = ('bad', 'bad_acq_skip'), cov_estimator: str = 'geometric_median', regularization: float = 1e-08, filter_kind: str = 'asr', window_criterion: float | int | None = None, window_criterion_tolerances: tuple[float, float] = (-inf, 7.0), lookahead: float | None = None, stepsize: int | None = None, max_mem_mb: int | None = 512, copy: bool = True, store_reconstruction_matrices: bool = False, artifact_biases: list | tuple | None = None, preserve_biases: list | tuple | None = None, reconstruction: str = 'soft', guidance_strength: float = 1.0, experimental: bool = False, random_state: int | None = None, n_jobs: int | None = None, verbose: bool | str | int | None = None)[source]#

Guided soft-reconstruction variant of ASR.

GuidedASR uses artifact and preserve bias covariances to modify ASR component weights. Soft reconstruction requires experimental=True.

Parameters:

sfreqfloat or None, default=None: Sampling frequency in Hz; inferred from MNE metadata when available.
cutofffloat, default=20.0: ASR threshold multiplier.
window_lengthfloat, default=0.5: Processing window length in seconds.
window_overlapfloat, default=0.66: Processing-window overlap.
max_dropout_fractionfloat, default=0.1: Fraction of low-RMS values excluded from threshold estimation.
min_clean_fractionfloat, default=0.25: Minimum central fraction used for clean RMS statistics.
picksstr, list of str, list of int, or None, default=”eeg”: MNE channels to process; NumPy input uses all rows.
calibration{“auto”, “manual”}, default=”auto”: Calibration mode.
calibration_window_lengthfloat, default=1.0: Automatic calibration-window length in seconds.
calibration_window_overlapfloat, default=0.66: Automatic calibration-window overlap.
ref_max_bad_channelsfloat, default=0.075: Maximum bad-channel fraction in a calibration window.
ref_tolerancestuple of float, default=(-np.inf, 5.5): Robust z-score bounds for calibration-window selection.
blocksizeint, default=10: Samples per calibration covariance block.
max_dimsfloat or int, default=0.66: Maximum fraction or number of reconstructed dimensions.
reject_by_annotationbool, default=True: Exclude bad annotated samples during calibration.
skip_by_annotationtuple of str, default=(“bad”, “bad_acq_skip”): Annotation prefixes treated as bad.
cov_estimator{“geometric_median”, “mean”, “median”}, default=”geometric_median”: Calibration-covariance aggregation rule.
regularizationfloat, default=1e-8: Relative covariance eigenvalue floor.
filter_kind{“none”, “asr”, “highpass”}, default=”asr”: Filter used for ASR statistics.
window_criterionfloat, int, or None, default=None: Optional final retained-sample criterion.
window_criterion_tolerancestuple of float, default=(-np.inf, 7.0): Robust z-score bounds for the final criterion.
lookaheadfloat or None, default=None: Processing lookahead in seconds.
stepsizeint or None, default=None: Samples between reconstruction updates.
max_mem_mbint or None, default=512: Memory bound for covariance processing.
copybool, default=True: Reserved compatibility parameter; transformations return new outputs.
store_reconstruction_matricesbool, default=False: Store per-window reconstruction matrices in diagnostics.
artifact_biasessequence or None, default=None: DSS bias operators defining artifact-like covariance directions.
preserve_biasessequence or None, default=None: DSS bias operators defining directions to preserve.
reconstruction{“soft”, “hard”}, default=”soft”: Guided continuous weights or binary ASR reconstruction.
guidance_strengthfloat, default=1.0: Guidance contribution in [0, 1].
experimentalbool, default=False: Must be true for soft reconstruction.
random_stateint or None, default=None: Reserved for stochastic calibration.
n_jobsint or None, default=None: Reserved for future parallel processing.
verbosebool, str, int, or None, default=None: Logging level.