r27218 - /trunk/specific_analyses/api_base.py -- January 17, 2015 - 17:25

Author: tlinnet
Date: Sat Jan 17 17:25:18 2015
New Revision: 27218

URL: http://svn.gna.org/viewcvs/relax?rev=27218&view=rev
Log:
Adding empty API method to return errors from the reduced chi2 distribution.

Task #7882 (https://gna.org/task/?7882): Implement Monte-Carlo simulation, 
where errors are generated with width of standard deviation or residuals.): 
Implement Monte-Carlo simulation, where errors are generated with width of 
standard deviation or residuals.

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=27218&r1=27217&r2=27218&view=diff
==============================================================================
--- trunk/specific_analyses/api_base.py (original)
+++ trunk/specific_analyses/api_base.py Sat Jan 17 17:25:18 2015
@@ -596,6 +596,19 @@
         raise RelaxImplementError('return_error')
 
 
+    def return_error_red_chi2(self, data_id=None):
+        """Return the error points corresponding to the overall gauss 
distribution described by the STD_fit of the goodness of fit, where STD_fit = 
sqrt(chi2/(N-p)).
+
+        @keyword data_id:   The data identification information, as yielded 
by the base_data_loop() generator method.
+        @type data_id:      anything
+        @return:            The array of data error values.
+        @rtype:             list of float
+        """
+
+        # Not implemented.
+        raise RelaxImplementError('return_error_red_chi2')
+
+
     def return_grace_string(self, param):
         """Return the Grace string representation of the parameter.