Source Code for Module user_functions.bruker

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2011-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 bruker user function definitions for interfacing with the Bruker Dynamics Center.""" 
24   
25  # relax module imports. 
26  from graphics import WIZARD_IMAGE_PATH 
27  from pipe_control import bruker 
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('bruker') 
34  uf_class.title = "Class containing the function for reading the Bruker Dynamics Center (DC) files." 
35  uf_class.menu_text = "&bruker" 
36  uf_class.gui_icon = "relax.bruker" 
37   
38   
39  # The bruker.read user function. 
40  uf = uf_info.add_uf('bruker.read') 
41  uf.title = "Read the relaxation data out of a Bruker Dynamics Center (DC) file." 
42  uf.title_short = "Read a Bruker Dynamics Center file." 
43  uf.add_keyarg( 
44      name = "ri_id", 
45      basic_types = ["str"], 
46      desc_short = "relaxation data ID string", 
47      desc = "The relaxation data ID string.  This must be a unique identifier." 
48  ) 
49  uf.add_keyarg( 
50      name = "file", 
51      arg_type = "file sel read", 
52      desc_short = "file name", 
53      desc = "The name of the Bruker Dynamics Center file containing the relaxation data.", 
54  ) 
55  uf.add_keyarg( 
56      name = "dir", 
57      arg_type = "dir", 
58      desc_short = "directory name", 
59      desc = "The directory where the file is located.", 
60      can_be_none = True 
61  ) 
62  # Description. 
63  uf.desc.append(Desc_container()) 
64  uf.desc[-1].add_paragraph("This user function is used to load the fitted relaxation data out of a Bruker Dynamics Center (DC) file for the analyses in relax that use relaxation data.  Currently the R1 and R2 relaxation rates and steady-state NOE data is supported.  The peak intensity information in the file, which is used by the Dynamics Center to fit or calculate the relaxation values, will be discarded.") 
65  uf.backend = bruker.read 
66  uf.menu_text = "&read" 
67  uf.gui_icon = "oxygen.actions.document-open" 
68  uf.wizard_size = (800, 500) 
69  uf.wizard_image = WIZARD_IMAGE_PATH + 'bruker.png' 
70