mne.chpi.get_chpi_info

mne.chpi.get_chpi_info(info, on_missing='raise', verbose=None)[source]

Retrieve cHPI information from the data.

Parameters
infomne.Info

The mne.Info object with information about the sensors and methods of measurement.

on_missing‘raise’ | ‘warn’ | ‘ignore’

Can be 'raise' (default) to raise an error, 'warn' to emit a warning, or 'ignore' to ignore when no cHPI information can be found. If 'ignore' or 'warn', all return values will be empty arrays or None. If 'raise', an exception will be raised.

verbosebool | str | int | 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
hpi_freqsarray, shape (n_coils,)

The frequency used for each individual cHPI coil.

hpi_pickint | None

The index of the STIM channel containing information about when which cHPI coils were switched on.

hpi_onarray, shape (n_coils,)

The values coding for the “on” state of each individual cHPI coil.

Notes

New in version 0.24.

Examples using mne.chpi.get_chpi_info