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