Source Code for Module specific_analyses.noe.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 steady-state heteronuclear NOE specific user functions.""" 
24   
25  # relax module imports. 
26  from lib.errors import RelaxError 
27  from pipe_control import pipes 
28   
29   
30 -def spectrum_type(spectrum_type=None, spectrum_id=None): 
31      """Set the spectrum type corresponding to the spectrum_id. 
32   
33      @keyword spectrum_type: The type of NOE spectrum, one of 'ref' or 'sat'. 
34      @type spectrum_type:    str 
35      @keyword spectrum_id:   The spectrum id string. 
36      @type spectrum_id:      str 
37      """ 
38   
39      # Test if the current pipe exists 
40      pipes.test() 
41   
42      # Test the spectrum id string. 
43      if spectrum_id not in cdp.spectrum_ids: 
44          raise RelaxError("The peak intensities corresponding to the spectrum id '%s' does not exist." % spectrum_id) 
45   
46      # Initialise or update the spectrum_type data structure as necessary. 
47      if not hasattr(cdp, 'spectrum_type'): 
48          cdp.spectrum_type = {} 
49   
50      # Set the error. 
51      cdp.spectrum_type[spectrum_id] = spectrum_type 
52