r8335 - /branches/relax_disp/specific_fns/relax_disp.py -- January 08, 2009 - 16:19

Author: semor
Date: Thu Jan  8 16:19:09 2009
New Revision: 8335

URL: http://svn.gna.org/viewcvs/relax?rev=8335&view=rev
Log:
Changed the index name and description.

This is as proposed by Ed in a post at:
https://mail.gna.org/public/relax-devel/2009-01/msg00029.html
(Message-id: <7f080ed10901080144u541e6ed5ve52d2d233f8d7cf7@xxxxxxxxxxxxxx>)

The description might change later to be more appropriate when the code is 
more mature...


Modified:
    branches/relax_disp/specific_fns/relax_disp.py

Modified: branches/relax_disp/specific_fns/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/specific_fns/relax_disp.py?rev=8335&r1=8334&r2=8335&view=diff
==============================================================================
--- branches/relax_disp/specific_fns/relax_disp.py (original)
+++ branches/relax_disp/specific_fns/relax_disp.py Thu Jan  8 16:19:09 2009
@@ -135,14 +135,16 @@
         return scaling_matrix
 
 
-    def back_calc(self, spin=None, cpmg_frq_index=None):
+    def back_calc(self, spin=None, result_index=None):
         """Back-calculation of peak intensity for the given CPMG pulse train 
frequency.
 
         @keyword spin:            The spin container.
         @type spin:               SpinContainer instance
-        @keyword cpmg_frq_index:  The index for the desired CPMG pulse train 
frequency.
-        @type cpmg_frq_index:     int
-        @return:                  The peak intensity for the desired CPMG 
pulse train frequency.
+        @keyword result_index:    The index for the back-calculated data 
associated to every CPMG or
+                                  R1rho frequency, as well as every magnetic 
field frequency.
+        @type result_index:       int
+        @return:                  The R2eff value associated to every CPMG 
or R1rho frequency, as
+                                  well as every magnetic field frequency.
         @rtype:                   float
         """
 
@@ -165,7 +167,7 @@
         results = back_calc_I()
 
         # Return the correct peak height.
-        return results[cpmg_frq_index]
+        return results[result_index]
 
 
     def cpmg_frq(self, frq=0, spectrum_id=None):
@@ -239,7 +241,7 @@
         # Loop over the spectral time points.
         for j in xrange(len(cdp.cpmg_frqs)):
             # Back calculate the value.
-            value = self.back_calc(spin=spin, cpmg_frq_index=j)
+            value = self.back_calc(spin=spin, result_index=j)
 
             # Append the value.
             mc_data.append(value)