mne.apply_forward#
- mne.apply_forward(fwd, stc, info, start=None, stop=None, use_cps=True, on_missing='raise', verbose=None)[source]#
Project source space currents to sensor space using a forward operator.
The sensor space data is computed for all channels present in fwd. Use pick_channels_forward or pick_types_forward to restrict the solution to a subset of channels.
The function returns an Evoked object, which is constructed from evoked_template. The evoked_template should be from the same MEG system on which the original data was acquired. An exception will be raised if the forward operator contains channels that are not present in the template.
- Parameters:
- fwd
Forward
Forward operator to use.
- stc
SourceEstimate
The source estimate from which the sensor space data is computed.
- info
mne.Info
The
mne.Info
object with information about the sensors and methods of measurement.- start
int
, optional Index of first time sample (index not time is seconds).
- stop
int
, optional Index of first time sample not to include (index not time is seconds).
- use_cps
bool
Whether to use cortical patch statistics to define normal orientations for surfaces (default True).
New in version 0.15.
- on_missing‘raise’ | ‘warn’ | ‘ignore’
Can be
'raise'
(default) to raise an error,'warn'
to emit a warning, or'ignore'
to ignore whenstc
has vertices that are not infwd
. Default is “raise”.New in version 0.18.
- verbose
bool
|str
|int
|None
Control verbosity of the logging output. If
None
, use the default verbosity level. See the logging documentation andmne.verbose()
for details. Should only be passed as a keyword argument.
- fwd
- Returns:
- evoked
Evoked
Evoked object with computed sensor space data.
- evoked
See also
apply_forward_raw
Compute sensor space data and return a Raw object.