mne.preprocessing.compute_proj_hfc#

mne.preprocessing.compute_proj_hfc(info, order=1, picks='meg', exclude='bads', *, accuracy='accurate', verbose=None)[source]#

Generate projectors to perform homogeneous/harmonic correction to data.

Remove evironmental fields from magentometer data by assuming it is explained as a homogeneous 1 or harmonic field 2. Useful for arrays of OPMs.

Parameters

infomne.Info | None: The mne.Info object with information about the sensors and methods of measurement.
orderint: The order of the spherical harmonic basis set to use. Set to 1 to use only the homogeneous field component (default), 2 to add gradients, 3 to add quadrature terms etc.
picksstr | array_like | slice | None: Channels to include. Default of 'meg' (same as None) will select all non-reference MEG channels. Use ('meg', 'ref_meg') to include reference sensors as well.
excludelist | ‘bads’: List of channels to exclude from HFC, only used when picking based on types (e.g., exclude=”bads” when picks=”meg”). Specify 'bads' (the default) to exclude all channels marked as bad.
accuracystr: Can be "point", "normal" or "accurate" (default), defines which level of coil definition accuracy is used to generate model.
verbosebool | str | int | None: Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns

Examples using `mne.preprocessing.compute_proj_hfc`#