r21493 - /trunk/pipe_control/sequence.py -- November 17, 2013 - 20:40

Author: bugman
Date: Sun Nov 17 20:40:51 2013
New Revision: 21493

URL: http://svn.gna.org/viewcvs/relax?rev=21493&view=rev
Log:
Created the pipe_control.sequence.return_attached_protons() function.

This is used to return a list of proton spin containers attached to the given 
spin.


Modified:
    trunk/pipe_control/sequence.py

Modified: trunk/pipe_control/sequence.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/pipe_control/sequence.py?rev=21493&r1=21492&r2=21493&view=diff
==============================================================================
--- trunk/pipe_control/sequence.py (original)
+++ trunk/pipe_control/sequence.py Sun Nov 17 20:40:51 2013
@@ -355,6 +355,41 @@
     write_spin_data(sys.stdout, mol_names=mol_names, res_nums=res_nums, 
res_names=res_names, spin_nums=spin_nums, spin_names=spin_names)
 
 
+def return_attached_protons(spin_id=None):
+    """Return a list of all proton spin containers attached to the given 
spin.
+
+    @keyword spin_id:   The spin ID string.
+    @type spin_id:      str
+    @return:            The list of proton spin containers attached to the 
given spin.
+    @rtype:             list of SpinContainer instances
+    """
+
+    # Initialise.
+    spin_list = []
+
+    # Get all interatomic data containers.
+    interatoms = return_interatom_list(spin_id)
+
+    # No containers.
+    if not len(interatoms):
+        return spin_list
+
+    # Loop over the containers.
+    for i in range(len(interatoms)):
+        # Get the attached spin.
+        if interatoms[i].spin_id1 == spin_id
+            attached = return_spin(interatoms[i].spin_id2)
+        else:
+            attached = return_spin(interatoms[i].spin_id1)
+
+        # Is it a proton?
+        if (hasattr(attached, 'element') and attached.element == 'H') or 
attached.name == 'H':
+            spin_list.append(attached)
+
+    # Return the list.
+    return spin_list
+
+
 def validate_sequence(data, 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):
     """Test if the sequence data is valid.