r21805 - /trunk/user_functions/spectrum.py -- December 06, 2013 - 09:16

Author: tlinnet
Date: Fri Dec  6 09:16:21 2013
New Revision: 21805

URL: http://svn.gna.org/viewcvs/relax?rev=21805&view=rev
Log:
Added keyword dim to frontend function for spectrum.read_spins().

Work in progress for Support Request #3044, 
(https://gna.org/support/index.php?3044) - Load spins from SPARKY list.

This is associate data with the spins of up to two dimensions.

Modified:
    trunk/user_functions/spectrum.py

Modified: trunk/user_functions/spectrum.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/spectrum.py?rev=21805&r1=21804&r2=21805&view=diff
==============================================================================
--- trunk/user_functions/spectrum.py (original)
+++ trunk/user_functions/spectrum.py Fri Dec  6 09:16:21 2013
@@ -384,6 +384,14 @@
     can_be_none = True
 )
 uf.add_keyarg(
+    name = "dim",
+    default = 1,
+    py_type = "int",
+    min = 1,
+    desc_short = "spectral dimension to read",
+    desc = "Associate the data with the spins of any dimension in the peak 
list.  This defaults to w1, the heteronucleus in HSQC type experiments."
+)
+uf.add_keyarg(
     name = "spin_id_col",
     py_type = "int",
     arg_type = "free format",
@@ -446,6 +454,9 @@
     desc = "The spin ID string used to restrict the loading of data to 
certain spin subsets.",
     can_be_none = True
 )
+# Description.
+uf.desc.append(Desc_container())
+uf.desc[-1].add_paragraph("The spectral dimension is used to specify if the 
intensity data should be loaded into the spins identified by the first 
dimension w1, second dimension w2, etc.")
 # File formats.
 uf.desc.append(Desc_container("File formats"))
 uf.desc[-1].add_paragraph("The peak list or intensity file will be 
automatically determined.")