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 orNone
. If'raise'
, an exception will be raised.- verbose
bool
|str
|int
|None
Control verbosity of the logging output. If
None
, use the default verbosity level. See the logging documentation andmne.verbose()
for details. Should only be passed as a keyword argument.
- rawinstance of
- Returns:
- n_active
array
, shape (n_times) The number of active cHPIs for every timepoint in raw.
- n_active
Notes
New in version 1.2.
Examples using mne.chpi.get_active_chpi
#
Signal-space separation (SSS) and Maxwell filtering
Signal-space separation (SSS) and Maxwell filtering