r24341 - /branches/disp_spin_speed/target_functions/relax_disp.py -- June 27, 2014 - 14:24

Author: bugman
Date: Fri Jun 27 14:24:23 2014
New Revision: 24341

URL: http://svn.gna.org/viewcvs/relax?rev=24341&view=rev
Log:
Expanded the dispersion target function class documentation.

The NE, NS, NM, NO, and ND notation is now explained.


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=24341&r1=24340&r2=24341&view=diff
==============================================================================
--- branches/disp_spin_speed/target_functions/relax_disp.py     (original)
+++ branches/disp_spin_speed/target_functions/relax_disp.py     Fri Jun 27 
14:24:23 2014
@@ -108,8 +108,20 @@
             - Ei:  The index for each experiment type.
             - Si:  The index for each spin of the spin cluster.
             - Mi:  The index for each magnetic field strength.
-            - Oi:  The index for each spin-lock offset.  In the case of 
CPMG-type data, this index is always zero.
+            - Oi:  The index for each spin-lock offset.  In the case of 
CPMG-type data, this index is currently always zero.
             - Di:  The index for each dispersion point (either the spin-lock 
field strength or the nu_CPMG frequency).
+
+
+        Counts
+        ======
+
+        The indices in the previous section have a corresponding count:
+
+            - NE:  The total number of experiment types.
+            - NS:  The total number of spins of the spin cluster.
+            - NM:  The total number of magnetic field strengths.
+            - NO:  The total number of spin-lock offsets.
+            - ND:  The total number of dispersion points (either the 
spin-lock field strength or the nu_CPMG frequency).
 
 
         @keyword model:             The relaxation dispersion model to fit.