Package specific_analyses :: Package consistency_tests :: Module uf
[hide private]
[frames] | no frames]

Source Code for Module specific_analyses.consistency_tests.uf

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2004-2014 Edward d'Auvergne                                   # 
 4  # Copyright (C) 2007-2009 Sebastien Morin                                     # 
 5  #                                                                             # 
 6  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 7  #                                                                             # 
 8  # This program 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 3 of the License, or           # 
11  # (at your option) any later version.                                         # 
12  #                                                                             # 
13  # This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.       # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Module docstring. 
24  """The consistency testing analysis user functions.""" 
25   
26  # relax module imports. 
27  from lib.errors import RelaxError, RelaxFuncSetupError 
28  from pipe_control import pipes 
29  import specific_analyses 
30   
31   
32 -def set_frq(frq=None):
33 """Function for selecting which relaxation data to use in the consistency tests.""" 34 35 # Test if the current pipe exists. 36 pipes.test() 37 38 # Test if the pipe type is set to 'ct'. 39 function_type = cdp.pipe_type 40 if function_type != 'ct': 41 raise RelaxFuncSetupError(specific_analyses.setup.get_string(function_type)) 42 43 # Test if the frequency has been set. 44 if hasattr(cdp, 'ct_frq'): 45 raise RelaxError("The frequency for the run has already been set.") 46 47 # Create the data structure if it doesn't exist. 48 if not hasattr(cdp, 'ct_frq'): 49 cdp.ct_frq = {} 50 51 # Set the frequency. 52 cdp.ct_frq = frq
53