mne.simulation.add_chpi¶
- mne.simulation.add_chpi(raw, head_pos=None, interp='cos2', n_jobs=1, verbose=None)[source]¶
Add cHPI activations to raw data.
- Parameters
- rawinstance of
Raw
The raw instance to be modified.
- head_pos
None
|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 (frominfo['dev_head_t']
) will be used. If tuple, should have the same format as data returned byhead_pos_to_trans_rot_t
. If array, should be of the form returned bymne.chpi.read_head_pos()
.- interp
str
Either ‘hann’, ‘cos2’ (default), ‘linear’, or ‘zero’, the type of forward-solution interpolation to use between forward solutions at different head positions.
- n_jobs
int
The number of jobs to run in parallel (default 1). Requires the joblib package.
- verbosebool,
str
,int
, orNone
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.
- rawinstance of
- Returns
- rawinstance of
Raw
The instance, modified in place.
- rawinstance of
Notes
New in version 0.18.