Source Code for Module user_functions.frq'

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2008-2012 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  """The frq user function definitions for manipulating spectrometer frequencies.""" 
24   
25  # relax module imports. 
26  import generic_fns.frq 
27  from graphics import WIZARD_IMAGE_PATH 
28  from user_functions.data import Uf_info; uf_info = Uf_info() 
29  from user_functions.objects import Desc_container 
30   
31   
32  # The user function class. 
33  uf_class = uf_info.add_class('frq') 
34  uf_class.title = "Class for manipulating spectrometer frequencies." 
35  uf_class.menu_text = "&frq" 
36  uf_class.gui_icon = "relax.frq" 
37   
38  # The frq.set user function. 
39  uf = uf_info.add_uf('frq.set') 
40  uf.title = "Set the spectrometer frequency of the experiment." 
41  uf.title_short = "Spectrometer frequency setting." 
42  uf.add_keyarg( 
43      name = "id", 
44      py_type = "str", 
45      desc_short = "experiment ID", 
46      desc = "The experiment identification string." 
47  ) 
48  uf.add_keyarg( 
49      name = "frq", 
50      py_type = "num", 
51      desc_short = "spectrometer frequency", 
52      desc = "The spectrometer frequency in Hertz." 
53  ) 
54  # Description. 
55  uf.desc.append(Desc_container()) 
56  uf.desc[-1].add_paragraph("This allows the spectrometer frequency of a given experiment to be set.") 
57  uf.backend = generic_fns.frq.set 
58  uf.menu_text = "&set" 
59  uf.gui_icon = "oxygen.actions.edit-rename" 
60  uf.wizard_size = (700, 400) 
61