r8721 - /branches/relax_disp/prompt/relax_disp.py -- February 03, 2009 - 00:10

Author: semor
Date: Tue Feb  3 00:10:20 2009
New Revision: 8721

URL: http://svn.gna.org/viewcvs/relax?rev=8721&view=rev
Log:
Added more to the docstring.

This is not complete yet...


Modified:
    branches/relax_disp/prompt/relax_disp.py

Modified: branches/relax_disp/prompt/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/prompt/relax_disp.py?rev=8721&r1=8720&r2=8721&view=diff
==============================================================================
--- branches/relax_disp/prompt/relax_disp.py (original)
+++ branches/relax_disp/prompt/relax_disp.py Tue Feb  3 00:10:20 2009
@@ -50,9 +50,6 @@
     def calc_r2eff(self, exp_type='cpmg', id=None, delayT=None, 
int_cpmg=1.0, int_ref=1.0):
         """Calculate the effective transversal relaxation rate from the peak 
intensities.
 
-        THIS FUNCTION IS NOT WRITTEN YET.
-
-
         Keyword arguments
         ~~~~~~~~~~~~~~~~~
 
@@ -80,6 +77,15 @@
 
         Examples
         ~~~~~~~~
+
+        To calculate r2eff from a CPMG experiment, for experiment named 
'600', a constant time delay
+        T of 20 ms (0.020 s) and intensities of CPMG and reference peak of, 
respectively, 0.742 and
+        0.9641, type:
+
+        relax> relax_disp.calc_r2eff('cpmg', '600', 0.020, 0.742, 0.9641)
+        relax> relax_disp.calc_r2eff(exp_type='cpmg', id='600', 
delayT=0.020, int_cpmg=0.742, int_ref=0.9641)
+
+        ANOTHER EXAMPLE FOR BATCH USE (FROM PEAK INTENSITY LISTS) WILL SOON 
BE ADDED.
         """
 
         # Function intro text.