r18386 - /trunk/data/diff_tensor.py -- February 02, 2013 - 11:58

Author: bugman
Date: Sat Feb  2 11:58:42 2013
New Revision: 18386

URL: http://svn.gna.org/viewcvs/relax?rev=18386&view=rev
Log:
Epydoc docstring fixes for the diffusion tensor objects of the relax data 
store.


Modified:
    trunk/data/diff_tensor.py

Modified: trunk/data/diff_tensor.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/data/diff_tensor.py?rev=18386&r1=18385&r2=18386&view=diff
==============================================================================
--- trunk/data/diff_tensor.py (original)
+++ trunk/data/diff_tensor.py Sat Feb  2 11:58:42 2013
@@ -1,6 +1,6 @@
 
###############################################################################
 #                                                                            
 #
-# Copyright (C) 2003-2012 Edward d'Auvergne                                  
 #
+# Copyright (C) 2003-2013 Edward d'Auvergne                                  
 #
 #                                                                            
 #
 # This file is part of the program relax (http://www.nmr-relax.com).         
 #
 #                                                                            
 #
@@ -320,18 +320,8 @@
            =  | Dx_unit[1]  Dy_unit[1]  Dz_unit[1] |.
               | Dx_unit[2]  Dy_unit[2]  Dz_unit[2] |
 
-    @param args:        All the function arguments.
+    @param args:        All the function arguments.  For the spheroid, this 
includes the spheroid_type (str), the azimuthal angle theta in radians 
(float), and the polar angle phi in radians (float).  For the ellipsoid, this 
includes the Dx unit vector (numpy 3D, rank-1 array), the Dy unit vector 
(numpy 3D, rank-1 array), and the Dz unit vector (numpy 3D, rank-1 array).
     @type args:         tuple
-    @param theta:       The azimuthal angle in radians.
-    @type theta:        float
-    @param phi:         The polar angle in radians.
-    @type phi:          float
-    @param Dx_unit:     The Dx unit vector.
-    @type Dx_unit:      numpy array
-    @param Dy_unit:     The Dy unit vector.
-    @type Dy_unit:      numpy array
-    @param Dz_unit:     The Dz unit vector.
-    @type Dz_unit:      numpy array
     @return:            The rotation matrix.
     @rtype:             numpy 3x3 array
     """
@@ -457,20 +447,8 @@
         tensor  =  |  0  Dy   0 |.
                    |  0   0  Dz |
 
-    @param args:    All the arguments.
+    @param args:    All the arguments.  For the sphere, this includes the 
Diso parameter (float).  For the spheroid, this includes Dpar and Dper 
parameters (floats).  For the ellipsoid, this includes the Dx, Dy, and Dz 
parameters (floats).
     @type args:     tuple
-    @param Diso:    The Diso parameter of the sphere.
-    @type Diso:     float
-    @param Dpar:    The Dpar parameter of the spheroid.
-    @type Dpar:     float
-    @param Dper:    The Dper parameter of the spheroid.
-    @type Dper:     float
-    @param Dx:      The Dx parameter of the ellipsoid.
-    @type Dx:       float
-    @param Dy:      The Dy parameter of the ellipsoid.
-    @type Dy:       float
-    @param Dz:      The Dz parameter of the ellipsoid.
-    @type Dz:       float
     @return:        The diagonalised diffusion tensor.
     @rtype:         numpy 3x3 array
     """