Source Code for Module specific_analyses.noe.parameter_object

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2010,2014 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 6  #                                                                             # 
 7  # This program is free software: you can redistribute it and/or modify        # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation, either version 3 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # This program is distributed in the hope that it will be useful,             # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
19  #                                                                             # 
20  ############################################################################### 
21   
22  # Module docstring. 
23  """The module for the steady-state heteronuclear NOE parameter list object.""" 
24   
25  # relax module imports. 
26  from specific_analyses.parameter_object import Param_list 
27   
28   
29 -class Noe_params(Param_list): 
30      """The steady-state heteronuclear NOE parameter list singleton.""" 
31   
32      # Class variable for storing the class instance (for the singleton design pattern). 
33      _instance = None 
34   
35 -    def __init__(self): 
36          """Define all the parameters of the analysis.""" 
37   
38          # The object is already initialised. 
39          if self._initialised: return 
40   
41          # Execute the base class __init__ method. 
42          Param_list.__init__(self) 
43   
44          # Add the base data. 
45          self._add_peak_intensity() 
46   
47          # Add the signal to noise ratio. 
48          self._add_sn_ratio() 
49   
50          # Add the single model parameter. 
51          self._add( 
52              'noe', 
53              scope = 'spin', 
54              desc = 'The steady-state NOE value', 
55              py_type = float, 
56              set = 'params', 
57              grace_string = '\\qNOE\\Q', 
58              err = True, 
59              sim = True 
60          ) 
61   
62          # Set up the user function documentation. 
63          self._set_uf_title("Steady-state NOE parameters") 
64          self._uf_param_table(label="table: NOE parameters", caption="Steady-state NOE parameters.") 
65