mne_denoise.dss.variants.narrowband_dss#

mne_denoise.dss.variants.narrowband_dss(sfreq: float, freq: float, *, bandwidth: float = 2.0, n_components: int | None = None, **dss_kws) → DSS[source]#

Create a DSS configured for a specific frequency band.

Returns a pre-configured DSS object that extracts components with maximum power in the specified frequency band.

Parameters:

  • sfreq (float) – Sampling frequency in Hz.

  • freq (float) – Target center frequency in Hz.

  • bandwidth (float) – Bandwidth of the bandpass filter in Hz. Default 2.0.

  • n_components (int, optional) – Number of DSS components to keep. If None, keep all.

  • **dss_kws – Additional keyword arguments passed to DSS.

Returns:

dss – A DSS object configured with a BandpassBias.

Return type:

DSS

Examples

>>> # Extract 10 Hz (alpha) components
>>> dss = narrowband_dss(sfreq=250, freq=10)
>>> dss.fit(data)
>>> alpha_sources = dss.transform(data)