r22450 - /trunk/specific_analyses/relax_disp/disp_data.py -- March 12, 2014 - 09:29

Author: tlinnet
Date: Wed Mar 12 09:29:15 2014
New Revision: 22450

URL: http://svn.gna.org/viewcvs/relax?rev=22450&view=rev
Log:
Added epydoc information about dimensions for w_e in function 
return_offset_data.

Regarding sr #3124, (https://gna.org/support/index.php?3124) - Grace graphs 
production for R1rho analysis with R2_eff as function of Omega_eff.

Modified:
    trunk/specific_analyses/relax_disp/disp_data.py

Modified: trunk/specific_analyses/relax_disp/disp_data.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_disp/disp_data.py?rev=22450&r1=22449&r2=22450&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/disp_data.py     (original)
+++ trunk/specific_analyses/relax_disp/disp_data.py     Wed Mar 12 09:29:15 
2014
@@ -2740,7 +2740,7 @@
     @type field_count:      int
     @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 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 {Ei, Si, Mi, Oi, Di} in rad/s and the effective field 
in rotating frame in rad/s.
+    @return:                The numpy array structures of the chemical 
shifts in rad/s {Ei, Si, Mi}, 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-4 list of floats, 
rank-5 list of floats
     """