r8343 - in /branches/relax_disp: prompt/relax_disp.py specific_fns/relax_disp.py -- January 08, 2009 - 20:13

Author: semor
Date: Thu Jan  8 20:13:00 2009
New Revision: 8343

URL: http://svn.gna.org/viewcvs/relax?rev=8343&view=rev
Log:
Added the user function cpmg_frq() and added examples to the user function 
cpmg_delayT().


Modified:
    branches/relax_disp/prompt/relax_disp.py
    branches/relax_disp/specific_fns/relax_disp.py

Modified: branches/relax_disp/prompt/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/prompt/relax_disp.py?rev=8343&r1=8342&r2=8343&view=diff
==============================================================================
--- branches/relax_disp/prompt/relax_disp.py (original)
+++ branches/relax_disp/prompt/relax_disp.py Thu Jan  8 20:13:00 2009
@@ -62,6 +62,15 @@
         ~~~~~~~~~~~
 
         This user function allows the CPMG constant time delay (T) of a 
given experiment to be set.
+
+
+        Examples
+        ~~~~~~~~
+
+        To set a CPMG constant time delay T of 20 ms (0.020 s) for 
experiments '600', type:
+
+        relax> relax_disp.cpmg_delayT('600', 0.020)
+        relax> relax_disp.cpmg_delayT(id='600', delayT=0.020)
         """
 
         # Function intro text.
@@ -83,6 +92,39 @@
         relax_disp_obj.cpmg_delayT(id=id, delayT=delayT)
 
 
+    def cpmg_frq(self, frq=0, spectrum_id=None):
+        """Set the CPMG frequency associated with a given spectrum.
+
+        Keyword arguments.
+        ~~~~~~~~~~~~~~~~~~
+
+        frq:   The frequency, in Hz, of the CPMG pulse train.
+
+        spectrum_id:   The spectrum identification string.
+
+
+        Description
+        ~~~~~~~~~~~
+
+        This user function allows the CPMG pulse train frequency of a given 
spectrum to be set.
+        If a value of 0 is set for frequency, then the spectrum will be 
treated as a reference
+        spectrum.
+
+
+        Examples
+        ~~~~~~~~
+
+        To identify the reference spectrum called 'reference_spectrum', type:
+
+        relax> relax_disp.cpmg_frq(0, 'reference_spectrum')
+        relax> relax_disp.cpmg_frq(frq=0, spectrum_id='reference_spectrum')
+
+        To set a frequency of 200 Hz for the spectrum '200_Hz_spectrum', 
type:
+
+        relax> relax_disp.cpmg_frq(200, '200_Hz_spectrum')
+        relax> relax_disp.cpmg_frq(frq=200, spectrum_id='200_Hz_spectrum')
+
+
     def exp_type(self, exp='cpmg'):
         """Function for the selection of the relaxation dispersion 
experiments to analyse.
 

Modified: branches/relax_disp/specific_fns/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/specific_fns/relax_disp.py?rev=8343&r1=8342&r2=8343&view=diff
==============================================================================
--- branches/relax_disp/specific_fns/relax_disp.py (original)
+++ branches/relax_disp/specific_fns/relax_disp.py Thu Jan  8 20:13:00 2009
@@ -173,7 +173,7 @@
     def cpmg_frq(self, frq=0, spectrum_id=None):
         """Set the CPMG frequency associated with a given spectrum.
 
-        @keyword frq:           The frequency, in Hz, of the CPMG train.
+        @keyword frq:           The frequency, in Hz, of the CPMG pulse 
train.
         @type frq:              int
         @keyword spectrum_id:   The spectrum identification string.
         @type spectrum_id:      str