mne.
get_chpi_positions
(raw, t_step=None, return_quat=False, verbose=None)¶Extract head positions
Note that the raw instance must have CHPI channels recorded.
Parameters: | raw : instance of Raw | str
t_step : float | None
return_quat : bool
verbose : bool, str, int, or None
|
---|---|
Returns: | translation : ndarray, shape (N, 3)
rotation : ndarray, shape (N, 3, 3)
t : ndarray, shape (N,)
quat : ndarray, shape (N, 3)
|
Notes
The digitized HPI head frame y is related to the frame position X as:
Y = np.dot(rotation, X) + translation
Note that if a Maxfilter log file is being processed, the start time may not use the same reference point as the rest of mne-python (i.e., it could be referenced relative to raw.first_samp or something else).