Source Code for Module prompt.jw_mapping

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2004-2005, 2009-2010 Edward d'Auvergne                        # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax 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 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax 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 relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Module docstring. 
24  """Module containing the Reduced Spectral Density Mapping 'jw_mapping' user function class.""" 
25  __docformat__ = 'plaintext' 
26   
27  # relax module imports. 
28  from base_class import User_fn_class 
29  import arg_check 
30  from specific_fns.setup import jw_mapping_obj 
31   
32   
33 -class Jw_mapping(User_fn_class): 
34      """Class containing functions specific to reduced spectral density mapping.""" 
35   
36 -    def set_frq(self, frq=None): 
37          """Function for selecting which relaxation data to use in the J(w) mapping. 
38   
39          Keyword Arguments 
40          ~~~~~~~~~~~~~~~~~ 
41   
42          frq:  The spectrometer frequency in Hz. 
43   
44   
45          Description 
46          ~~~~~~~~~~~ 
47   
48          This function will select the relaxation data to use in the reduced spectral density mapping 
49          corresponding to the given frequency. 
50   
51   
52          Examples 
53          ~~~~~~~~ 
54   
55          relax> jw_mapping.set_frq(600.0 * 1e6) 
56          relax> jw_mapping.set_frq(frq=600.0 * 1e6) 
57          """ 
58   
59          # Function intro text. 
60          if self._exec_info.intro: 
61              text = self._exec_info.ps3 + "jw_mapping.set_frq(" 
62              text = text + "frq=" + repr(frq) + ")" 
63              print(text) 
64   
65          # The argument checks. 
66          arg_check.is_num(frq, 'spectrometer frequency') 
67   
68          # Execute the functional code. 
69          jw_mapping_obj._set_frq(frq=frq) 
70