Module ns_cpmg_2site_expanded
source code
The numerical fit of 2-site Bloch-McConnell equations for CPMG-type
experiments, the NS
CPMG 2-site expanded model.
Description
This function is exact, just as the explicit Bloch-McConnell
numerical treatments. It comes from a Maple derivation based on the
Bloch-McConnell equations. It is much faster than the numerical
Bloch-McConnell solution. It was derived by Nikolai Skrynnikov and is
provided with his permission.
Code origin
The code originates as optimization function number 5 from the
fitting_main_kex.py script from Mathilde Lescanne, Paul Schanda, and
Dominique Marion (see http://thread.gmane.org/gmane.science.nmr.relax.devel/4138,
https://web.archive.org/web/https://gna.org/task/?7712#comment2
and https://web.archive.org/web/https://gna.org/support/download.php?file_id=18262).
Links to the copyright licensing agreements from all authors
are:
Code evolution
The complex path of the code from the original Maple to relax can
be described as:
Maple p3.analytical script
For reference, the original Maple script written by Nikolai for
the expansion of the equations is:
with(linalg):
with(tensor):
#Ka:=30;
#Kb:=1200;
#dW:=300;
#N:=2;
#tcp:=0.040/N;
Ksym:=sqrt(Ka*Kb);
#dX:=(Ka-Kb+I*dw)/2; # Ra=Rb
dX:=((Ra-Rb)+(Ka-Kb)+I*dw)/2;
L:=([[-dX, Ksym], [Ksym, dX]]);
# in the end everything is multiplied by exp(-0.5*(Ra+Rb+Ka+Kb)*(Tc+2*tpalmer))
# where 0.5*(Ra+Rb) is the same as Rinf, and (Ka+Kb) is kex.
y:=eigenvects(L);
TP1:=array([[y[1][3][1][1],y[2][3][1][1]],[y[1][3][1][2],y[2][3][1][2]]]);
iTP1:=inverse(TP1);
P1:=array([[exp(y[1][1]*tcp/2),0],[0,exp(y[2][1]*tcp/2)]]);
P1palmer:=array([[exp(y[1][1]*tpalmer),0],[0,exp(y[2][1]*tpalmer)]]);
TP2:=map(z->conj(z),TP1);
iTP2:=map(z->conj(z),iTP1);
P2:=array([[exp(conj(y[1][1])*tcp),0],[0,exp(conj(y[2][1])*tcp)]]);
P2palmer:=array([[exp(conj(y[1][1])*tpalmer),0],[0,exp(conj(y[2][1])*tpalmer)]]);
cP1:=evalm(TP1&*P1&*iTP1);
cP2:=evalm(TP2&*P2&*iTP2);
cP1palmer:=evalm(TP1&*P1palmer&*iTP1);
cP2palmer:=evalm(TP2&*P2palmer&*iTP2);
Ps:=evalm(cP1&*cP2&*cP1);
# Ps is symmetric; cf. simplify(Ps[1,2]-Ps[2,1]);
Pspalmer:=evalm(cP2palmer&*cP1palmer);
dummy:=array([[a,b],[b,c]]);
x:=eigenvects(dummy);
TG1:=array([[x[1][3][1][1],x[2][3][1][1]],[x[1][3][1][2],x[2][3][1][2]]]);
iTG1:=inverse(TG1);
G1:=array([[x[1][1]^(N/4),0],[0,x[2][1]^(N/4)]]);
GG1:=evalm(TG1&*G1&*iTG1);
GG2:=map(z->conj(z),GG1);
cGG:=evalm(GG2&*Pspalmer&*GG1);
#s0:=array([Kb, Ka]);
s0:=array([sqrt(Kb),sqrt(Ka)]); # accounts for exchange symmetrization
st:=evalm(cGG&*s0);
#obs:=(1/(Ka+Kb))*st[1];
obs:=(sqrt(Kb)/(Ka+Kb))*st[1]; # accounts for exchange symmetrization
obs1:=eval(obs,[a=Ps[1,1],b=Ps[1,2],c=Ps[2,2]]);
#obs2:=simplify(obs1):
print(obs1):
cGGref:=evalm(Pspalmer);
stref:=evalm(cGGref&*s0);
obsref:=(sqrt(Kb)/(Ka+Kb))*stref[1]; # accounts for exchange symmetrization
print(obsref):
writeto(result_test):
fortran([intensity=obs1, intensity_ref=obsref], optimized):
Matlab sim_all.tar funNikolai.m script
Also for reference, the Matlab code from Nikolai and Martin
manually converted from the automatically generated FORTRAN from the
previous script into the funNikolai.m file is:
function residual = funNikolai(optpar)
% extended Carver's equation derived via Maple, Ra-Rb = 0 by Skrynnikov
global nu_0 x y Rcalc rms nfields
global Tc
Rcalc=zeros(nfields,size(x,2));
tau_ex=optpar(1);
pb=optpar(2);
pa=1-pb;
kex=1/tau_ex;
Ka=kex*pb;
Kb=kex*pa;
nu_cpmg=x;
tcp=1./(2*nu_cpmg);
N=round(Tc./tcp);
for k=1:nfields
dw=2*pi*nu_0(k)*optpar(3);
Rinf=optpar(3+k);
t3 = i;
t4 = t3*dw;
t5 = Kb^2;
t8 = 2*t3*Kb*dw;
t10 = 2*Kb*Ka;
t11 = dw^2;
t14 = 2*t3*Ka*dw;
t15 = Ka^2;
t17 = sqrt(t5-t8+t10-t11+t14+t15);
t21 = exp((-Kb+t4-Ka+t17)*tcp/4);
t22 = 1/t17;
t28 = exp((-Kb+t4-Ka-t17)*tcp/4);
t31 = t21*t22*Ka-t28*t22*Ka;
t33 = sqrt(t5+t8+t10-t11-t14+t15);
t34 = Kb+t4-Ka+t33;
t37 = exp((-Kb-t4-Ka+t33)*tcp/2);
t39 = 1/t33;
t41 = Kb+t4-Ka-t33;
t44 = exp((-Kb-t4-Ka-t33)*tcp/2);
t47 = t34*t37*t39/2-t41*t44*t39/2;
t49 = Kb-t4-Ka-t17;
t51 = t21*t49*t22;
t52 = Kb-t4-Ka+t17;
t54 = t28*t52*t22;
t55 = -t51+t54;
t60 = t37*t39*Ka-t44*t39*Ka;
t62 = t31.*t47+t55.*t60/2;
t63 = 1/Ka;
t68 = -t52*t63*t51/2+t49*t63*t54/2;
t69 = t62.*t68/2;
t72 = t37*t41*t39;
t76 = t44*t34*t39;
t78 = -t34*t63*t72/2+t41*t63*t76/2;
t80 = -t72+t76;
t82 = t31.*t78/2+t55.*t80/4;
t83 = t82.*t55/2;
t88 = t52*t21*t22/2-t49*t28*t22/2;
t91 = t88.*t47+t68.*t60/2;
t92 = t91.*t88;
t95 = t88.*t78/2+t68.*t80/4;
t96 = t95.*t31;
t97 = t69+t83;
t98 = t97.^2;
t99 = t92+t96;
t102 = t99.^2;
t108 = t62.*t88+t82.*t31;
t112 = sqrt(t98-2*t99.*t97+t102+4*(t91.*t68/2+t95.*t55/2).*t108);
t113 = t69+t83-t92-t96-t112;
t115 = N/2;
t116 = (t69/2+t83/2+t92/2+t96/2+t112/2).^t115;
t118 = 1./t112;
t120 = t69+t83-t92-t96+t112;
t122 = (t69/2+t83/2+t92/2+t96/2-t112/2).^t115;
t127 = 1./t108;
t139 = 1/(Ka+Kb)*((-t113.*t116.*t118/2+t120.*t122.*t118/2)*Kb+(-t113.*t127.*t116.*t120.*t118/2+t120.*t127.*t122.*t113.*t118/2)*Ka/2);
intensity0 = pa; % pA
intensity = real(t139)*exp(-Tc*Rinf); % that's "homogeneous" relaxation
Rcalc(k,:)=(1/Tc)*log(intensity0./intensity);
end
if (size(Rcalc)==size(y))
residual=sum(sum((y-Rcalc).^2));
rms=sqrt(residual/(size(y,1)*size(y,2)));
end
Links
More information on the NS CPMG 2-site expanded model can be found
in the:
|
r2eff_ns_cpmg_2site_expanded(r20=None,
pA=None,
dw=None,
dw_orig=None,
kex=None,
relax_time=None,
inv_relax_time=None,
tcp=None,
back_calc=None,
num_cpmg=None)
The 2-site numerical solution to the Bloch-McConnell equation using
complex conjugate matrices. |
source code
|
|
|
__package__ = ' lib.dispersion '
|
Imports:
any,
exp,
isfinite,
fabs,
power,
log,
min,
sqrt,
sum,
fix_invalid,
masked_where
r2eff_ns_cpmg_2site_expanded(r20=None,
pA=None,
dw=None,
dw_orig=None,
kex=None,
relax_time=None,
inv_relax_time=None,
tcp=None,
back_calc=None,
num_cpmg=None)
| source code
|
The 2-site numerical solution to the Bloch-McConnell equation using
complex conjugate matrices.
This function calculates and stores the R2eff values.
- Parameters:
r20 (numpy float array of rank [NE][NS][NM][NO][ND]) - The R2 value for both states A and B in the absence of exchange.
pA (float) - The population of state A.
dw (numpy float array of rank [NE][NS][NM][NO][ND]) - The chemical exchange difference between states A and B in rad/s.
dw_orig (numpy float array of rank-1) - The chemical exchange difference between states A and B in ppm.
This is only for faster checking of zero value, which result in
no exchange.
kex (float) - The kex parameter value (the exchange rate in rad/s).
relax_time (numpy float array of rank [NE][NS][NM][NO][ND]) - The total relaxation time period (in seconds).
inv_relax_time (numpy float array of rank [NE][NS][NM][NO][ND]) - The inverse of the total relaxation time period (in inverse
seconds).
tcp (numpy float array of rank [NE][NS][NM][NO][ND]) - The tau_CPMG times (1 / 4.nu1).
back_calc (numpy float array of rank [NE][NS][NM][NO][ND]) - The array for holding the back calculated R2eff values. Each
element corresponds to one of the CPMG nu1 frequencies.
num_cpmg (numpy int16 array of rank [NE][NS][NM][NO][ND]) - The array of numbers of CPMG blocks.
|