r25464 - in /trunk: lib/dispersion/ specific_analyses/relax_disp/ -- August 30, 2014 - 00:22

Author: tlinnet
Date: Sat Aug 30 00:22:54 2014
New Revision: 25464

URL: http://svn.gna.org/viewcvs/relax?rev=25464&view=rev
Log:
API documentation fixes.

Modified:
    trunk/lib/dispersion/matrix_exponential.py
    trunk/lib/dispersion/ns_r1rho_2site.py
    trunk/specific_analyses/relax_disp/estimate_r2eff.py

Modified: trunk/lib/dispersion/matrix_exponential.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/lib/dispersion/matrix_exponential.py?rev=25464&r1=25463&r2=25464&view=diff
==============================================================================
--- trunk/lib/dispersion/matrix_exponential.py  (original)
+++ trunk/lib/dispersion/matrix_exponential.py  Sat Aug 30 00:22:54 2014
@@ -172,7 +172,7 @@
     @param A:               The square matrix to calculate the matrix 
exponential of.
     @type A:                numpy float array of rank 
[NE][NS][NM][NO][ND][X][X]
     @param dtype:           If provided, forces the calculation to use the 
data type specified.
-    @type type:             data-type, optional
+    @type dtype:            data-type, optional
     @return:                The matrix exponential.  This will have the same 
dimensionality as the A matrix.
     @rtype:                 numpy float array of rank 
[NE][NS][NM][NO][ND][X][X]
     """
@@ -316,7 +316,7 @@
     @param A:       The square matrix to calculate the matrix exponential of.
     @type A:        numpy float array of rank [NS][NM][NO][ND][2][2]
     @param dtype:   If provided, forces the calculation to use the data type 
specified.
-    @type type:     data-type, optional
+    @type dtype:    data-type, optional
     @return:        The matrix exponential.  This will have the same 
dimensionality as the A matrix.
     @rtype:         numpy float array of rank [NS][NM][NO][ND][2][2]
     """

Modified: trunk/lib/dispersion/ns_r1rho_2site.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/lib/dispersion/ns_r1rho_2site.py?rev=25464&r1=25463&r2=25464&view=diff
==============================================================================
--- trunk/lib/dispersion/ns_r1rho_2site.py      (original)
+++ trunk/lib/dispersion/ns_r1rho_2site.py      Sat Aug 30 00:22:54 2014
@@ -200,8 +200,6 @@
     @type w1:               numpy float array of rank [NE][NS][NM][NO][ND]
     @keyword k_AB:          The forward exchange rate from state A to state 
B.
     @type k_AB:             float
-    @keyword k_BA:          The reverse exchange rate from state B to state 
A.
-    @type k_BA:             float
     @keyword k_BA:          The reverse exchange rate from state B to state 
A.
     @type k_BA:             float
     @keyword relax_time:    The total relaxation time period for each 
spin-lock field strength (in seconds).

Modified: trunk/specific_analyses/relax_disp/estimate_r2eff.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_disp/estimate_r2eff.py?rev=25464&r1=25463&r2=25464&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/estimate_r2eff.py        (original)
+++ trunk/specific_analyses/relax_disp/estimate_r2eff.py        Sat Aug 30 
00:22:54 2014
@@ -446,8 +446,7 @@
 
 
     def estimate_x0_exp(self, times=None, values=None):
-        """Estimate starting parameter x0 = [r2eff_est, i0_est], by 
converting the exponential curve to a linear problem.
-         Then solving by linear least squares of: ln(Intensity[j]) = ln(i0) 
- time[j]* r2eff.
+        """Estimate starting parameter x0 = [r2eff_est, i0_est], by 
converting the exponential curve to a linear problem.  Then solving by linear 
least squares of: ln(Intensity[j]) = ln(i0) - time[j]* r2eff.
 
         @keyword times:         The time points.
         @type times:            numpy array