mne.chpi.compute_head_pos

mne.chpi.compute_head_pos(info, chpi_locs, dist_limit=0.005, gof_limit=0.98, adjust_dig=False, verbose=None)

Compute time-varying head positions.

Parameters:

infomne.Info

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

chpi_locsdict

The time-varying cHPI coils locations, with entries “times”, “rrs”, “moments”, and “gofs”. Typically obtained by compute_chpi_locs() or extract_chpi_locs_ctf().

dist_limitfloat

Minimum distance (m) to accept for coil position fitting.

gof_limitfloat

Minimum goodness of fit to accept for each coil.

adjust_digbool

If True, adjust the digitization locations used for fitting based on the positions localized at the start of the file.

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:

quatsndarray, shape (n_pos, 10)

The [t, q1, q2, q3, x, y, z, gof, err, v] for each fit.

See also

compute_chpi_locs

extract_chpi_locs_ctf

read_head_pos

write_head_pos

Notes

New in version 0.20.

Examples using mne.chpi.compute_head_pos

Extracting and visualizing subject head movement

Extracting and visualizing subject head movement

Annotate movement artifacts and reestimate dev_head_t

Annotate movement artifacts and reestimate dev_head_t