r19189 - in /branches/relax_disp: specific_analyses/relax_disp.py user_functions/relax_disp.py -- March 27, 2013 - 13:58

Author: bugman
Date: Wed Mar 27 13:58:48 2013
New Revision: 19189

URL: http://svn.gna.org/viewcvs/relax?rev=19189&view=rev
Log:
Ported r8343 from the old relax_disp branch into the new branch.

The command used was:
svn merge -r8342:8343 
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/branches/relax_disp/specific_fns/@r18123
 specific_analyses

The user function code was ported manually from the prompt package changes to 
the user_functions
package.

.....
  r8343 | semor | 2009-01-08 20:13:00 +0100 (Thu, 08 Jan 2009) | 3 lines
  Changed paths:
     M /branches/relax_disp/prompt/relax_disp.py
     M /branches/relax_disp/specific_fns/relax_disp.py
  
  Added the user function cpmg_frq() and added examples to the user function 
cpmg_delayT().
.....


Modified:
    branches/relax_disp/specific_analyses/relax_disp.py
    branches/relax_disp/user_functions/relax_disp.py

Modified: branches/relax_disp/specific_analyses/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/specific_analyses/relax_disp.py?rev=19189&r1=19188&r2=19189&view=diff
==============================================================================
--- branches/relax_disp/specific_analyses/relax_disp.py (original)
+++ branches/relax_disp/specific_analyses/relax_disp.py Wed Mar 27 13:58:48 
2013
@@ -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

Modified: branches/relax_disp/user_functions/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/user_functions/relax_disp.py?rev=19189&r1=19188&r2=19189&view=diff
==============================================================================
--- branches/relax_disp/user_functions/relax_disp.py (original)
+++ branches/relax_disp/user_functions/relax_disp.py Wed Mar 27 13:58:48 2013
@@ -57,8 +57,45 @@
 # Description.
 uf.desc.append(Desc_container())
 uf.desc[-1].add_paragraph("This allows the CPMG constant time delay (T) of a 
given experiment to be set.")
+# Prompt examples.
+uf.desc.append(Desc_container("Prompt examples"))
+uf.desc[-1].add_paragraph("To set a CPMG constant time delay T of 20 ms 
(0.020 s) for experiments '600', type one of:")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_delayT('600', 0.020)")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_delayT(id='600', 
delayT=0.020)")
 uf.backend = relax_disp_obj._cpmg_delayT
 uf.menu_text = "&cpmg_delayT"
+uf.wizard_size = (800, 500)
+
+
+# The relax_disp.cpmg_frq user function.
+uf = uf_info.add_uf('relax_disp.cpmg_frq')
+uf.title = "Set the CPMG frequency associated with a given spectrum."
+uf.title_short = "CPMG frequency setting."
+uf.add_keyarg(
+    name = "frq",
+    py_type = "float",
+    desc_short = "frequency (Hz)",
+    desc = "The frequency, in Hz, of the CPMG pulse train."
+)
+uf.add_keyarg(
+    name = "spectrum_id",
+    py_type = "str",
+    desc_short = "spectrum ID string",
+    desc = "The spectrum ID string."
+)
+# Description.
+uf.desc.append(Desc_container())
+uf.desc[-1].add_paragraph("This 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.")
+# Prompt examples.
+uf.desc.append(Desc_container("Prompt examples"))
+uf.desc[-1].add_paragraph("To identify the reference spectrum called 
'reference_spectrum', type one of:")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_frq(0, 'reference_spectrum')")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_frq(frq=0, 
spectrum_id='reference_spectrum')")
+uf.desc[-1].add_paragraph("To set a frequency of 200 Hz for the spectrum 
'200_Hz_spectrum', type one of:")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_frq(200, '200_Hz_spectrum')")
+uf.desc[-1].add_prompt("relax> relax_disp.cpmg_frq(frq=200, 
spectrum_id='200_Hz_spectrum')")
+uf.backend = relax_disp_obj._cpmg_frq
+uf.menu_text = "&cpmg_frq"
 uf.wizard_size = (800, 500)