r9867 - /branches/bmrb/prompt/relax_data.py -- November 05, 2009 - 11:52

Author: bugman
Date: Thu Nov  5 11:52:27 2009
New Revision: 9867

URL: http://svn.gna.org/viewcvs/relax?rev=9867&view=rev
Log:
Added the interface for the relax_data.peak_intensity_type() user function.


Modified:
    branches/bmrb/prompt/relax_data.py

Modified: branches/bmrb/prompt/relax_data.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/prompt/relax_data.py?rev=9867&r1=9866&r2=9867&view=diff
==============================================================================
--- branches/bmrb/prompt/relax_data.py (original)
+++ branches/bmrb/prompt/relax_data.py Thu Nov  5 11:52:27 2009
@@ -197,6 +197,44 @@
 
         # Execute the functional code.
         relax_data.display(ri_label=ri_label, frq_label=frq_label)
+
+
+    def peak_intensity_type(self, ri_label=None, frq_label=None, type=None):
+        """Specify the type of peak intensity measurement used - i.e. height 
or volume.
+
+        Keyword Arguments
+        ~~~~~~~~~~~~~~~~~
+
+        ri_label:  The relaxation data type, ie 'R1', 'R2', or 'NOE'.
+
+        frq_label:  The field strength label.
+
+        type:  The peak intensity type.
+
+
+        Description
+        ~~~~~~~~~~~
+
+        This user function is essential for BMRB data deposition.  This is 
used to specify whether
+        peak heights or peak volumes were measured.  The two currently 
allowed values for the type
+        argument are 'height' and 'volume'.
+        """
+
+        # Function intro text.
+        if self.__relax__.interpreter.intro:
+            text = sys.ps3 + "relax_data.peak_intensity_type("
+            text = text + "ri_label=" + repr(ri_label)
+            text = text + ", frq_label=" + repr(frq_label)
+            text = text + ", type=" + repr(type) + ")"
+            print(text)
+
+        # The argument checks.
+        check.is_str(ri_label, 'relaxation label')
+        check.is_str(frq_label, 'frequency label')
+        check.is_str(type, 'peak intensity type')
+
+        # Execute the functional code.
+        relax_data.peak_intensity_type(ri_label=ri_label, 
frq_label=frq_label, type=type)
 
 
     def read(self, ri_label=None, frq_label=None, frq=None, file=None, 
dir=None, spin_id_col=None, mol_name_col=None, res_num_col=None, 
res_name_col=None, spin_num_col=None, spin_name_col=None, data_col=None, 
error_col=None, sep=None, spin_id=None):