meegsim.sources.PointSource#
- class meegsim.sources.PointSource(name, src_idx, vertno, waveform, std=1.0, hemi=None)[source]#
Point source of activity that is located in one of the vertices in the source space.
- Attributes:
- name
str The name of source.
- src_idx
int The index of source space that the point source belong to.
- vertno
int The vertex that the point source correspond to
- waveform
array The waveform of source activity.
- std
float, optional The standard deviation of the source activity (1 by default).
- hemi
strorNone, optional Human-readable name of the hemisphere (e.g, lh or rh).
- name
Methods
to_label(src)Get an mne.Label object containing all vertices belonging to the current source.
to_stc(src, tstep[, subject])Convert the source into a SourceEstimate object in the context of the provided SourceSpaces.
- to_label(src)[source]#
Get an mne.Label object containing all vertices belonging to the current source.
- Parameters:
- src
SourceSpaces The source space where the source should be considered.
- src
- Returns:
- label
Label The constructed label.
- label
- to_stc(src, tstep, subject=None)[source]#
Convert the source into a SourceEstimate object in the context of the provided SourceSpaces.
- Parameters:
- src
SourceSpaces The source space where the source should be considered.
- tstep
float The sampling interval of the source time series (1 / sfreq).
- subject
strorNone, optional Name of the subject that the stc corresponds to. If None, the subject name from the provided src is used if present.
- src
- Returns:
- stc
SourceEstimate SourceEstimate that corresponds to the source in the provided src.
- stc
- Raises:
ValueErrorIf the source does not exist in the provided src.