MRArbGrad 2.0.1__tar.gz → 2.1.0__tar.gz

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0/MRArbGrad.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 2.0.1
+Version: 2.1.0
 Summary: Gradient waveform design tool for arbitrary k-space trajectories.
 Author-email: Ryan <ryan_shanghaitech@proton.me>
 License-Expression: MIT
@@ -22,18 +22,21 @@ This toolbox is a pip package with C++ backend. The pip package can be called vi
 ```bash
 $ conda create -n magtest -y
 $ conda activate magtest
-$ conda install python==3.10 -y
+$ conda install python==3.12 -y
 ```
 
-This package is **NOT** restricted to use `Python 3.10` or `numpy 1.26` (as specified in the `requirements.txt`). Feel free to adjust at your convenience, just if the package works.
+This package is **NOT** restricted to use `Python 3.12`. Feel free to adjust at your convenience, just if the package works.
 
-To install the pip package of the proposed algorithm (including the trajectory library built on it), and also the dependencies:
+To install the pip package of the proposed algorithm (including the trajectory library built on it):
 ```bash
-$ pip install -r requirements.txt
 $ bash install.bash
 ```
+or
+```bash
+$ pip install mrarbgrad
+```
 
-It's the best practice to use my script `install.bash` for installation. You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
+You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
 
 ## Examples & Usages
 Examples for generating gradient waveforms for either built-in trajectory (trajectory library) or external trajectory (expressed by trajectory function or trajectory samples) can be found in the `example` folder.

{mrarbgrad-2.0.1/MRArbGrad.egg-info → mrarbgrad-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 2.0.1
+Version: 2.1.0
 Summary: Gradient waveform design tool for arbitrary k-space trajectories.
 Author-email: Ryan <ryan_shanghaitech@proton.me>
 License-Expression: MIT
@@ -22,18 +22,21 @@ This toolbox is a pip package with C++ backend. The pip package can be called vi
 ```bash
 $ conda create -n magtest -y
 $ conda activate magtest
-$ conda install python==3.10 -y
+$ conda install python==3.12 -y
 ```
 
-This package is **NOT** restricted to use `Python 3.10` or `numpy 1.26` (as specified in the `requirements.txt`). Feel free to adjust at your convenience, just if the package works.
+This package is **NOT** restricted to use `Python 3.12`. Feel free to adjust at your convenience, just if the package works.
 
-To install the pip package of the proposed algorithm (including the trajectory library built on it), and also the dependencies:
+To install the pip package of the proposed algorithm (including the trajectory library built on it):
 ```bash
-$ pip install -r requirements.txt
 $ bash install.bash
 ```
+or
+```bash
+$ pip install mrarbgrad
+```
 
-It's the best practice to use my script `install.bash` for installation. You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
+You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
 
 ## Examples & Usages
 Examples for generating gradient waveforms for either built-in trajectory (trajectory library) or external trajectory (expressed by trajectory function or trajectory samples) can be found in the `example` folder.

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/README.md

@@ -8,18 +8,21 @@ This toolbox is a pip package with C++ backend. The pip package can be called vi
 ```bash
 $ conda create -n magtest -y
 $ conda activate magtest
-$ conda install python==3.10 -y
+$ conda install python==3.12 -y
 ```
 
-This package is **NOT** restricted to use `Python 3.10` or `numpy 1.26` (as specified in the `requirements.txt`). Feel free to adjust at your convenience, just if the package works.
+This package is **NOT** restricted to use `Python 3.12`. Feel free to adjust at your convenience, just if the package works.
 
-To install the pip package of the proposed algorithm (including the trajectory library built on it), and also the dependencies:
+To install the pip package of the proposed algorithm (including the trajectory library built on it):
 ```bash
-$ pip install -r requirements.txt
 $ bash install.bash
 ```
+or
+```bash
+$ pip install mrarbgrad
+```
 
-It's the best practice to use my script `install.bash` for installation. You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
+You can also install via `pip install .` but remember to delete `*.egg-info` or pip will run into bug when uninstalling this package in current folder (see comments in `install.bash`).
 
 ## Examples & Usages
 Examples for generating gradient waveforms for either built-in trajectory (trajectory library) or external trajectory (expressed by trajectory function or trajectory samples) can be found in the `example` folder.

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/example/example_BuiltInTraj.py

@@ -28,14 +28,16 @@ mag.setDbgPrint(1) # enable debug info (for benchmark purpose)
 # calculate gradient
 # lstArrK0, lstArrGrad = mag.getG_Spiral(is3D=0, **argCom); nAx = 2
 # lstArrK0, lstArrGrad = mag.getG_VarDenSpiral(is3D=0, **argCom); nAx = 2
-lstArrK0, lstArrGrad = mag.getG_VarDenSpiral_RT(is3D=0, **argCom); nAx = 2
-# lstArrK0, lstArrGrad = mag.getG_Rosette(is3D=0, **argCom); nAx = 2
+# lstArrK0, lstArrGrad = mag.getG_VarDenSpiral_RT(is3D=0, **argCom); nAx = 2
+lstArrK0, lstArrGrad = mag.getG_Rosette(is3D=0, **argCom); nAx = 2
 # lstArrK0, lstArrGrad = mag.getG_Rosette_Trad(**argCom); nAx = 2
 # lstArrK0, lstArrGrad = mag.getG_Shell3d(**argCom); nAx = 3
 # lstArrK0, lstArrGrad = mag.getG_Yarnball(**argCom); nAx = 3
 # lstArrK0, lstArrGrad = mag.getG_Seiffert(**argCom); nAx = 3
 # lstArrK0, lstArrGrad = mag.getG_Cones(**argCom); nAx = 3
 
+# lstArrGrad = mag.gradClip(lstArrGrad, dtGrad, sLim, gLim) # clip slew/grad amp with hardware constraint
+
 print("")
 print(f"Intlea Num.: {len(lstArrGrad)}")
 nRO_Max = amax([arrG.shape[0] for arrG in lstArrGrad])

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/example/example_ExternalFunction2D.py

@@ -6,16 +6,16 @@ import mrarbgrad as mag
 gamma = 42.5756e6
 fov = 0.256
 nPix = 256
-dtGrad = 10e-6
-dtADC = 2.5e-6
+dtGrad = 10e-6 * 1e-1
+dtADC = 2.5e-6 * 1e-1
 sLim = 50 * gamma * fov/nPix
 gLim = 20e-3 * gamma * fov/nPix
 # gLim = 1/nPix/dtADC
 
 # Rosette
 nAx = 2
-om1 = 5*pi
-om2 = 3*pi
+om1 = 19*pi
+om2 = 17*pi
 def Rosette(t):
     rho = 0.5*sin(om1*t)
     return array\
@@ -28,13 +28,14 @@ def Rosette(t):
 pLim = [0,1]
 
 # derive slew-rate constrained trajectory
-arrG, _ = mag.calGrad4ExFunc(False, fov, nPix, sLim, gLim, dtGrad, Rosette, None, None, pLim[0], pLim[1])
-nRO, _ = arrG.shape
+arrGrad = mag.calGrad4ExFunc(False, fov, nPix, sLim, gLim, dtGrad, Rosette, None, None, pLim[0], pLim[1])[0]
+# arrGrad = mag.gradClip(arrGrad, dtGrad, sLim, gLim) # clip slew/grad amp with hardware constraint
+nRO = arrGrad.shape[0]
 
-arrS = diff(arrG, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov)}")
+arrSlew = diff(arrGrad, axis=0)/dtGrad
+print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
 
-arrK, _ = mag.cvtGrad2Traj(arrG, dtGrad, dtADC, 0.5)
+arrK = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)[0]
 
 # derive reference trajectory
 arrP_Ref = linspace(pLim[0], pLim[1], int(1e4))
@@ -57,21 +58,21 @@ title("k-Space")
 
 subplot(222)
 for iAx in range(nAx):
-    plot(arrG[:,iAx]/(42.58e6)*(nPix/fov), ".-")
+    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
 grid("on")
 title("Gradient")
 
 subplot(223, projection=None if nAx==2 else "3d")
-if nAx==2: plot(arrG[:,0], arrG[:,1], ".-")
-if nAx==3: plot(arrG[:,0], arrG[:,1], arrG[:,2], ".-")
+if nAx==2: plot(arrGrad[:,0], arrGrad[:,1], ".-")
+if nAx==3: plot(arrGrad[:,0], arrGrad[:,1], arrGrad[:,2], ".-")
 axis("equal")
 grid("on")
 title("g-Space")
 
 subplot(224)
-plot(norm(arrS,axis=-1)/(42.58e6)*(nPix/fov), ".-")
+plot(norm(arrSlew,axis=-1)/(42.58e6)*(nPix/fov), ".-")
 ylim(sLim/(42.58e6)*(nPix/fov)*0.9, sLim/(42.58e6)*(nPix/fov)*1.1)
 grid("on")
-title(f"Slewrate, max:{max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
+title(f"Slewrate, max:{max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
 
 show()

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/example/example_ExternalSamples2D.py

@@ -32,13 +32,14 @@ nAx = 2
 
 # derive slew-rate constrained trajectory
 for i in range(1):
-    arrG, _ = mag.calGrad4ExSamp(False, fov, nPix, sLim, gLim, dtGrad, arrK)
-nRO, _ = arrG.shape
+    arrGrad = mag.calGrad4ExSamp(False, fov, nPix, sLim, gLim, dtGrad, arrK)[0]
+    # arrGrad = mag.gradClip(arrGrad, dtGrad, sLim, gLim) # clip slew/grad amp with hardware constraint
+nRO = arrGrad.shape[0]
 
-arrS = diff(arrG, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov)}")
+arrSlew = diff(arrGrad, axis=0)/dtGrad
+print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
 
-arrK, _ = mag.cvtGrad2Traj(arrG, dtGrad, dtADC, 0.5)
+arrK, _ = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)
 arrK += TrajFunc(pLim[0])
 print(f"Err: {norm(arrK[-1,:]-TrajFunc(pLim[1])):.1e}")
 
@@ -63,21 +64,21 @@ title("k-Space")
 
 subplot(222)
 for iAx in range(nAx):
-    plot(arrG[:,iAx]/(42.58e6)*(nPix/fov), ".-")
+    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
 grid("on")
 title("Gradient")
 
 subplot(223, projection=None if nAx==2 else "3d")
-if nAx==2: plot(arrG[:,0], arrG[:,1], ".-")
-if nAx==3: plot(arrG[:,0], arrG[:,1], arrG[:,2], ".-")
+if nAx==2: plot(arrGrad[:,0], arrGrad[:,1], ".-")
+if nAx==3: plot(arrGrad[:,0], arrGrad[:,1], arrGrad[:,2], ".-")
 axis("equal")
 grid("on")
 title("g-Space")
 
 subplot(224)
-plot(norm(arrS,axis=-1)/(42.58e6)*(nPix/fov), ".-")
+plot(norm(arrSlew,axis=-1)/(42.58e6)*(nPix/fov), ".-")
 ylim(sLim/(42.58e6)*(nPix/fov)*0.9, sLim/(42.58e6)*(nPix/fov)*1.1)
 grid("on")
-title(f"Slewrate, max:{max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
+title(f"Slewrate, max:{max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
 
 show()

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/example/example_ExternalSamples3D.py

@@ -24,13 +24,14 @@ arrK = Yarnball(arrP)
 
 # derive slew-rate constrained trajectory
 mag.setDbgPrint(1)
-arrG, _ = mag.calGrad4ExSamp(True, fov, nPix, sLim, gLim, dtGrad, arrK)
-nRO, _ = arrG.shape
+arrGrad = mag.calGrad4ExSamp(True, fov, nPix, sLim, gLim, dtGrad, arrK)[0]
+# arrGrad = mag.gradClip(arrGrad, dtGrad, sLim, gLim) # clip slew/grad amp with hardware constraint
+nRO = arrGrad.shape[0]
 
-arrS = diff(arrG, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov)}")
+arrSlew = diff(arrGrad, axis=0)/dtGrad
+print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
 
-arrK, _ = mag.cvtGrad2Traj(arrG, dtGrad, dtADC, 0.5)
+arrK, _ = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)
 
 # derive reference trajectory
 arrP_Ref = linspace(pLim[0], pLim[1], int(1e4))
@@ -51,21 +52,21 @@ title("k-Space")
 
 subplot(222)
 for iAx in range(nAx):
-    plot(arrG[:,iAx]/(42.58e6)*(nPix/fov), ".-")
+    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
 grid("on")
 title("Gradient")
 
 subplot(223, projection=None if nAx==2 else "3d")
-if nAx==2: plot(arrG[:,0], arrG[:,1], ".-")
-if nAx==3: plot(arrG[:,0], arrG[:,1], arrG[:,2], ".-")
+if nAx==2: plot(arrGrad[:,0], arrGrad[:,1], ".-")
+if nAx==3: plot(arrGrad[:,0], arrGrad[:,1], arrGrad[:,2], ".-")
 axis("equal")
 grid("on")
 title("g-Space")
 
 subplot(224)
-plot(norm(arrS,axis=-1)/(42.58e6)*(nPix/fov), ".-")
+plot(norm(arrSlew,axis=-1)/(42.58e6)*(nPix/fov), ".-")
 ylim(sLim/(42.58e6)*(nPix/fov)*0.9, sLim/(42.58e6)*(nPix/fov)*1.1)
 grid("on")
-title(f"Slewrate, max:{max(norm(arrS,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
+title(f"Slewrate, max:{max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
 
 show()

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/Utility.py

@@ -1,6 +1,6 @@
 from numpy import *
+from numpy.linalg import norm
 from numpy.typing import *
-from matplotlib.pyplot import *
 
 goldrat = (1+sqrt(5))/2
 goldang = (2*pi)/(1+goldrat)
@@ -8,6 +8,46 @@ goldang = (2*pi)/(1+goldrat)
 getGoldrat = lambda: goldrat
 getGoldang = lambda: goldang
 
+def gradClip(lstArrGrad:list[NDArray]|NDArray, dt:float, sLim:float, gLim:float) -> list[NDArray]|NDArray:
+    """
+    Clip the slewrate and gradient amlitude of a list of gradient waveforms
+
+    Args:
+        lstArrGrad: list of gradient waveforms
+        sLim: slewrate amplitude limit
+        gLim: gradient amplitude limit
+
+    Returns:
+        Clipped gradient waveforms
+    """
+    if isinstance(lstArrGrad, ndarray): _lstArrGrad = [lstArrGrad.copy()]
+    else: _lstArrGrad = lstArrGrad.copy()
+    nPE = len(_lstArrGrad)
+    for iPE in range(nPE):
+        # slew-rate clipping
+        arrGrad = _lstArrGrad[iPE]
+        arrSlew = diff(arrGrad, 1, 0)/dt
+        arrSlewNorm = norm(arrSlew, axis=-1)
+        arrSlewNorm[where(arrSlewNorm==0)] += 1e-6
+        arrSlewUnit = arrSlew/arrSlewNorm[:,newaxis]
+        clip(arrSlewNorm, None, sLim, out=arrSlewNorm)
+        arrSlew = arrSlewUnit*arrSlewNorm[:,newaxis]
+        # gradient clipping
+        arrGrad[:,:] = arrGrad[0,:]
+        arrGrad[1:,:] += cumsum(arrSlew*dt, axis=0)
+        arrGradNorm = norm(arrGrad, axis=-1)
+        arrGradNorm[where(arrGradNorm==0)] += 1e-6
+        arrGradUnit = arrGrad/arrGradNorm[:,newaxis]
+        clip(arrGradNorm, None, gLim, out=arrGradNorm)
+        arrGrad = arrGradUnit*arrGradNorm[:,newaxis]
+        # 
+        _lstArrGrad[iPE] = arrGrad
+        
+    if isinstance(lstArrGrad, ndarray):
+        return _lstArrGrad[0]
+    else:
+        return _lstArrGrad
+
 def rand3d(i:int|NDArray, nAx:int=3, kx=sqrt(2), ky=sqrt(3), kz=sqrt(7)) -> NDArray:
     return (hstack if size(i)==1 else vstack)\
     ([

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/__init__.py

@@ -1,6 +1,6 @@
 from .Function import calGrad4ExFunc, calGrad4ExSamp
 from .Function import getG_Cones, getG_Rosette, getG_Rosette_Trad, getG_Seiffert, getG_Shell3d, getG_Spiral, getG_VarDenSpiral, getG_VarDenSpiral_RT, getG_Yarnball
 from .Function import setSolverMtg, setTrajRev, setGoldAng, setShuf, setMaxG0, setMaxG1, setExGEnd, setMagOverSamp, setMagSFS, setMagGradRep, setMagTrajRep, setDbgPrint
-from .Utility import _calDiaphony, rotate, _calJacElip, _calCompElipInt, _calSphFibPt, cvtGrad2Traj, getGoldang, getGoldrat, rand3d
+from .Utility import _calDiaphony, rotate, _calJacElip, _calCompElipInt, _calSphFibPt, cvtGrad2Traj, getGoldang, getGoldrat, rand3d, gradClip
 
 from . import trajfunc

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/ext/mag/Mag.cpp

@@ -12,7 +12,7 @@ bool gMag_enGradRep = true; // Gradient Reparameterization
 bool gMag_enTrajRep = true; // use trajectory reparameterization for MAG solver
 i64 gMag_nTrajSamp = 1000; // num. of samp. when doing Traj. Rep.
 
-MagSolver::MagSolver()
+Mag::Mag()
 {
     m_dt = 10e-6; m_oversamp = 8;
     i64 nSampReserve = i64(100e-3/m_dt*m_oversamp); // reserve for 100ms
@@ -25,7 +25,7 @@ MagSolver::MagSolver()
     m_vv3G_For.reserve(nSampReserve);
 }
 
-bool MagSolver::setup
+bool Mag::setup
     (
         TrajFunc* ptTraj,
         f64 sLim, f64 gLim,
@@ -61,7 +61,7 @@ bool MagSolver::setup
     return true;
 }
 
-bool MagSolver::setup
+bool Mag::setup
     (
         const vv3& vv3TrajSamp,
         f64 sLim, f64 gLim,
@@ -81,10 +81,10 @@ bool MagSolver::setup
     return true;
 }
 
-MagSolver::~MagSolver()
+Mag::~Mag()
 {}
 
-bool MagSolver::sovQDE(f64* psol0, f64* psol1, f64 a, f64 b, f64 c)
+bool Mag::sovQDE(f64* psol0, f64* psol1, f64 a, f64 b, f64 c)
 {
     f64 delta = b*b - 4e0*a*c;
     if (psol0) *psol0 = (-b-(delta<0?0:std::sqrt(delta)))/(2*a);
@@ -92,7 +92,7 @@ bool MagSolver::sovQDE(f64* psol0, f64* psol1, f64 a, f64 b, f64 c)
     return delta>=0;
 }
 
-f64 MagSolver::getCurRad(f64 p)
+f64 Mag::getCurRad(f64 p)
 {
     v3 dkdp; m_ptfTraj->getDkDp(&dkdp, p);
     v3 d2kdp2; m_ptfTraj->getD2kDp2(&d2kdp2, p);
@@ -103,7 +103,7 @@ f64 MagSolver::getCurRad(f64 p)
 
 #if 1
 
-f64 MagSolver::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f64 pThis, f64 signDp)
+f64 Mag::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f64 pThis, f64 signDp)
 {
     // solve `ΔP` by RK2
     f64 l = v3::norm(v3GThis)*dt;
@@ -127,7 +127,7 @@ f64 MagSolver::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f6
 
 #else // less accurate due to estimation of PNext
 
-f64 MagSolver::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f64 pThis, f64 signDp)
+f64 Mag::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f64 pThis, f64 signDp)
 {
     // solve `ΔP` by RK2
     f64 l = v3::norm(v3GThis)*dt;
@@ -140,7 +140,7 @@ f64 MagSolver::getDp(const v3& v3GPrev, const v3& v3GThis, f64 dt, f64 pPrev, f6
 
 #endif
 
-bool MagSolver::step(v3* gUnit, f64* gNormMin, f64* gNormMax, f64 p, f64 signDp, const v3& g, f64 sLim, f64 dt)
+bool Mag::step(v3* gUnit, f64* gNormMin, f64* gNormMax, f64 p, f64 signDp, const v3& g, f64 sLim, f64 dt)
 {
     // current gradient direction
     v3 dkdp; m_ptfTraj->getDkDp(&dkdp, p);
@@ -161,7 +161,7 @@ bool MagSolver::step(v3* gUnit, f64* gNormMin, f64* gNormMax, f64 p, f64 signDp,
     return isQDESucc;
 }
 
-bool MagSolver::compute(vv3* pvv3G, vf64* pvf64P)
+bool Mag::solve(vv3* pvv3G, vf64* pvf64P)
 {
     bool ret = true;
     f64 p0 = m_ptfTraj->getP0();
@@ -327,7 +327,7 @@ bool MagSolver::compute(vv3* pvv3G, vf64* pvf64P)
     return ret;
 }
 
-bool MagSolver::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, f64 sLim, f64 dt)
+bool Mag::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, f64 sLim, f64 dt)
 {
     v3 dg = g0Des - g0;
     v3 dgUnit = v3::norm(dg)!=0 ? dg/v3::norm(dg) : v3(0,0,0);
@@ -347,7 +347,7 @@ bool MagSolver::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, f64 sL
     return true;
 }
 
-f64 MagSolver::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, i64 nSamp, f64 dt)
+f64 Mag::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, i64 nSamp, f64 dt)
 {
     v3 dg = g0Des - g0;
     v3 dgUnit = v3::norm(dg)!=0 ? dg/v3::norm(dg) : v3(0,0,0);
@@ -367,7 +367,7 @@ f64 MagSolver::ramp_front(vv3* pvv3GRamp, const v3& g0, const v3& g0Des, i64 nSa
     return sLim;
 }
 
-bool MagSolver::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, f64 sLim, f64 dt)
+bool Mag::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, f64 sLim, f64 dt)
 {
     v3 dg = g1Des - g1;
     v3 dgUnit = v3::norm(dg)!=0 ? dg/v3::norm(dg) : v3(0,0,0);
@@ -387,7 +387,7 @@ bool MagSolver::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, f64 sLi
     return true;
 }
 
-f64 MagSolver::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, i64 nSamp, f64 dt)
+f64 Mag::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, i64 nSamp, f64 dt)
 {
     v3 dg = g1Des - g1;
     v3 dgUnit = v3::norm(dg)!=0 ? dg/v3::norm(dg) : v3(0,0,0);
@@ -407,7 +407,7 @@ f64 MagSolver::ramp_back(vv3* pvv3GRamp, const v3& g1, const v3& g1Des, i64 nSam
     return sLim;
 }
 
-bool MagSolver::revGrad(v3* pv3M0Dst, vv3* pvv3Dst, const v3& v3M0Src, const vv3& vv3Src, f64 dt)
+bool Mag::revGrad(v3* pv3M0Dst, vv3* pvv3Dst, const v3& v3M0Src, const vv3& vv3Src, f64 dt)
 {
     bool ret = true;
 
@@ -426,7 +426,7 @@ bool MagSolver::revGrad(v3* pv3M0Dst, vv3* pvv3Dst, const v3& v3M0Src, const vv3
     return ret;
 }
 
-v3 MagSolver::calM0(const vv3& vv3G, f64 dt)
+v3 Mag::calM0(const vv3& vv3G, f64 dt)
 {
     v3 M0 = v3(0,0,0);
     for (int64_t i = 1; i < (i64)vv3G.size(); ++i)

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/ext/mag/Mag.h

@@ -84,7 +84,7 @@ protected:
     SplineIntp m_intpX, m_intpY, m_intpZ;
 };
 
-class MagSolver
+class Mag
 {
 public:
     typedef std::vector<i64> vi64;
@@ -97,7 +97,7 @@ public:
     typedef std::list<v3> lv3;
     typedef std::list<vv3> lvv3;
 
-    MagSolver();
+    Mag();
     bool setup
     (
         TrajFunc* ptTraj,
@@ -112,8 +112,8 @@ public:
         f64 dt=10e-6, i64 oversamp=10, 
         f64 dG0Norm=0e0, f64 dG1Norm=0e0
     );
-    ~MagSolver();
-    bool compute(vv3* plv3G, vf64* pvf64P=NULL);
+    ~Mag();
+    bool solve(vv3* plv3G, vf64* pvf64P=NULL);
     template <typename dtype, typename cv3>
     static bool decomp
     (
@@ -154,7 +154,7 @@ private:
 
 // definition must be in `.h` file (compiler limitation)
 template <typename dtype, typename cv3>
-bool MagSolver::decomp
+bool Mag::decomp
 (
     std::vector<dtype>* pvfGx,
     std::vector<dtype>* pvfGy,

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/ext/main.cpp

@@ -410,7 +410,7 @@ bool getG(MrTraj* pmt, vv3* pvv3M0PE, vvv3* pvvv3GRO)
         v3 v3M0PE; ret &= pmt->getM0PE(&v3M0PE, _i);
 
         // reverse gradient if needed
-        if (gMain_enTrajRev) ret &= MagSolver::revGrad(&v3M0PE, &vv3GRO, v3M0PE, vv3GRO, dt);
+        if (gMain_enTrajRev) ret &= Mag::revGrad(&v3M0PE, &vv3GRO, v3M0PE, vv3GRO, dt);
 
         pvv3M0PE->at(i) = v3M0PE;
         pvvv3GRO->at(i) = vv3GRO;

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/ext/traj/MrTraj.h

@@ -58,7 +58,7 @@ public:
         m_sGradPara(m_sGradPara),
         m_nAcq(m_nAcq),
         m_nSampMax(m_nSampMax)
-    { solver = MagSolver(); }
+    { mag = Mag(); }
     
     virtual ~MrTraj()
     {}
@@ -122,13 +122,13 @@ public:
         { vi64SeqIdx.push_back(i); }
         
         // decide step size, make step size and num of idx coprime
-        i64 step = (i64)(num*(GOLDRAT-1));
-        while (gcd(step, num)!=1)
-        { ++step; }
+        i64 inc = (i64)(num*(GOLDRAT-1));
+        while (gcd(inc, num)!=1)
+        { ++inc; }
 
         // generate random index
         for(i64 i = 0; i < num; ++i)
-        { pvi64Idx->push_back(i*step%num); }
+        { pvi64Idx->push_back(i*inc%num); }
 
         return true;
     }
@@ -167,7 +167,7 @@ protected:
     i64 m_nSampMax;
 
     // solver settings
-    MagSolver solver;
+    Mag mag;
     
     // calculate required num. of rot. to satisfy Nyquist sampling (for spiral only)
     static i64 calNRot(f64 kRhoPhi, i64 nPix)
@@ -232,8 +232,8 @@ protected:
         const f64& gLim = sGradPara.gLim;
         const f64& dt = sGradPara.dt;
 
-        solver.setup(&tf, sLim, gLim, dt, oversamp, gMrTraj_g0Norm, gMrTraj_g1Norm);
-        ret &= solver.compute(pvv3G, pvf64P);
+        mag.setup(&tf, sLim, gLim, dt, oversamp, gMrTraj_g0Norm, gMrTraj_g1Norm);
+        ret &= mag.solve(pvv3G, pvf64P);
 
         return ret;
     }
@@ -245,8 +245,8 @@ protected:
         const f64& gLim = sGradPara.gLim;
         const f64& dt = sGradPara.dt;
 
-        solver.setup(vv3TrajSamp, sLim, gLim, dt, oversamp, gMrTraj_g0Norm, gMrTraj_g1Norm);
-        ret &= solver.compute(pvv3G, pvf64P);
+        mag.setup(vv3TrajSamp, sLim, gLim, dt, oversamp, gMrTraj_g0Norm, gMrTraj_g1Norm);
+        ret &= mag.solve(pvv3G, pvf64P);
 
         return ret;
     }
@@ -384,7 +384,7 @@ protected:
         {
             // add ramp gradient to satisfy desired Gstart and Gfinal
             vv3 vv3GRampFront;
-            ret &= MagSolver::ramp_front(&vv3GRampFront, pvv3GRO->front(), v3(), sLim, dt);
+            ret &= Mag::ramp_front(&vv3GRampFront, pvv3GRO->front(), v3(), sLim, dt);
             pvv3GRO->insert(pvv3GRO->begin(), vv3GRampFront.begin(), vv3GRampFront.end());
             
             // corresponding parameter sequence
@@ -398,7 +398,7 @@ protected:
         {
             // add ramp gradient to satisfy desired Gstart and Gfinal
             vv3 vv3GRampBack;
-            ret &= MagSolver::ramp_back(&vv3GRampBack, pvv3GRO->back(), v3(), sLim, dt);
+            ret &= Mag::ramp_back(&vv3GRampBack, pvv3GRO->back(), v3(), sLim, dt);
             pvv3GRO->insert(pvv3GRO->end(), vv3GRampBack.begin(), vv3GRampBack.end());
             
             // corresponding parameter sequence

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/mrarbgrad_src/ext/traj/TrajFunc.h

@@ -2,7 +2,7 @@
 
 #include "../utility/global.h"
 #include "../utility/v3.h"
-// #include "../mag/MagSolver.h" // VS2010 reports error on this
+// #include "../mag/Mag.h" // VS2010 reports error on this
 
 /* 
  * Single trajectory define by a parameterized function getK()

{mrarbgrad-2.0.1 → mrarbgrad-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "MRArbGrad"
-version = "2.0.1"
+version = "2.1.0"
 dependencies = ["numpy"]
 
 description = "Gradient waveform design tool for arbitrary k-space trajectories."
@@ -17,4 +17,4 @@ readme = "README.md"
 
 [project.urls]
 Repository = "https://github.com/RyanShanghaitech/MRArbGrad"
-Examples = "https://github.com/RyanShanghaitech/MRArbGrad/tree/main/example"
+Examples = "https://github.com/RyanShanghaitech/MRArbGrad/tree/main/example"