Source Code for Module specific_analyses.jw_mapping.uf

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2004-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  """Module for all of the reduced spectral density mapping specific user functions.""" 
24   
25  # relax module imports. 
26  from lib.errors import RelaxError, RelaxFuncSetupError 
27  from pipe_control import pipes 
28  import specific_analyses 
29   
30   
31 -def set_frq(frq=None): 
32      """Function for selecting which relaxation data to use in the J(w) mapping.""" 
33   
34      # Test if the current pipe exists. 
35      pipes.test() 
36   
37      # Test if the pipe type is set to 'jw'. 
38      function_type = cdp.pipe_type 
39      if function_type != 'jw': 
40          raise RelaxFuncSetupError(specific_analyses.setup.get_string(function_type)) 
41   
42      # Test if the frequency has been set. 
43      if hasattr(cdp, 'jw_frq'): 
44          raise RelaxError("The frequency has already been set.") 
45   
46      # Create the data structure if it doesn't exist. 
47      if not hasattr(cdp, 'jw_frq'): 
48          cdp.jw_frq = {} 
49   
50      # Set the frequency. 
51      cdp.jw_frq = frq 
52