[med-svn] [python-mne] 211/353: DOC : better lcmv docstring

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to tag 0.4
in repository python-mne.

commit 5cf2e7da8b2562bc39ec7d344635036a0486d354
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Wed Jun 20 11:24:49 2012 +0300

    DOC : better lcmv docstring
---
 mne/beamformer/_lcmv.py | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/mne/beamformer/_lcmv.py b/mne/beamformer/_lcmv.py
index 40b8afa..389cf88 100644
--- a/mne/beamformer/_lcmv.py
+++ b/mne/beamformer/_lcmv.py
@@ -18,8 +18,11 @@ from ..cov import compute_whitener
 def lcmv(evoked, forward, noise_cov, data_cov, reg=0.01):
     """Linearly Constrained Minimum Variance (LCMV) beamformer.
 
-    Compute LCMV on evoked data starting from
-    a forward operator.
+    Compute Linearly Constrained Minimum Variance (LCMV) beamformer
+    on evoked data.
+
+    NOTE : This implementation is heavilly tested so please
+    report any issue or suggestions.
 
     Parameters
     ----------
@@ -27,6 +30,12 @@ def lcmv(evoked, forward, noise_cov, data_cov, reg=0.01):
         Evoked data to invert
     forward : dict
         Forward operator
+    noise_cov : Covariance
+        The noise covariance
+    data_cov : Covariance
+        The data covariance
+    reg : float
+        The regularization for the whitened data covariance.
 
     Returns
     -------

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git