MRArbGrad 2.0.1__tar.gz → 3.0.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 2.0.1
+Version: 3.0.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-3.0.0}/MRArbGrad.egg-info/SOURCES.txt

@@ -17,12 +17,9 @@ example/example_ExternalFunction2D.py
 example/example_ExternalSamples2D.py
 example/example_ExternalSamples3D.py
 mrarbgrad_src/Function.py
-mrarbgrad_src/TrajFunc.py
 mrarbgrad_src/Utility.py
 mrarbgrad_src/__init__.py
 mrarbgrad_src/ext/main.cpp
-mrarbgrad_src/ext/mag/GradGen.cpp
-mrarbgrad_src/ext/mag/GradGen.h
 mrarbgrad_src/ext/mag/Mag.cpp
 mrarbgrad_src/ext/mag/Mag.h
 mrarbgrad_src/ext/traj/Cones.h
@@ -33,7 +30,7 @@ mrarbgrad_src/ext/traj/Seiffert.h
 mrarbgrad_src/ext/traj/Shell3d.h
 mrarbgrad_src/ext/traj/Spiral.h
 mrarbgrad_src/ext/traj/TrajFunc.h
-mrarbgrad_src/ext/traj/VarDenSpiral.h
+mrarbgrad_src/ext/traj/VDSpiral.h
 mrarbgrad_src/ext/traj/Yarnball.h
 mrarbgrad_src/ext/utility/Intp.h
 mrarbgrad_src/ext/utility/LinIntp.h

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 2.0.1
+Version: 3.0.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-3.0.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-3.0.0}/example/example_BuiltInTraj.py

@@ -26,16 +26,18 @@ mag.setMagTrajRep(1) # enable trajectory reparameterization (experimental)
 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_Spiral(**argCom); nAx = 2
+# lstArrK0, lstArrGrad = mag.getG_VDSpiral(**argCom); nAx = 2
+# lstArrK0, lstArrGrad = mag.getG_VDSpiral_RT(**argCom); nAx = 2
+lstArrK0, lstArrGrad = mag.getG_Rosette(**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-3.0.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(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-3.0.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(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-3.0.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(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-3.0.0}/mrarbgrad_src/Function.py

@@ -9,7 +9,6 @@ goldang = getGoldang()
 
 def calGrad4ExFunc\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -30,7 +29,6 @@ def calGrad4ExFunc\
     '''
     return ext.calGrad4ExFunc\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -48,7 +46,6 @@ def calGrad4ExFunc\
 
 def calGrad4ExSamp\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -64,7 +61,6 @@ def calGrad4ExSamp\
     '''
     return ext.calGrad4ExSamp\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -77,7 +73,6 @@ def calGrad4ExSamp\
     
 def getG_Spiral\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -85,6 +80,7 @@ def getG_Spiral\
     gLim: float64 = 50e-3 * 42.5756e6 * 0.256 / 256,
     dt: float64 = 10e-6,
     
+    nSlice: int64 = 1,
     kRhoPhi: float64 = 0.5 / (4 * pi)
 ) -> tuple[list[NDArray], list[NDArray]]:
     '''
@@ -93,7 +89,6 @@ def getG_Spiral\
     '''
     return ext.getG_Spiral\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -101,19 +96,20 @@ def getG_Spiral\
         float64(gLim),
         float64(dt),
         
+        int64(nSlice),
         float64(kRhoPhi)
     )
 
-def getG_VarDenSpiral\
+def getG_VDSpiral\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
     sLim: float64 = 50 * 42.5756e6 * 0.256 / 256,
     gLim: float64 = 50e-3 * 42.5756e6 * 0.256 / 256,
     dt: float64 = 10e-6,
-    
+
+    nSlice: int64 = 1,
     kRhoPhi0: float64 = 0.5 / (8 * pi),
     kRhoPhi1: float64 = 0.5 / (2 * pi),
 ) -> tuple[list[NDArray], list[NDArray]]:
@@ -121,9 +117,8 @@ def getG_VarDenSpiral\
     :return: list of trajectory start, list of gradient waveforms
     :rtype: tuple[list[NDArray], list[NDArray]]
     '''
-    return ext.getG_VarDenSpiral\
+    return ext.getG_VDSpiral\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -131,13 +126,13 @@ def getG_VarDenSpiral\
         float64(gLim),
         float64(dt),
         
+        int64(nSlice),
         float64(kRhoPhi0),
         float64(kRhoPhi1)
     )
 
-def getG_VarDenSpiral_RT\
+def getG_VDSpiral_RT\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -153,9 +148,8 @@ def getG_VarDenSpiral_RT\
     :return: list of trajectory start, list of gradient waveforms
     :rtype: tuple[list[NDArray], list[NDArray]]
     '''
-    return ext.getG_VarDenSpiral_RT\
+    return ext.getG_VDSpiral_RT\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -171,7 +165,6 @@ def getG_VarDenSpiral_RT\
 
 def getG_Rosette\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -179,6 +172,7 @@ def getG_Rosette\
     gLim: float64 = 50e-3 * 42.5756e6 * 0.256 / 256,
     dt: float64 = 10e-6,
     
+    nSlice: int64 = 1,
     om1: float64 = 5*pi, 
     om2: float64 = 3*pi, 
     tMax: float64 = 1e0,
@@ -189,7 +183,6 @@ def getG_Rosette\
     '''
     return ext.getG_Rosette\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -197,6 +190,7 @@ def getG_Rosette\
         float64(gLim),
         float64(dt),
         
+        int64(nSlice),
         float64(om1),
         float64(om2),
         float64(tMax)
@@ -204,7 +198,6 @@ def getG_Rosette\
 
 def getG_Rosette_Trad\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -212,6 +205,7 @@ def getG_Rosette_Trad\
     gLim: float64 = 50e-3 * 42.5756e6 * 0.256 / 256,
     dt: float64 = 10e-6,
     
+    nSlice: int64 = 1,
     om1: float64 = 5*pi, 
     om2: float64 = 3*pi, 
     tMax: float64 = 1e0,
@@ -223,7 +217,6 @@ def getG_Rosette_Trad\
     '''
     return ext.getG_Rosette_Trad\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -231,6 +224,7 @@ def getG_Rosette_Trad\
         float64(gLim),
         float64(dt),
         
+        int64(nSlice),
         float64(om1),
         float64(om2),
         float64(tMax),
@@ -239,7 +233,6 @@ def getG_Rosette_Trad\
 
 def getG_Shell3d\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -255,7 +248,6 @@ def getG_Shell3d\
     '''
     return ext.getG_Shell3d\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -268,7 +260,6 @@ def getG_Shell3d\
 
 def getG_Yarnball\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -284,7 +275,6 @@ def getG_Yarnball\
     '''
     return ext.getG_Yarnball\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -297,7 +287,6 @@ def getG_Yarnball\
 
 def getG_Seiffert\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -314,7 +303,6 @@ def getG_Seiffert\
     '''
     return ext.getG_Seiffert\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         
@@ -328,7 +316,6 @@ def getG_Seiffert\
 
 def getG_Cones\
 (
-    is3D: bool = False,
     fov: float64 = 0.256,
     nPix: int64 = 256,
     
@@ -344,7 +331,6 @@ def getG_Cones\
     '''
     return ext.getG_Cones\
     (
-        int64(is3D),
         float64(fov),
         int64(nPix),
         

{mrarbgrad-2.0.1 → mrarbgrad-3.0.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-3.0.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 getG_Cones, getG_Rosette, getG_Rosette_Trad, getG_Seiffert, getG_Shell3d, getG_Spiral, getG_VDSpiral, getG_VDSpiral_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