mne.chpi.extract_chpi_locs_kit

mne.chpi.extract_chpi_locs_kit(raw, stim_channel='MISC 064', *, verbose=None)[source]

Extract cHPI locations from KIT data.

Parameters
rawinstance of RawKIT

Raw data with KIT cHPI information.

stim_channelstr

The stimulus channel that encodes HPI measurement intervals.

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
chpi_locsdict

The time-varying cHPI coils locations, with entries “times”, “rrs”, “moments”, and “gofs”.

Notes

New in version 0.23.