mne.chpi.get_active_chpi#

mne.chpi.get_active_chpi(raw, *, on_missing='raise', verbose=None)[source]#

Determine how many HPI coils were active for a time point.

Parameters:

rawinstance of Raw: Raw data with cHPI information.
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: 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:

n_activearray, shape (n_times): The number of active cHPIs for every timepoint in raw.

Notes

New in v1.2.

Examples using `mne.chpi.get_active_chpi`#