Dipole class for sequential dipole fits. .. note:: This class should usually not be instantiated directly via ``mne.Dipole(...)``. Instead, use one of the functions listed in the See Also section below. Used to store positions, orientations, amplitudes, times, goodn
| 58 | |
| 59 | @fill_doc |
| 60 | class Dipole(TimeMixin): |
| 61 | """Dipole class for sequential dipole fits. |
| 62 | |
| 63 | .. note:: |
| 64 | This class should usually not be instantiated directly via |
| 65 | ``mne.Dipole(...)``. Instead, use one of the functions |
| 66 | listed in the See Also section below. |
| 67 | |
| 68 | Used to store positions, orientations, amplitudes, times, goodness of fit |
| 69 | of dipoles, typically obtained with Neuromag/xfit, mne_dipole_fit |
| 70 | or certain inverse solvers. Note that dipole position vectors are given in |
| 71 | the head coordinate frame. |
| 72 | |
| 73 | Parameters |
| 74 | ---------- |
| 75 | times : array, shape (n_dipoles,) |
| 76 | The time instants at which each dipole was fitted (s). |
| 77 | pos : array, shape (n_dipoles, 3) |
| 78 | The dipoles positions (m) in head coordinates. |
| 79 | amplitude : array, shape (n_dipoles,) |
| 80 | The amplitude of the dipoles (Am). |
| 81 | ori : array, shape (n_dipoles, 3) |
| 82 | The dipole orientations (normalized to unit length). |
| 83 | gof : array, shape (n_dipoles,) |
| 84 | The goodness of fit. |
| 85 | name : str | None |
| 86 | Name of the dipole. |
| 87 | conf : dict |
| 88 | Confidence limits in dipole orientation for "vol" in m^3 (volume), |
| 89 | "depth" in m (along the depth axis), "long" in m (longitudinal axis), |
| 90 | "trans" in m (transverse axis), "qlong" in Am, and "qtrans" in Am |
| 91 | (currents). The current confidence limit in the depth direction is |
| 92 | assumed to be zero (although it can be non-zero when a BEM is used). |
| 93 | |
| 94 | .. versionadded:: 0.15 |
| 95 | khi2 : array, shape (n_dipoles,) |
| 96 | The χ^2 values for the fits. |
| 97 | |
| 98 | .. versionadded:: 0.15 |
| 99 | nfree : array, shape (n_dipoles,) |
| 100 | The number of free parameters for each fit. |
| 101 | |
| 102 | .. versionadded:: 0.15 |
| 103 | %(verbose)s |
| 104 | |
| 105 | See Also |
| 106 | -------- |
| 107 | fit_dipole |
| 108 | DipoleFixed |
| 109 | read_dipole |
| 110 | |
| 111 | Notes |
| 112 | ----- |
| 113 | This class is for sequential dipole fits, where the position |
| 114 | changes as a function of time. For fixed dipole fits, where the |
| 115 | position is fixed as a function of time, use :class:`mne.DipoleFixed`. |
| 116 | """ |
| 117 |
no outgoing calls