1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23 """The frq user function definitions for manipulating spectrometer frequencies."""
24
25
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
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
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 uf.add_keyarg(
55 name = "units",
56 default = "Hz",
57 py_type = "str",
58 desc_short = "frequency units",
59 desc = "The units of frequency.",
60 wiz_element_type = "combo",
61 wiz_combo_choices = [
62 "Hz",
63 "kHz"
64 "MHz"
65 "GHz"
66 ],
67 wiz_read_only = False
68 )
69
70 uf.desc.append(Desc_container())
71 uf.desc[-1].add_paragraph("This allows the spectrometer frequency of a given experiment to be set. The expected units are that of the proton resonance frequency in Hertz. See the 'sfrq' parameter in the Varian procpar file or the 'SFO1' parameter in the Bruker acqus file for the exact value.")
72 uf.backend = generic_fns.frq.set
73 uf.menu_text = "&set"
74 uf.gui_icon = "oxygen.actions.edit-rename"
75 uf.wizard_size = (750, 500)
76