Source Code for Module test_suite.unit_tests._lib._dispersion.test_m61

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 2014 Edward d'Auvergne                                        # 
  4  # Copyright (C) 2014 Troels E. Linnet                                         # 
  5  #                                                                             # 
  6  # This file is part of the program relax (http://www.nmr-relax.com).          # 
  7  #                                                                             # 
  8  # This program is free software: you can redistribute it and/or modify        # 
  9  # it under the terms of the GNU General Public License as published by        # 
 10  # the Free Software Foundation, either version 3 of the License, or           # 
 11  # (at your option) any later version.                                         # 
 12  #                                                                             # 
 13  # This program is distributed in the hope that it will be useful,             # 
 14  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
 15  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
 16  # GNU General Public License for more details.                                # 
 17  #                                                                             # 
 18  # You should have received a copy of the GNU General Public License           # 
 19  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
 20  #                                                                             # 
 21  ############################################################################### 
 22   
 23  # Python module imports. 
 24  from numpy import array, float64, ones, pi, zeros 
 25  from unittest import TestCase 
 26   
 27  # relax module imports. 
 28  from lib.dispersion.m61 import r1rho_M61 
 29   
 30   
 31 -class Test_m61(TestCase): 
 32      """Unit tests for the lib.dispersion.m61 relax module.""" 
 33   
 34 -    def setUp(self): 
 35          """Set up for all unit tests.""" 
 36   
 37          # The R1rho_prime parameter value (R1rho with no exchange). 
 38          self.r1rho_prime = 2.5 
 39          # Population of ground state. 
 40          self.pA = 0.95 
 41          # The chemical exchange difference between states A and B in ppm. 
 42          self.dw = 0.5 
 43          self.kex = 1000.0 
 44          # The R1 relaxation rates. 
 45          self.r1 = 1.0 
 46          # The spin-lock field strengths in Hertz. 
 47          self.spin_lock_nu1 = array([ 1000., 1500., 2000., 2500., 3000., 3500., 4000., 4500., 5000., 5500., 6000.]) 
 48          # The rotating frame tilt angles for each dispersion point. 
 49          self.theta = array([1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966, 1.5707963267948966]) 
 50   
 51          # The spin Larmor frequencies. 
 52          self.sfrq = 599.8908617*1E6 
 53   
 54          # Required data structures. 
 55          self.num_points = 11 
 56          self.R1rho = zeros(self.num_points, float64) 
 57   
 58   
 59 -    def calc_r1rho(self): 
 60          """Calculate and check the R1rho values.""" 
 61   
 62          # Parameter conversions. 
 63          phi_ex_scaled, spin_lock_omega1_squared = self.param_conversion(pA=self.pA, dw=self.dw, sfrq=self.sfrq, spin_lock_nu1=self.spin_lock_nu1) 
 64   
 65          a = ones([self.num_points]) 
 66   
 67          # Calculate the R1rho values. 
 68          r1rho_M61(r1rho_prime=self.r1rho_prime*a, phi_ex=phi_ex_scaled*a, kex=self.kex, spin_lock_fields2=spin_lock_omega1_squared, back_calc=self.R1rho) 
 69   
 70          # Check all R1rho values. 
 71          if self.kex > 1.e5: 
 72              for i in range(self.num_points): 
 73                  self.assertAlmostEqual(self.R1rho[i], self.r1rho_prime, 2) 
 74          else: 
 75              for i in range(self.num_points): 
 76                  self.assertAlmostEqual(self.R1rho[i], self.r1rho_prime) 
 77   
 78   
 79 -    def param_conversion(self, pA=None, dw=None, sfrq=None, spin_lock_nu1=None): 
 80          """Convert the parameters. 
 81   
 82          @keyword pA:            The population of state A. 
 83          @type pA:               float 
 84          @keyword dw:            The chemical exchange difference between states A and B in ppm. 
 85          @type dw:               float 
 86          @keyword sfrq:          The spin Larmor frequencies in Hz. 
 87          @type sfrq:             float 
 88          @keyword spin_lock_nu1: The spin-lock field strengths in Hertz. 
 89          @type spin_lock_nu1:    float 
 90          @return:                The parameters {phi_ex_scaled, k_BA}. 
 91          @rtype:                 tuple of float 
 92          """ 
 93   
 94          # Calculate pB. 
 95          pB = 1.0 - pA 
 96   
 97          # Calculate spin Larmor frequencies in 2pi. 
 98          frqs = sfrq * 2 * pi 
 99   
100          # The phi_ex parameter value (pA * pB * delta_omega^2). 
101          phi_ex = pA * pB * (dw / 1.e6)**2 
102   
103          # Convert phi_ex from ppm^2 to (rad/s)^2. 
104          phi_ex_scaled = phi_ex * frqs**2 
105   
106          # The R1rho spin-lock field strengths squared (in rad^2.s^-2). 
107          spin_lock_omega1_squared = (2. * pi * spin_lock_nu1)**2 
108   
109          # Return all values. 
110          return phi_ex_scaled, spin_lock_omega1_squared 
111   
112   
113 -    def test_m61_no_rex1(self): 
114          """Test the r1rho_m61() function for no exchange when dw = 0.0.""" 
115   
116          # Parameter reset. 
117          self.dw = 0.0 
118   
119          # Calculate and check the R1rho values. 
120          self.calc_r1rho() 
121   
122   
123 -    def test_m61_no_rex2(self): 
124          """Test the r1rho_m61() function for no exchange when pA = 1.0.""" 
125   
126          # Parameter reset. 
127          self.pA = 1.0 
128   
129          # Calculate and check the R1rho values. 
130          self.calc_r1rho() 
131   
132   
133 -    def test_m61_no_rex3(self): 
134          """Test the r1rho_m61() function for no exchange when kex = 0.0.""" 
135   
136          # Parameter reset. 
137          self.kex = 0.0 
138   
139          # Calculate and check the R1rho values. 
140          self.calc_r1rho() 
141   
142   
143 -    def test_m61_no_rex4(self): 
144          """Test the r1rho_m61() function for no exchange when dw = 0.0 and pA = 1.0.""" 
145   
146          # Parameter reset. 
147          self.pA = 1.0 
148          self.dw = 0.0 
149   
150          # Calculate and check the R1rho values. 
151          self.calc_r1rho() 
152   
153   
154 -    def test_m61_no_rex5(self): 
155          """Test the r1rho_m61() function for no exchange when dw = 0.0 and kex = 0.0.""" 
156   
157          # Parameter reset. 
158          self.dw = 0.0 
159          self.kex = 0.0 
160   
161          # Calculate and check the R1rho values. 
162          self.calc_r1rho() 
163   
164   
165 -    def test_m61_no_rex6(self): 
166          """Test the r1rho_m61() function for no exchange when pA = 1.0 and kex = 0.0.""" 
167   
168          # Parameter reset. 
169          self.pA = 1.0 
170          self.kex = 0.0 
171   
172          # Calculate and check the R1rho values. 
173          self.calc_r1rho() 
174   
175   
176 -    def test_m61_no_rex7(self): 
177          """Test the r1rho_m61() function for no exchange when dw = 0.0, pA = 1.0, and kex = 0.0.""" 
178   
179          # Parameter reset. 
180          self.dw = 0.0 
181          self.kex = 0.0 
182   
183          # Calculate and check the R1rho values. 
184          self.calc_r1rho() 
185   
186   
187 -    def test_m61_no_rex8(self): 
188          """Test the r1rho_m61() function for no exchange when kex = 1e20.""" 
189   
190          # Parameter reset. 
191          self.kex = 1e20 
192   
193          # Calculate and check the R2eff values. 
194          self.calc_r1rho() 
195