Maybe here you could introduce your notation used in the
lib.dispersion functions. I.e. delete the text "The dimensions are
{Ei, Si, Mi, Oi, Di}" for the keyword part and add "[NE, NS, NM, NO,
ND]" to the type part. So the following:
@keyword tilt_angles: The spin-lock rotating frame tilt
angle. This is only used for off-resonance R1rho models. The
dimensions are {Ei, Si, Mi, Oi, Di}.
@type tilt_angles: rank-5 list of floats
changes to something like:
@keyword tilt_angles: The spin-lock rotating frame tilt
angle. This is only used for off-resonance R1rho models.
@type tilt_angles: rank-5 list of floats [NE, NS, NM, NO, ND]
Just an idea.
Regards,
Edward
On 17 June 2014 15:08, <[email protected]> wrote:
> Author: tlinnet
> Date: Tue Jun 17 15:08:26 2014
> New Revision: 24038
>
> URL: http://svn.gna.org/viewcvs/relax?rev=24038&view=rev
> Log:
> Documentation fix for the initial data structure of cpmg_frqs, spin_lock_nu1,
> r1.
>
> They were incorrect.
>
> Task #7807 (https://gna.org/task/index.php?7807): Speed-up of dispersion
> models for Clustered analysis.
>
> Modified:
> branches/disp_spin_speed/target_functions/relax_disp.py
>
> Modified: branches/disp_spin_speed/target_functions/relax_disp.py
> URL:
> http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/target_functions/relax_disp.py?rev=24038&r1=24037&r2=24038&view=diff
> ==============================================================================
> --- branches/disp_spin_speed/target_functions/relax_disp.py (original)
> +++ branches/disp_spin_speed/target_functions/relax_disp.py Tue Jun 17
> 15:08:26 2014
> @@ -130,18 +130,18 @@
> @type frqs: rank-3 list of floats
> @keyword frqs_H: The proton spin Larmor frequencies for
> the MMQ-type models (in MHz*2pi to speed up the ppm to rad/s conversion).
> The dimensions are {Ei, Si, Mi}.
> @type frqs_H: rank-3 list of floats
> - @keyword cpmg_frqs: The CPMG frequencies in Hertz. This
> will be ignored for R1rho experiments. The dimensions are {Ei, Mi}.
> - @type cpmg_frqs: rank-2 list of floats
> - @keyword spin_lock_nu1: The spin-lock field strengths in Hertz.
> This will be ignored for CPMG experiments. The dimensions are {Ei, Mi}.
> - @type spin_lock_nu1: rank-2 list of floats
> + @keyword cpmg_frqs: The CPMG frequencies in Hertz. This
> will be ignored for R1rho experiments. The dimensions are {Ei, Mi, Oi}.
> + @type cpmg_frqs: rank-3 list of floats
> + @keyword spin_lock_nu1: The spin-lock field strengths in Hertz.
> This will be ignored for CPMG experiments. The dimensions are {Ei, Mi, Oi}.
> + @type spin_lock_nu1: rank-3 list of floats
> @keyword chemical_shifts: The chemical shifts in rad/s. This is
> only used for off-resonance R1rho models. The ppm values are not used to
> save computation time, therefore they must be converted to rad/s by the
> calling code. The dimensions are {Ei, Si, Mi}.
> @type chemical_shifts: rank-3 list of floats
> @keyword offset: The structure of spin-lock or hard pulse
> offsets in rad/s. This is only currently used for off-resonance R1rho
> models. The dimensions are {Ei, Si, Mi, Oi}.
> @type offset: rank-4 list of floats
> @keyword tilt_angles: The spin-lock rotating frame tilt angle.
> This is only used for off-resonance R1rho models. The dimensions are {Ei,
> Si, Mi, Oi, Di}.
> @type tilt_angles: rank-5 list of floats
> - @keyword r1: The R1 relaxation rates. This is only
> used for off-resonance R1rho models. The dimensions are {Ei, Si, Mi}.
> - @type r1: rank-3 list of floats
> + @keyword r1: The R1 relaxation rates. This is only
> used for off-resonance R1rho models. The dimensions are {Si, Mi}.
> + @type r1: rank-2 list of floats
> @keyword relax_times: The experiment specific fixed time
> period for relaxation (in seconds). The dimensions are {Ei, Mi}.
> @type relax_times: rank-2 list of floats
> @keyword scaling_matrix: The square and diagonal scaling matrix.
>
>
> _______________________________________________
> relax (http://www.nmr-relax.com)
>
> This is the relax-commits mailing list
> [email protected]
>
> 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
_______________________________________________
relax (http://www.nmr-relax.com)
This is the relax-devel mailing list
[email protected]
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-devel
