r24879 - /branches/r1rho_plotting/user_functions/relax_disp.py -- July 31, 2014 - 15:12

Author: tlinnet
Date: Thu Jul 31 15:12:19 2014
New Revision: 24879

URL: http://svn.gna.org/viewcvs/relax?rev=24879&view=rev
Log:
Improved description in GUI text for user function 
relax_disp.plot_disp_curves().

The improved description now explains the new features.

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/user_functions/relax_disp.py

Modified: branches/r1rho_plotting/user_functions/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/r1rho_plotting/user_functions/relax_disp.py?rev=24879&r1=24878&r2=24879&view=diff
==============================================================================
--- branches/r1rho_plotting/user_functions/relax_disp.py        (original)
+++ branches/r1rho_plotting/user_functions/relax_disp.py        Thu Jul 31 
15:12:19 2014
@@ -552,6 +552,8 @@
 uf.desc.append(Desc_container())
 uf.desc[-1].add_paragraph("This is used to create 2D Grace plots of the 
dispersion curves of the nu_CPMG frequencies or spin-lock field strength 
verses the R2eff/R1rho values.  One file will be created per spin system with 
the name 'disp_x.agr', where x is related to the spin ID string.  For each 
file, one Grace graph will be produced for each experiment.")
 uf.desc[-1].add_paragraph("Four sets of curves of R2eff/R1rho values will be 
produced per experiment and per magnetic field strength.  These are the 
experimental values, the fitted values, the interpolated dispersion curves 
for the fitted solution, and the residuals.  Different dispersion models 
result in different interpolated dispersion curves.  For the numeric models 
which use CPMG-type data, the maximum interpolation resolution is constrained 
by the frequency of a single CPMG block for the entire relaxation period.  
For all other models, the interpolation resolution is not constrained and can 
be as fine as desired by setting the total number of interpolation points.  
Interpolated curves are not produced for the 'R2eff' model as they are not 
necessary.")
+uf.desc[-1].add_paragraph("For R1rho models, graphs can be interpolated 
against Spin-lock offset, but this feature is not available for CPMG 
experiment types.  It is also possible to select values on X-axis of 
'Effective field in rotating frame %s (rad/s)' or 'Rotating frame tilt angle 
%s (rad)'."%("w_eff", "theta"))
+uf.desc[-1].add_paragraph("For R1rho models, special Y-value %s %s can for 
ex. be plotted as function of %s.  %s is calculated as: %s=(%s - %s 
cos^2(%s)) / sin^2(%s)."%("R2", "R1rho", "w_eff", "R2", "R2", "R1rho", "R1", 
"theta", "theta"))
 uf.backend = plot_disp_curves
 uf.menu_text = "&plot_disp_curves"
 uf.gui_icon = "oxygen.actions.document-save"