r8165 - /branches/ave_noe/generic_fns/noesy.py -- December 09, 2008 - 10:30

Author: bugman
Date: Tue Dec  9 10:30:36 2008
New Revision: 8165

URL: http://svn.gna.org/viewcvs/relax?rev=8165&view=rev
Log:
Wrote a stub function generic_fns.noesy.read_constraints().


Modified:
    branches/ave_noe/generic_fns/noesy.py

Modified: branches/ave_noe/generic_fns/noesy.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/ave_noe/generic_fns/noesy.py?rev=8165&r1=8164&r2=8165&view=diff
==============================================================================
--- branches/ave_noe/generic_fns/noesy.py (original)
+++ branches/ave_noe/generic_fns/noesy.py Tue Dec  9 10:30:36 2008
@@ -24,3 +24,30 @@
 """Module for NOESY related operations."""
 
 
+def read_constraints(file=None, dir=None, proton1_col=None, 
proton2_col=None, lower_col=None, upper_col=None, sep=None):
+    """Load NOESY or ROESY constraint information from file.
+
+    If the input file is a pre-formatted Xplor file, the column number and 
separator arguments will
+    be ignored.
+
+
+    @keyword file:          The name of the file containing the relaxation 
data.
+    @type file:             str
+    @keyword dir:           The directory where the file is located.
+    @type dir:              None or str
+    @keyword proton1_col:   The column containing the first proton of the 
NOE or ROE cross peak.
+    @type proton1_col:      None or int
+    @keyword proton2_col:   The column containing the second proton of the 
NOE or ROE cross peak.
+    @type proton2_col:      None or int
+    @keyword lower_col:     The column containing the lower NOE bound.
+    @type lower_col:        None or int
+    @keyword upper_col:     The column containing the upper NOE bound.
+    @type upper_col:        None or int
+    @keyword sep:           The column separator (the default is white 
space).
+    @type sep:              None or str
+    """
+
+    # Test if the current data pipe exists.
+    pipes.test()
+
+