Source Code for Module auto_analyses.relax_fit

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 2004-2011 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 automatic relaxation curve fitting protocol.""" 
 24   
 25  # Python module imports. 
 26  from os import sep 
 27   
 28  # relax module imports. 
 29  from generic_fns.pipes import cdp_name, has_pipe, switch 
 30  import generic_fns.structure.main 
 31  from prompt.interpreter import Interpreter 
 32  from status import Status; status = Status() 
 33   
 34   
 35   
 36 -class Relax_fit: 
 37 -    def __init__(self, pipe_name=None, pipe_bundle=None, file_root='rx', results_dir=None, grid_inc='11', mc_sim_num=500, view_plots=True): 
 38          """Perform relaxation curve fitting. 
 39   
 40          To use this auto-analysis, a data pipe with all the required data needs to be set up.  This data pipe should contain the following: 
 41   
 42              - All the spins loaded. 
 43              - Unresolved spins deselected. 
 44              - All the peak intensities loaded and relaxation delay times set. 
 45              - Either the baseplane noise RMDS values should be set or replicated spectra loaded. 
 46   
 47          @keyword pipe_name:     The name of the data pipe containing all of the data for the analysis. 
 48          @type pipe_name:        str 
 49          @keyword pipe_bundle:   The data pipe bundle to associate all spawned data pipes with. 
 50          @type pipe_bundle:      str 
 51          @keyword file_root:     File root of the output filea. 
 52          @type file_root:        str 
 53          @keyword results_dir:   The directory where results files are saved. 
 54          @type results_dir:      str 
 55          @keyword grid_inc:      Number of grid search increments. 
 56          @type grid_inc:         int 
 57          @keyword mc_sim_num:    The number of Monte Carlo simulations to be used for error analysis at the end of the analysis. 
 58          @type mc_sim_num:       int 
 59          @keyword view_plots:    Flag to automatically view grace plots after calculation. 
 60          @type view_plots:       bool 
 61          """ 
 62   
 63          # Execution lock. 
 64          status.exec_lock.acquire(pipe_bundle, mode='auto-analysis') 
 65   
 66          # Set up the analysis status object. 
 67          status.init_auto_analysis(pipe_bundle, type='relax_fit') 
 68          status.current_analysis = pipe_bundle 
 69   
 70          # Store the args. 
 71          self.pipe_name = pipe_name 
 72          self.pipe_bundle = pipe_bundle 
 73          self.file_root = file_root 
 74          self.results_dir = results_dir 
 75          if self.results_dir: 
 76              self.grace_dir = results_dir + sep + 'grace' 
 77          else: 
 78              self.grace_dir = 'grace' 
 79          self.mc_sim_num = mc_sim_num 
 80          self.grid_inc = grid_inc 
 81          self.view_plots = view_plots 
 82   
 83          # Data checks. 
 84          self.check_vars() 
 85   
 86          # Set the data pipe to the current data pipe. 
 87          if self.pipe_name != cdp_name(): 
 88              switch(self.pipe_name) 
 89   
 90          # Load the interpreter. 
 91          self.interpreter = Interpreter(show_script=False, quit=False, raise_relax_error=True) 
 92          self.interpreter.populate_self() 
 93          self.interpreter.on(verbose=False) 
 94   
 95          # Execute. 
 96          self.run() 
 97   
 98          # Finish and unlock execution. 
 99          status.auto_analysis[self.pipe_bundle].fin = True 
100          status.current_analysis = None 
101          status.exec_lock.release() 
102   
103   
104 -    def run(self): 
105          """Set up and run the curve-fitting.""" 
106   
107          # Peak intensity error analysis. 
108          self.interpreter.spectrum.error_analysis() 
109   
110          # Set the relaxation curve type. 
111          self.interpreter.relax_fit.select_model('exp') 
112   
113          # Grid search. 
114          self.interpreter.grid_search(inc=self.grid_inc) 
115   
116          # Minimise. 
117          self.interpreter.minimise('simplex', scaling=False, constraints=False) 
118   
119          # Monte Carlo simulations. 
120          self.interpreter.monte_carlo.setup(number=self.mc_sim_num) 
121          self.interpreter.monte_carlo.create_data() 
122          self.interpreter.monte_carlo.initial_values() 
123          self.interpreter.minimise('simplex', scaling=False, constraints=False) 
124          self.interpreter.monte_carlo.error_analysis() 
125   
126          # Save the relaxation rates. 
127          self.interpreter.value.write(param='rx', file=self.file_root+'.out', dir=self.results_dir, force=True) 
128   
129          # Save the results. 
130          self.interpreter.results.write(file='results', dir=self.results_dir, force=True) 
131   
132          # Create Grace plots of the data. 
133          self.interpreter.grace.write(y_data_type='chi2', file='chi2.agr', dir=self.grace_dir, force=True)    # Minimised chi-squared value. 
134          self.interpreter.grace.write(y_data_type='i0', file='i0.agr', dir=self.grace_dir, force=True)    # Initial peak intensity. 
135          self.interpreter.grace.write(y_data_type='rx', file=self.file_root+'.agr', dir=self.grace_dir, force=True)    # Relaxation rate. 
136          self.interpreter.grace.write(x_data_type='relax_times', y_data_type='intensities', file='intensities.agr', dir=self.grace_dir, force=True)    # Average peak intensities. 
137          self.interpreter.grace.write(x_data_type='relax_times', y_data_type='intensities', norm=True, file='intensities_norm.agr', dir=self.grace_dir, force=True)    # Average peak intensities (normalised). 
138   
139          # Display the Grace plots if selected. 
140          if self.view_plots: 
141              self.interpreter.grace.view(file='chi2.agr', dir=self.grace_dir) 
142              self.interpreter.grace.view(file='i0.agr', dir=self.grace_dir) 
143              self.interpreter.grace.view(file=self.file_root+'.agr', dir=self.grace_dir) 
144              self.interpreter.grace.view(file='intensities.agr', dir=self.grace_dir) 
145              self.interpreter.grace.view(file='intensities_norm.agr', dir=self.grace_dir) 
146   
147          # Save the program state. 
148          self.interpreter.state.save(state=self.file_root+'.save', dir=self.results_dir, force=True) 
149   
150   
151 -    def check_vars(self): 
152          """Check that the user has set the variables correctly.""" 
153   
154          # The pipe name. 
155          if not has_pipe(self.pipe_name): 
156              raise RelaxNoPipeError(self.pipe_name) 
157