r5828 - /1.3/generic_fns/structure/main.py -- April 20, 2008 - 12:04

Author: bugman
Date: Sun Apr 20 12:04:22 2008
New Revision: 5828

URL: http://svn.gna.org/viewcvs/relax?rev=5828&view=rev
Log:
Added the unit arg to the vectors() fn.  This might be useful in the future.


Modified:
    1.3/generic_fns/structure/main.py

Modified: 1.3/generic_fns/structure/main.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/main.py?rev=5828&r1=5827&r2=5828&view=diff
==============================================================================
--- 1.3/generic_fns/structure/main.py (original)
+++ 1.3/generic_fns/structure/main.py Sun Apr 20 12:04:22 2008
@@ -194,7 +194,7 @@
     spin.xh_vect = xh_vect
 
 
-def vectors(proton=None, spin_id=None, verbosity=1):
+def vectors(proton=None, spin_id=None, verbosity=1, unit=True):
     """Function for calculating/extracting the XH unit vector from the 
loaded structure.
 
     @param proton:      The name of the proton attached to the spin, as 
given in the structural
@@ -204,6 +204,9 @@
     @type spin_id:      str
     @param verbosity:   The higher the value, the more information is 
printed to screen.
     @type verbosity:    int
+    @keyword unit:      A flag which if set will cause the function to 
return the unit XH vector
+                        rather than the full vector.
+    @type unit:         bool
     """
 
     # Alias the current data pipe.