r22041 - /trunk/lib/geometry/vectors.py -- January 23, 2014 - 14:28

Author: bugman
Date: Thu Jan 23 14:27:58 2014
New Revision: 22041

URL: http://svn.gna.org/viewcvs/relax?rev=22041&view=rev
Log:
Created the lib.geometry.vectors.unit_vector_from_2point() function.

This is used to quickly calculate the unit vector between two points.


Modified:
    trunk/lib/geometry/vectors.py

Modified: trunk/lib/geometry/vectors.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/lib/geometry/vectors.py?rev=22041&r1=22040&r2=22041&view=diff
==============================================================================
--- trunk/lib/geometry/vectors.py (original)
+++ trunk/lib/geometry/vectors.py Thu Jan 23 14:27:58 2014
@@ -1,6 +1,6 @@
 
###############################################################################
 #                                                                            
 #
-# Copyright (C) 2004-2013 Edward d'Auvergne                                  
 #
+# Copyright (C) 2004-2014 Edward d'Auvergne                                  
 #
 #                                                                            
 #
 # This file is part of the program relax (http://www.nmr-relax.com).         
 #
 #                                                                            
 #
@@ -24,6 +24,8 @@
 
 # Python module imports.
 from math import acos, cos, pi, sin
+from numpy import array, float64
+from numpy.linalg import norm
 from random import uniform
 
 
@@ -48,3 +50,25 @@
     vector[0] = cos(theta) * sin(phi)
     vector[1] = sin(theta) * sin(phi)
     vector[2] = cos(phi)
+
+
+def unit_vector_from_2point(point1, point2):
+    """Generate the unit vector connecting point 1 to point 2.
+
+    @param point1:  The first point.
+    @type point1:   list of float or numpy array
+    @param point2:  The second point.
+    @type point2:   list of float or numpy array
+    @return:        The unit vector.
+    @rtype:         numpy float64 array
+    """
+
+    # Convert to numpy data structures.
+    point1 = array(point1, float64)
+    point2 = array(point2, float64)
+
+    # The vector.
+    vect = point2 - point1
+
+    # Return the unit vector.
+    return vect / norm(vect)