r9079 - /branches/frame_order/maths_fns/frame_order_models.py -- June 18, 2009 - 10:47

Author: bugman
Date: Thu Jun 18 10:47:30 2009
New Revision: 9079

URL: http://svn.gna.org/viewcvs/relax?rev=9079&view=rev
Log:
A few fixes for the Frame_order class.


Modified:
    branches/frame_order/maths_fns/frame_order_models.py

Modified: branches/frame_order/maths_fns/frame_order_models.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/frame_order/maths_fns/frame_order_models.py?rev=9079&r1=9078&r2=9079&view=diff
==============================================================================
--- branches/frame_order/maths_fns/frame_order_models.py (original)
+++ branches/frame_order/maths_fns/frame_order_models.py Thu Jun 18 10:47:30 
2009
@@ -36,13 +36,19 @@
 class Frame_order:
     """Class containing the target function of the optimisation of Frame 
Order matrix components."""
 
-    def __init__(self, frame_order_matrix=None):
-        """Set up the target functions for the Frame Order theories."""
+    def __init__(self, frame_order_2nd=None):
+        """Set up the target functions for the Frame Order theories.
+        
+        @keyword frame_order_2nd:   The numerical values of the 2nd degree 
Frame Order matrix.  If
+                                    supplied, the target functions will 
optimise directly to these
+                                    values.
+        @type frame_order_2nd:      None or numpy 9D, rank-2 array
+        """
 
         # Optimisation to the 2nd degree Frame Order matrix components 
directly.
-        if frame_order_matrix:
+        if frame_order_2nd != None:
             # Store the real matrix components.
-            self.data = data
+            self.data = frame_order_2nd
 
             # The errors.
             self.errors = ones((9, 9), float64)
@@ -62,7 +68,9 @@
         super matrix.  The Frame Order eigenframe via the alpha, beta, and 
gamma Euler angles, and
         the cone angle theta are the 4 parameters optimised in this model.
 
-        @param params:  The vector of parameter values.
+        @param params:  The vector of parameter values {alpha, beta, gamma, 
theta} where the first
+                        three are the Euler angles for the Frame Order 
eigenframe and theta is the
+                        isotropic cone angle.
         @type params:   list of float
         @return:        The chi-squared or SSE value.
         @rtype:         float