Source Code for Module specific_analyses.consistency_tests.uf

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2002-2005,2007-2010,2012-2014 Edward d'Auvergne               # 
 4  # Copyright (C) 2006 Chris MacRaild                                           # 
 5  # Copyright (C) 2007-2008 Sebastien Morin                                     # 
 6  #                                                                             # 
 7  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 8  #                                                                             # 
 9  # This program is free software: you can redistribute it and/or modify        # 
10  # it under the terms of the GNU General Public License as published by        # 
11  # the Free Software Foundation, either version 3 of the License, or           # 
12  # (at your option) any later version.                                         # 
13  #                                                                             # 
14  # This program is distributed in the hope that it will be useful,             # 
15  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
16  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
17  # GNU General Public License for more details.                                # 
18  #                                                                             # 
19  # You should have received a copy of the GNU General Public License           # 
20  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
21  #                                                                             # 
22  ############################################################################### 
23   
24  # Module docstring. 
25  """The consistency testing analysis user functions.""" 
26   
27  # relax module imports. 
28  from lib.errors import RelaxError, RelaxFuncSetupError 
29  from pipe_control.pipes import check_pipe 
30  import specific_analyses 
31   
32   
33 -def set_frq(frq=None): 
34      """Function for selecting which relaxation data to use in the consistency tests.""" 
35   
36      # Test if the current pipe exists. 
37      check_pipe() 
38   
39      # Test if the pipe type is set to 'ct'. 
40      function_type = cdp.pipe_type 
41      if function_type != 'ct': 
42          raise RelaxFuncSetupError(specific_analyses.setup.get_string(function_type)) 
43   
44      # Test if the frequency has been set. 
45      if hasattr(cdp, 'ct_frq'): 
46          raise RelaxError("The frequency for the run has already been set.") 
47   
48      # Create the data structure if it doesn't exist. 
49      if not hasattr(cdp, 'ct_frq'): 
50          cdp.ct_frq = {} 
51   
52      # Set the frequency. 
53      cdp.ct_frq = frq 
54