Author: tlinnet
Date: Thu Jun 12 23:11:38 2014
New Revision: 23898
URL: http://svn.gna.org/viewcvs/relax?rev=23898&view=rev
Log:
Documentation fix for description of input arrays to lib functions.
Task #7807 (https://gna.org/task/index.php?7807): Speed-up of dispersion
models for Clustered analysis.
Modified:
branches/disp_spin_speed/lib/dispersion/b14.py
branches/disp_spin_speed/lib/dispersion/cr72.py
branches/disp_spin_speed/lib/dispersion/dpl94.py
branches/disp_spin_speed/lib/dispersion/tsmfk01.py
Modified: branches/disp_spin_speed/lib/dispersion/b14.py
URL:
http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/lib/dispersion/b14.py?rev=23898&r1=23897&r2=23898&view=diff
==============================================================================
--- branches/disp_spin_speed/lib/dispersion/b14.py (original)
+++ branches/disp_spin_speed/lib/dispersion/b14.py Thu Jun 12 23:11:38
2014
@@ -149,7 +149,7 @@
@keyword back_calc: The array for holding the back calculated R2eff
values. Each element corresponds to one of the CPMG nu1 frequencies.
@type back_calc: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword num_points: The number of points on the dispersion curve,
equal to the length of the cpmg_frqs and back_calc arguments.
- @type num_points: int
+ @type num_points: numpy int array of rank [NE][NS][[NM][NO][ND]
"""
# Flag to tell if values should be replaced if math function is violated.
Modified: branches/disp_spin_speed/lib/dispersion/cr72.py
URL:
http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/lib/dispersion/cr72.py?rev=23898&r1=23897&r2=23898&view=diff
==============================================================================
--- branches/disp_spin_speed/lib/dispersion/cr72.py (original)
+++ branches/disp_spin_speed/lib/dispersion/cr72.py Thu Jun 12 23:11:38
2014
@@ -125,7 +125,7 @@
@keyword back_calc: The array for holding the back calculated R2eff
values. Each element corresponds to one of the CPMG nu1 frequencies.
@type back_calc: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword num_points: The number of points on the dispersion curve,
equal to the length of the cpmg_frqs and back_calc arguments.
- @type num_points: int
+ @type num_points: numpy int array of rank [NE][NS][[NM][NO][ND]
"""
# Flag to tell if values should be replaced if max_etapos in cosh
function is violated.
Modified: branches/disp_spin_speed/lib/dispersion/dpl94.py
URL:
http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/lib/dispersion/dpl94.py?rev=23898&r1=23897&r2=23898&view=diff
==============================================================================
--- branches/disp_spin_speed/lib/dispersion/dpl94.py (original)
+++ branches/disp_spin_speed/lib/dispersion/dpl94.py Thu Jun 12 23:11:38
2014
@@ -73,21 +73,21 @@
@keyword r1rho_prime: The R1rho_prime parameter value (R1rho with
no exchange).
- @type r1rho_prime: float
+ @type r1rho_prime: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword phi_ex: The phi_ex parameter value (pA * pB *
delta_omega^2).
- @type phi_ex: float
+ @type phi_ex: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword kex: The kex parameter value (the exchange rate
in rad/s).
@type kex: float
@keyword theta: The rotating frame tilt angles for each
dispersion point.
- @type theta: numpy rank-1 float array
+ @type theta: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword R1: The R1 relaxation rate.
- @type R1: float
+ @type R1: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword spin_lock_fields2: The R1rho spin-lock field strengths squared
(in rad^2.s^-2).
- @type spin_lock_fields2: numpy rank-1 float array
+ @type spin_lock_fields2: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword back_calc: The array for holding the back calculated
R1rho values. Each element corresponds to the combination of theta and spin
lock field.
- @type back_calc: numpy rank-1 float array
+ @type back_calc: numpy float array of rank
[NE][NS][[NM][NO][ND]
@keyword num_points: The number of points on the dispersion
curve, equal to the length of the spin_lock_fields and back_calc arguments.
- @type num_points: int
+ @type num_points: numpy int array of rank [NE][NS][[NM][NO][ND]
"""
# Flag to tell if values should be replaced if numer is zero.
Modified: branches/disp_spin_speed/lib/dispersion/tsmfk01.py
URL:
http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/lib/dispersion/tsmfk01.py?rev=23898&r1=23897&r2=23898&view=diff
==============================================================================
--- branches/disp_spin_speed/lib/dispersion/tsmfk01.py (original)
+++ branches/disp_spin_speed/lib/dispersion/tsmfk01.py Thu Jun 12 23:11:38
2014
@@ -78,19 +78,19 @@
@keyword r20a: The R20 parameter value of state A (R2 with no
exchange).
- @type r20a: float
+ @type r20a: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword dw: The chemical exchange difference between states
A and B in rad/s.
- @type dw: float
+ @type dw: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword dw_orig: The chemical exchange difference between states
A and B in ppm. This is only for faster checking of zero value, which result
in no exchange.
@type dw_orig: numpy float array of rank-1
@keyword k_AB: The k_AB parameter value (the forward exchange
rate in rad/s).
@type k_AB: float
@keyword tcp: The tau_CPMG times (1 / 4.nu1).
- @type tcp: numpy rank-1 float array.
+ @type tcp: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword back_calc: The array for holding the back calculated R2eff
values. Each element corresponds to one of the CPMG nu1 frequencies.
- @type back_calc: numpy rank-1 float array
+ @type back_calc: numpy float array of rank [NE][NS][[NM][NO][ND]
@keyword num_points: The number of points on the dispersion curve,
equal to the length of the cpmg_frqs and back_calc arguments.
- @type num_points: int
+ @type num_points: numpy int array of rank [NE][NS][[NM][NO][ND]
"""
# Flag to tell if values should be replaced if max_etapos in cosh
function is violated.
r23898 - in /branches/disp_spin_speed/lib/dispersion: b14.py cr72.py dpl94.py tsmfk01.py