r19182 - /branches/relax_disp/specific_analyses/relax_disp.py -- March 27, 2013 - 13:04

Author: bugman
Date: Wed Mar 27 13:04:25 2013
New Revision: 19182

URL: http://svn.gna.org/viewcvs/relax?rev=19182&view=rev
Log:
Ported r8331 from the old relax_disp branch into the new branch.

The command used was:
svn merge -r8330:8331 
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/branches/relax_disp/specific_fns/@r18123
 specific_analyses

.....
  r8331 | semor | 2009-01-08 00:48:34 +0100 (Thu, 08 Jan 2009) | 3 lines
  Changed paths:
     M /branches/relax_disp/specific_fns/relax_disp.py
  
  Changed 'relax_time' instances to 'cpmg_frq'.
.....


Modified:
    branches/relax_disp/specific_analyses/relax_disp.py

Modified: branches/relax_disp/specific_analyses/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/specific_analyses/relax_disp.py?rev=19182&r1=19181&r2=19182&view=diff
==============================================================================
--- branches/relax_disp/specific_analyses/relax_disp.py (original)
+++ branches/relax_disp/specific_analyses/relax_disp.py Wed Mar 27 13:04:25 
2013
@@ -122,7 +122,7 @@
 
             # Intensity scaling.
             elif search('^i', spin.params[i]):
-                # Find the position of the first time point.
+                # Find the position of the first CPMG pulse train frequency 
point.
                 pos = cdp.cpmg_frqs.index(min(cdp.cpmg_frqs))
 
                 # Scaling.
@@ -135,15 +135,15 @@
         return scaling_matrix
 
 
-    def back_calc(self, spin=None, relax_time_index=None):
-        """Back-calculation of peak intensity for the given relaxation time.
-
-        @keyword spin:              The spin container.
-        @type spin:                 SpinContainer instance
-        @keyword relax_time_index:  The index for the desired relaxation 
time.
-        @type relax_time_index:     int
-        @return:                    The peak intensity for the desired 
relaxation time.
-        @rtype:                     float
+    def back_calc(self, spin=None, cpmg_frq_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.
+        @rtype:                   float
         """
 
         # Alias the current data pipe.
@@ -165,7 +165,7 @@
         results = back_calc_I()
 
         # Return the correct peak height.
-        return results[relax_time_index]
+        return results[cpmg_frq_index]
 
 
     def cpmg_frq(self, frq=0, spectrum_id=None):
@@ -239,7 +239,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, relax_time_index=j)
+            value = self.back_calc(spin=spin, cpmg_frq_index=j)
 
             # Append the value.
             mc_data.append(value)