mne.simulation.add_chpi

mne.simulation.add_chpi(raw, head_pos=None, interp='cos2', n_jobs=1, verbose=None)

Add cHPI activations to raw data.

Parameters

rawinstance of Raw

The raw instance to be modified.

head_posNone | str | dict | tuple | array

Name of the position estimates file. Should be in the format of the files produced by MaxFilter. If dict, keys should be the time points and entries should be 4x4 dev_head_t matrices. If None, the original head position (from info['dev_head_t']) will be used. If tuple, should have the same format as data returned by head_pos_to_trans_rot_t. If array, should be of the form returned by mne.chpi.read_head_pos().

interpstr

Either ‘hann’, ‘cos2’ (default), ‘linear’, or ‘zero’, the type of forward-solution interpolation to use between forward solutions at different head positions.

n_jobsint

The number of jobs to run in parallel (default 1). Requires the joblib package.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns

rawinstance of Raw

The instance, modified in place.

Notes

New in version 0.18.

Examples using mne.simulation.add_chpi