mne.forward.compute_orient_prior

mne.forward.compute_orient_prior(forward, loose='auto', verbose=None)[source]

Compute orientation prior.

Parameters
forwardinstance of Forward

Forward operator.

loosefloat | ‘auto’ | dict

Value that weights the source variances of the dipole components that are parallel (tangential) to the cortical surface. Can be:

  • float between 0 and 1 (inclusive)

    If 0, then the solution is computed with fixed orientation. If 1, it corresponds to free orientations.

  • 'auto' (default)

    Uses 0.2 for surface source spaces (unless fixed is True) and 1.0 for other source spaces (volume or mixed).

  • dict

    Mapping from the key for a given source space type (surface, volume, discrete) to the loose value. Useful mostly for mixed source spaces.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns
orient_priorndarray, shape (n_sources,)

Orientation priors.