Author: tlinnet
Date: Fri Mar 7 11:42:52 2014
New Revision: 22434
URL: http://svn.gna.org/viewcvs/relax?rev=22434&view=rev
Log:
Improved docstring in lib.rotating_frame.
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/lib/rotating_frame.py
Modified: trunk/lib/rotating_frame.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/lib/rotating_frame.py?rev=22434&r1=22433&r2=22434&view=diff
==============================================================================
--- trunk/lib/rotating_frame.py (original)
+++ trunk/lib/rotating_frame.py Fri Mar 7 11:42:52 2014
@@ -32,6 +32,21 @@
from specific_analyses.relax_disp.disp_data import loop_exp_frq_offset,
return_offset_data, return_param_key_from_data, return_spin_lock_nu1
def calc_rotating_frame_params():
+ """Calculates and return dictionaries of rotating frame parameters,
calculated from:
+ - The spectrometer frequency.
+ - The spin-lock or hard pulse offset.
+ - The dispersion point data (the spin-lock field strength in Hz).
+
+ The return will be dictionaries stored for each spin,
+ - spin.Domega - The average resonance offset in the rotating frame (
Domega = w_{pop_ave} - w_rf ) [rad/s]
+ - spin.theta - Rotating frame tilt angle ( theta = arctan(w_1 / Omega) )
[rad]
+ - spin.w_eff - Effective field in rotating frame ( w_eff = sqrt( Omega^2
+ w_1^2 ) ) [rad/s]
+
+ Calculations are mentioned in the
U{manual<http://www.nmr-relax.com/manual/Dispersion_model_summary.html>}
+
+ The dictionary keys are generated with:
+ return_param_key_from_data() from module
specific_analyses.relax_disp.disp_data.
+ """
# Get the field count
field_count = cdp.spectrometer_frq_count
r22434 - /trunk/lib/rotating_frame.py