[med-svn] [python-mne] 23/353: Added 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 7f4ea3af989518f9cb36aa9710ea89c2070f8cb6
Author: Martin Luessi <mluessi at nmr.mgh.harvard.edu>
Date:   Fri Dec 9 11:02:57 2011 -0500

    Added docstring
---
 mne/source_estimate.py | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/mne/source_estimate.py b/mne/source_estimate.py
index 156f49b..d62dca5 100644
--- a/mne/source_estimate.py
+++ b/mne/source_estimate.py
@@ -271,7 +271,22 @@ class SourceEstimate(object):
         self.times = self.tmin + self.tstep * np.arange(self.data.shape[1])
 
     def save(self, fname, ftype='stc'):
-        """save to source estimates to file"""
+        """Save the source estimates to a file
+
+        Parameters
+        ----------
+        fname : string
+            The stem of the file name. The file names used for surface source
+            spaces are obtained by adding "-lh.stc" and "-rh.stc" (or "-lh.w"
+            and "-rh.w") to the stem provided, for the left and the right
+            hemisphere, respectively. For volume source spaces, the stem is
+            extended with "-vl.stc".
+        ftype : string
+            File format to use. Allowed values are "stc" (default) and "w".
+            The "stc" format can be for surface and volume source spaces,
+            while the "w" format only supports surface source spaces with a
+            single time point.
+        """
         if self.is_surface():
             lh_data = self.data[:len(self.lh_vertno)]
             rh_data = self.data[-len(self.rh_vertno):]

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