Source Code for Module prompt.consistency_tests

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2004-2005, 2009-2010 Edward d'Auvergne                        # 
 4  # Copyright (C) 2007-2008 Sebastien Morin                                     # 
 5  #                                                                             # 
 6  # This file is part of the program relax.                                     # 
 7  #                                                                             # 
 8  # relax is free software; you can redistribute it and/or modify               # 
 9  # it under the terms of the GNU General Public License as published by        # 
10  # the Free Software Foundation; either version 2 of the License, or           # 
11  # (at your option) any later version.                                         # 
12  #                                                                             # 
13  # relax is distributed in the hope that it will be useful,                    # 
14  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
15  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
16  # GNU General Public License for more details.                                # 
17  #                                                                             # 
18  # You should have received a copy of the GNU General Public License           # 
19  # along with relax; if not, write to the Free Software                        # 
20  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
21  #                                                                             # 
22  ############################################################################### 
23   
24  # Module docstring. 
25  """Module containing the 'consistency_tests' user function class.""" 
26  __docformat__ = 'plaintext' 
27   
28  # Python module imports. 
29   
30  # relax module imports. 
31  from base_class import User_fn_class 
32  import arg_check 
33  from specific_fns.setup import consistency_tests_obj 
34   
35   
36 -class Consistency_tests(User_fn_class): 
37      """Class containing functions specific to consistency tests for datasets from different fields.""" 
38   
39 -    def set_frq(self, frq=None): 
40          """Function for selecting which relaxation data to use in the consistency tests. 
41   
42          Keyword Arguments 
43          ~~~~~~~~~~~~~~~~~ 
44   
45          frq:  The spectrometer frequency in Hz. 
46   
47   
48          Description 
49          ~~~~~~~~~~~ 
50   
51          This function will select the relaxation data to use in the consistency tests corresponding 
52          to the given frequencies. 
53   
54   
55          Examples 
56          ~~~~~~~~ 
57   
58          relax> consistency_tests.set_frq(600.0 * 1e6) 
59          relax> consistency_tests.set_frq(frq=600.0 * 1e6) 
60          """ 
61   
62          # Function intro text. 
63          if self._exec_info.intro: 
64              text = self._exec_info.ps3 + "consistency_tests.set_frq(" 
65              text = text + "frq=" + repr(frq) + ")" 
66              print(text) 
67   
68          # The argument checks. 
69          arg_check.is_num(frq, 'spectrometer frequency') 
70   
71          # Execute the functional code. 
72          consistency_tests_obj._set_frq(frq=frq) 
73