r4001 - /branches/N_state_model/generic_fns/align_tensor.py -- November 26, 2007 - 13:28

Author: bugman
Date: Mon Nov 26 12:41:53 2007
New Revision: 4001

URL: http://svn.gna.org/viewcvs/relax?rev=4001&view=rev
Log:
Fixed the generic_fns.align_tensor.init() args and docstring.


Modified:
    branches/N_state_model/generic_fns/align_tensor.py

Modified: branches/N_state_model/generic_fns/align_tensor.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/N_state_model/generic_fns/align_tensor.py?rev=4001&r1=4000&r2=4001&view=diff
==============================================================================
--- branches/N_state_model/generic_fns/align_tensor.py (original)
+++ branches/N_state_model/generic_fns/align_tensor.py Mon Nov 26 12:41:53 
2007
@@ -425,30 +425,21 @@
                 cdp.diff_tensor.gamma_sim[sim_index] = 
cdp.diff_tensor.gamma_sim[sim_index] + pi
 
 
-def init(params=None, time_scale=1.0, d_scale=1.0, angle_units='deg', 
param_types=0, spheroid_type=None, fixed=1):
+def init(params=None, scale=1.0, angle_units='deg', param_types=0, errors=0):
     """Function for initialising the alignment tensor.
 
     @param params:          The alignment tensor parameters.
     @type params:           float
-    @param time_scale:      The correlation time scaling value.
-    @type time_scale:       float
-    @param d_scale:         The alignment tensor eigenvalue scaling value.
-    @type d_scale:          float
-    @param angle_units:     The units for the angle parameters.
-    @type angle_units:      str (either 'deg' or 'rad')
-    @param param_types:     The type of parameters supplied.  For spherical 
alignment, the flag
-                            values correspond to 0: tm, 1: Diso.  For 
spheroidal alignment, 0: {tm,
-                            Da, theta, phi}, 1: {Diso, Da, theta, phi}, 2: 
{tm, Dratio, theta, phi},
-                            3:  {Dpar, Dper, theta, phi}, 4: {Diso, Dratio, 
theta, phi}.  For
-                            ellipsoidal alignment, 0: {tm, Da, Dr, alpha, 
beta, gamma}, 1: {Diso,
-                            Da, Dr, alpha, beta, gamma}, 2: {Dx, Dy, Dz, 
alpha, beta, gamma}.
+    @param scale:           The alignment tensor eigenvalue scaling value.
+    @type scale:            float
+    @param angle_units:     The units for the angle parameters (either 'deg' 
or 'rad').
+    @type angle_units:      str
+    @param param_types:     The type of parameters supplied.  The flag 
values correspond to, 0:
+                            {Axx, Ayy, Axy, Axz, Ayz}, and 1: {Azz, Axx-yy, 
Axy, Axz, Ayz}.
     @type param_types:      int
-    @param spheroid_type:   A string which, if supplied together with 
spheroid parameters, will
-                            restrict the tensor to either being 'oblate' or 
'prolate'.
-    @type spheroid_type:    str
-    @param fixed:           A flag specifying whether the alignment tensor 
is fixed or can be
-                            optimised.
-    @type fixed:            bin
+    @param errors:          A flag which determines if the alignment tensor 
data or its errors are
+                            being input.
+    @type errors:           bin
     """
 
     # Test if the current data pipe exists.