r9924 - /1.3/specific_fns/api_base.py -- November 24, 2009 - 15:26

Author: bugman
Date: Tue Nov 24 15:26:08 2009
New Revision: 9924

URL: http://svn.gna.org/viewcvs/relax?rev=9924&view=rev
Log:
Added model_statistics() to the specific analysis API.


Modified:
    1.3/specific_fns/api_base.py

Modified: 1.3/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=9924&r1=9923&r2=9924&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Tue Nov 24 15:26:08 2009
@@ -252,6 +252,28 @@
             yield spin
 
 
+    def model_statistics(self, instance=None, spin_id=None, 
global_stats=None):
+        """Prototype method for returning the k, n, and chi2 model 
statistics.
+
+        k - number of parameters.
+        n - number of data points.
+        chi2 - the chi-squared value.
+
+
+        @keyword instance:      This is the optimisation instance index.  
This should always be the value of 1 for the N-state model.  As it is 
ignored, this arg can be anything.
+        @type instance:         None or int
+        @keyword spin_id:       The spin identification string.  This is 
ignored in the N-state model.
+        @type spin_id:          None or str
+        @keyword global_stats:  A parameter which determines if global or 
local statistics are returned.  For the N-state model, this argument is 
ignored.
+        @type global_stats:     None or bool
+        @return:                The optimisation statistics, in tuple 
format, of the number of parameters (k), the number of data points (n), and 
the chi-squared value (chi2).
+        @rtype:                 tuple of (int, int, float)
+        """
+
+        # Not implemented.
+        raise RelaxImplementError
+
+
     def num_instances(self):
         """Function for returning the number of instances.