Represent a list of source space. This class acts like a list of dictionaries containing the source space information, one entry in the list per source space type. See Notes for details. .. warning:: This class should not be created or modified by the end user. Use
| 101 | |
| 102 | |
| 103 | class SourceSpaces(list): |
| 104 | """Represent a list of source space. |
| 105 | |
| 106 | This class acts like a list of dictionaries containing the source |
| 107 | space information, one entry in the list per source space type. See |
| 108 | Notes for details. |
| 109 | |
| 110 | .. warning:: |
| 111 | This class should not be created or modified by the end user. Use |
| 112 | :func:`mne.setup_source_space`, :func:`mne.setup_volume_source_space`, |
| 113 | or :func:`mne.read_source_spaces` to create :class:`SourceSpaces`. |
| 114 | |
| 115 | Parameters |
| 116 | ---------- |
| 117 | source_spaces : list |
| 118 | A list of dictionaries containing the source space information. |
| 119 | info : dict | None |
| 120 | Dictionary with information about the creation of the source space |
| 121 | file. Has keys ``'working_dir'`` and ``'command_line'``. |
| 122 | |
| 123 | Attributes |
| 124 | ---------- |
| 125 | kind : ``'surface'`` | ``'volume'`` | ``'discrete'`` | ``'mixed'`` |
| 126 | The kind of source space. |
| 127 | info : dict |
| 128 | Dictionary with information about the creation of the source space |
| 129 | file. Has keys ``'working_dir'`` and ``'command_line'``. |
| 130 | |
| 131 | See Also |
| 132 | -------- |
| 133 | mne.setup_source_space : Setup a surface source space. |
| 134 | mne.setup_volume_source_space : Setup a volume source space. |
| 135 | mne.read_source_spaces : Read source spaces from a file. |
| 136 | |
| 137 | Notes |
| 138 | ----- |
| 139 | Each element in SourceSpaces (e.g., ``src[0]``) is a dictionary. For |
| 140 | example, a surface source space will have ``len(src) == 2``, one entry for |
| 141 | each hemisphere. A volume source space will have ``len(src) == 1`` if it |
| 142 | uses a single monolithic grid, or ``len(src) == len(volume_label)`` when |
| 143 | created with a list-of-atlas-labels. A mixed source space consists of both |
| 144 | surface and volumetric source spaces in a single SourceSpaces object. |
| 145 | |
| 146 | Each of those dictionaries can be accessed using standard Python |
| 147 | :class:`python:dict` access using the string keys listed below (e.g., |
| 148 | ``src[0]['type'] == 'surf'``). The relevant key/value pairs depend on |
| 149 | the source space type: |
| 150 | |
| 151 | **Relevant to all source spaces** |
| 152 | |
| 153 | The following are always present: |
| 154 | |
| 155 | id : int |
| 156 | The FIF ID, either ``FIFF.FIFFV_MNE_SURF_LEFT_HEMI`` or |
| 157 | ``FIFF.FIFFV_MNE_SURF_RIGHT_HEMI`` for surfaces, or |
| 158 | ``FIFF.FIFFV_MNE_SURF_UNKNOWN`` for volume source spaces. |
| 159 | type : str |
| 160 | The type of source space, one of ``{'surf', 'vol', 'discrete'}``. |
no outgoing calls