r25784 - /trunk/specific_analyses/api_base.py -- September 12, 2014 - 14:03

Author: bugman
Date: Fri Sep 12 14:02:59 2014
New Revision: 25784

URL: http://svn.gna.org/viewcvs/relax?rev=25784&view=rev
Log:
Created the specific analysis base API method covariance_matrix().

This defines the arguments required and what is returned by the method.  It 
raises the
RelaxImplementError for all analyses which do not implement this method.


Modified:
    trunk/specific_analyses/api_base.py

Modified: trunk/specific_analyses/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/api_base.py?rev=25784&r1=25783&r2=25784&view=diff
==============================================================================
--- trunk/specific_analyses/api_base.py (original)
+++ trunk/specific_analyses/api_base.py Fri Sep 12 14:02:59 2014
@@ -136,6 +136,21 @@
 
         # The default.
         return 'Method of Multipliers'
+
+
+    def covariance_matrix(self, model_info=None, verbosity=1):
+        """Return the Jacobian and weights required for parameter errors via 
the covariance matrix.
+
+        @keyword model_info:    The model information from model_loop().
+        @type model_info:       unknown
+        @keyword verbosity:     The amount of information to print.  The 
higher the value, the greater the verbosity.
+        @type verbosity:        int
+        @return:                The Jacobian and weight matrices for the 
given model.
+        @rtype:                 numpy rank-2 array, numpy rank-2 array
+        """
+
+        # Not implemented.
+        raise RelaxImplementError('covariance_matrix')
 
 
     def create_mc_data(self, data_id=None):