r24775 - /branches/r1rho_plotting/specific_analyses/relax_disp/data.py -- July 26, 2014 - 13:34

Author: tlinnet
Date: Sat Jul 26 13:34:24 2014
New Revision: 24775

URL: http://svn.gna.org/viewcvs/relax?rev=24775&view=rev
Log:
Corrected the epydoc information for the return_offset_data() function in 
specific_analyses.relax_disp.data.

The function has been extended to return more data.

sr #3124(https://gna.org/support/?3124): Grace graphs production for R1rho 
analysis with R2_eff as function of Omega_eff.
sr #3138(https://gna.org/support/?3138): Interpolating theta through 
spin-lock offset [Omega], rather than spin-lock field strength [w1].

Modified:
    branches/r1rho_plotting/specific_analyses/relax_disp/data.py

Modified: branches/r1rho_plotting/specific_analyses/relax_disp/data.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/r1rho_plotting/specific_analyses/relax_disp/data.py?rev=24775&r1=24774&r2=24775&view=diff
==============================================================================
--- branches/r1rho_plotting/specific_analyses/relax_disp/data.py        
(original)
+++ branches/r1rho_plotting/specific_analyses/relax_disp/data.py        Sat 
Jul 26 13:34:24 2014
@@ -3470,8 +3470,8 @@
     @type spin_lock_offset:     list of lists of numpy rank-1 float arrays
     @keyword fields:            The spin-lock field strengths to use instead 
of the user loaded values - to enable interpolation.  The dimensions are {Ei, 
Mi}.
     @type fields:               rank-2 list of floats
-    @return:                    The numpy array structures of the chemical 
shifts in rad/s {Ei, Si, Mi}, spin_lock field strengths in Hertz {Ei, Mi, 
Oi}, spin-lock offsets in rad/s {Ei, Si, Mi, Oi}, rotating frame tilt angles 
{Ei, Si, Mi, Oi, Di}, the average resonance offset in the rotating frame in 
rad/s {Ei, Si, Mi, Oi, Di} and the effective field in rotating frame in rad/s 
{Ei, Si, Mi, Oi, Di}.
-    @rtype:                     rank-3 list of floats, rank-3 list of 
floats, rank-4 list of floats, rank-5 list of floats
+    @return:                    The chemical shifts in rad/s {Ei, Si, Mi}, 
interpolated spin-lock field strength frequencies in Hz {Ei, Si, Mi, Oi, Di}, 
interpolated spin-lock offsets in rad/s {Ei, Si, Mi, Oi}, interpolated 
rotating frame tilt angles {Ei, Si, Mi, Oi, Di}, interpolated average 
resonance offset in the rotating frame in rad/s {Ei, Si, Mi, Oi, Di} and the 
interpolated effective field in rotating frame in rad/s {Ei, Si, Mi, Oi, Di}.
+    @rtype:                     rank-2 list of numpy rank-1 float arrays, 
rank-4 list of numpy rank-1 float arrays, rank-3 list of numpy rank-1 float 
arrays, rank-4 list of numpy rank-1 float arrays, rank-4 list of numpy rank-1 
float arrays, rank-4 list of numpy rank-1 float arrays
     """
 
     # The counts.