r23527 - /branches/disp_speed/specific_analyses/parameter_object.py -- May 28, 2014 - 16:49

Author: tlinnet
Date: Wed May 28 16:49:02 2014
New Revision: 23527

URL: http://svn.gna.org/viewcvs/relax?rev=23527&view=rev
Log:
Added grid_lower to be handled in specific_analyses/parameter_object.py.

This is related to: task #7793: (https://gna.org/task/?7793) Speed-up of 
dispersion models.
Discussed in post http://thread.gmane.org/gmane.science.nmr.relax.devel/5986.

Modified:
    branches/disp_speed/specific_analyses/parameter_object.py

Modified: branches/disp_speed/specific_analyses/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/disp_speed/specific_analyses/parameter_object.py?rev=23527&r1=23526&r2=23527&view=diff
==============================================================================
--- branches/disp_speed/specific_analyses/parameter_object.py   (original)
+++ branches/disp_speed/specific_analyses/parameter_object.py   Wed May 28 
16:49:02 2014
@@ -54,6 +54,7 @@
         self._scope = {}
         self._string = {}
         self._defaults = {}
+        self._grid_lowers = {}
         self._units = {}
         self._desc = {}
         self._py_types = {}
@@ -92,7 +93,7 @@
         return cls._instance
 
 
-    def _add(self, name, scope=None, string=None, default=None, units=None, 
desc=None, py_type=None, set='all', conv_factor=None, grace_string=None, 
err=False, sim=False):
+    def _add(self, name, scope=None, string=None, default=None, 
grid_lower=None, units=None, desc=None, py_type=None, set='all', 
conv_factor=None, grace_string=None, err=False, sim=False):
         """Add a parameter to the list.
 
         @param name:            The name of the parameter.  This will be 
used as the variable name.
@@ -103,6 +104,8 @@
         @type string:           None or str
         @keyword default:       The default value of the parameter.
         @type default:          anything
+        @keyword grid_lower:    The default lower bounds of the grid search.
+        @type grid_lower:       float
         @keyword units:         A string representing the parameters units.
         @type units:            None or str
         @keyword desc:          The text description of the parameter.
@@ -134,6 +137,7 @@
         self._names.append(name)
         self._scope[name] = scope
         self._defaults[name] = default
+        self._grid_lowers[name] = grid_lower
         self._units[name] = units
         self._desc[name] = desc
         self._py_types[name] = py_type
@@ -540,6 +544,22 @@
         return self._grace_string[name]
 
 
+    def grid_lower(self, name):
+        """Return the default lower bounds of paramater for the grid search.
+
+        @param name:    The name of the parameter.
+        @type name:     str
+        @return:        The default value.
+        @rtype:         None or str
+        """
+
+        # Parameter check.
+        self.check_param(name)
+
+        # Return the default value.
+        return self._grid_lowers[name]
+
+
     def is_spin_param(self, name):
         """Determine whether the given parameter is spin specific.