meeg_utils.steps.Reference#

class meeg_utils.steps.Reference(eeg='average', *, projection=False, ctf_grade=3)[source]#

Set the EEG reference and, for CTF MEG, the gradient compensation grade.

Parameters:

  • eeg ("average" | list of str | None) – EEG reference: "average" (default, excludes bad channels), a list of reference channels, or None to leave it unchanged.

  • projection (bool) – Add the average reference as a projector instead of applying it.

  • ctf_grade (int | None) – CTF only: synthetic gradiometer compensation grade to apply (default 3). None leaves it unchanged. Ignored for other systems, which have no compensation.

qc_#

eeg_reference and, for CTF data, ctf_grade_before and ctf_grade_after.

Type:

dict

__init__(eeg='average', *, projection=False, ctf_grade=3)[source]#

Methods

__init__([eeg, projection, ctf_grade])

fit(inst[, y, system])

Learn the step's state from the data.

fit_transform(inst[, y, system, copy])

Fit the step on the data and transform the same data.

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

plot([kind, inst])

Draw quality-control figures.

set_fit_request(*[, inst, system])

Configure whether metadata should be requested to be passed to the fit method.

set_params(**params)

Set the parameters of this estimator.

set_transform_request(*[, copy, inst])

Configure whether metadata should be requested to be passed to the transform method.

transform(inst, *[, copy])

Apply the fitted step to the data.

Attributes

accepts

Data types the step accepts.

adds_annotations

Whether the step may add BAD_ annotations (existing ones are kept).

changes_channels

Whether the step may add, drop or reorder channels.

changes_times

Whether the step may change the time axis (e.g. resampling, cropping).

drops_epochs

Whether the step may drop epochs (e.g. artifact rejection).

plot_kinds

kind -> whether it needs data (inst).

returns

Data type the step returns; None means the same type as its input.

systems

Acquisition systems the step applies to; None means all systems.
accepts: ClassVar[tuple[type, ...]] = (<class 'mne.io.base.BaseRaw'>,)#

Data types the step accepts.