mne.chpi.get_chpi_info#
- mne.chpi.get_chpi_info(info, on_missing='raise', verbose=None)[source]#
Retrieve cHPI information from the data.
- Parameters:
- info
mne.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 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.
- info
- Returns:
Notes
New in version 0.24.
Examples using mne.chpi.get_chpi_info
#
Extracting and visualizing subject head movement
Extracting and visualizing subject head movement