Author: tlinnet Date: Tue Jun 17 19:11:07 2014 New Revision: 24055 URL: http://svn.gna.org/viewcvs/relax?rev=24055&view=rev Log: Documentation fix for the dimensionality of the input arrays.
Task #7807 (https://gna.org/task/index.php?7807): Speed-up of dispersion models for Clustered analysis. Modified: branches/disp_spin_speed/lib/dispersion/ns_r1rho_2site.py Modified: branches/disp_spin_speed/lib/dispersion/ns_r1rho_2site.py URL: http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/lib/dispersion/ns_r1rho_2site.py?rev=24055&r1=24054&r2=24055&view=diff ============================================================================== --- branches/disp_spin_speed/lib/dispersion/ns_r1rho_2site.py (original) +++ branches/disp_spin_speed/lib/dispersion/ns_r1rho_2site.py Tue Jun 17 19:11:07 2014 @@ -69,33 +69,33 @@ @keyword matrix: A numpy array to be populated to create the evolution matrix. @type matrix: numpy rank-2, 6D float64 array @keyword r1rho_prime: The R1rho_prime parameter value (R1rho with no exchange). - @type r1rho_prime: float + @type r1rho_prime: numpy float array of rank [NS][NM][NO][ND] @keyword omega: The chemical shift for the spin in rad/s. - @type omega: float + @type omega: numpy float array of rank [NS][NM][NO][ND] @keyword offset: The spin-lock offsets for the data. - @type offset: numpy rank-1 float array + @type offset: numpy float array of rank [NS][NM][NO][ND] @keyword r1: The R1 relaxation rate. - @type r1: float + @type r1: numpy float array of rank [NS][NM][NO][ND] @keyword pA: The population of state A. @type pA: float @keyword pB: The population of state B. @type pB: float @keyword dw: The chemical exchange difference between states A and B in rad/s. - @type dw: float + @type dw: numpy float array of rank [NS][NM][NO][ND] @keyword k_AB: The rate of exchange from site A to B (rad/s). @type k_AB: float @keyword k_BA: The rate of exchange from site B to A (rad/s). @type k_BA: float @keyword spin_lock_fields: The R1rho spin-lock field strengths (in rad.s^-1). - @type spin_lock_fields: numpy rank-1 float array + @type spin_lock_fields: numpy float array of rank [NS][NM][NO][ND] @keyword relax_time: The total relaxation time period for each spin-lock field strength (in seconds). - @type relax_time: float + @type relax_time: numpy float array of rank [NS][NM][NO][ND] @keyword inv_relax_time: The inverse of the relaxation time period for each spin-lock field strength (in inverse seconds). This is used for faster calculations. - @type inv_relax_time: float + @type inv_relax_time: numpy float array of rank [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 [NS][NM][NO][ND] @keyword num_points: The number of points on the dispersion curve, equal to the length of the tcp and back_calc arguments. - @type num_points: int + @type num_points: numpy int array of rank [NS][NM][NO] """ # Extract shape of experiment. _______________________________________________ relax (http://www.nmr-relax.com) This is the relax-commits mailing list relax-commits@gna.org To unsubscribe from this list, get a password reminder, or change your subscription options, visit the list information page at https://mail.gna.org/listinfo/relax-commits