Forward class to represent info from forward solution. Like :class:`mne.Info`, this data structure behaves like a dictionary. It contains all metadata necessary for a forward solution. .. warning:: This class should not be modified or created by users. Forward objects s
| 86 | |
| 87 | |
| 88 | class Forward(dict): |
| 89 | """Forward class to represent info from forward solution. |
| 90 | |
| 91 | Like :class:`mne.Info`, this data structure behaves like a dictionary. |
| 92 | It contains all metadata necessary for a forward solution. |
| 93 | |
| 94 | .. warning:: |
| 95 | This class should not be modified or created by users. |
| 96 | Forward objects should be obtained using |
| 97 | :func:`mne.make_forward_solution` or :func:`mne.read_forward_solution`. |
| 98 | |
| 99 | Attributes |
| 100 | ---------- |
| 101 | ch_names : list of str |
| 102 | A convenience wrapper accessible as ``fwd.ch_names`` which wraps |
| 103 | ``fwd['info']['ch_names']``. |
| 104 | |
| 105 | See Also |
| 106 | -------- |
| 107 | mne.make_forward_solution |
| 108 | mne.read_forward_solution |
| 109 | |
| 110 | Notes |
| 111 | ----- |
| 112 | Forward data is accessible via string keys using standard |
| 113 | :class:`python:dict` access (e.g., ``fwd['nsource'] == 4096``): |
| 114 | |
| 115 | source_ori : int |
| 116 | The source orientation, either ``FIFF.FIFFV_MNE_FIXED_ORI`` or |
| 117 | ``FIFF.FIFFV_MNE_FREE_ORI``. |
| 118 | coord_frame : int |
| 119 | The coordinate frame of the forward solution, usually |
| 120 | ``FIFF.FIFFV_COORD_HEAD``. |
| 121 | nsource : int |
| 122 | The number of source locations. |
| 123 | nchan : int |
| 124 | The number of channels. |
| 125 | sol : dict |
| 126 | The forward solution, with entries: |
| 127 | |
| 128 | ``'data'`` : ndarray, shape (n_channels, nsource * n_ori) |
| 129 | The forward solution data. The shape will be |
| 130 | ``(n_channels, nsource)`` for a fixed-orientation forward and |
| 131 | ``(n_channels, nsource * 3)`` for a free-orientation forward. |
| 132 | ``'row_names'`` : list of str |
| 133 | The channel names. |
| 134 | mri_head_t : instance of Transform |
| 135 | The mri ↔ head transformation that was used. |
| 136 | info : instance of :class:`~mne.Info` |
| 137 | The measurement information (with contents reduced compared to that |
| 138 | of the original data). |
| 139 | src : instance of :class:`~mne.SourceSpaces` |
| 140 | The source space used during forward computation. This can differ |
| 141 | from the original source space as: |
| 142 | |
| 143 | 1. Source points are removed due to proximity to (or existing |
| 144 | outside) |
| 145 | the inner skull surface. |
no outgoing calls
no test coverage detected