MRArbGrad 4.4.0__tar.gz → 4.4.1__tar.gz

{mrarbgrad-4.4.0 → mrarbgrad-4.4.1}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2025 Rui Luo
+Copyright 2026 Rui Luo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

mrarbgrad-4.4.1/MANIFEST.in

@@ -0,0 +1 @@
+graft mrarbgrad_src

{mrarbgrad-4.4.0 → mrarbgrad-4.4.1/MRArbGrad.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 4.4.0
+Version: 4.4.1
 Summary: Gradient waveform design tool for arbitrary k-space trajectories.
 Author-email: Ryan <ryan_shanghaitech@proton.me>
 License-Expression: MIT

{mrarbgrad-4.4.0 → mrarbgrad-4.4.1}/MRArbGrad.egg-info/SOURCES.txt

@@ -12,13 +12,13 @@ MRArbGrad.egg-info/SOURCES.txt
 MRArbGrad.egg-info/dependency_links.txt
 MRArbGrad.egg-info/requires.txt
 MRArbGrad.egg-info/top_level.txt
-example/example_BuiltInTraj.py
-example/example_ExternalFunction2D.py
-example/example_ExternalSamples2D.py
-example/example_ExternalSamples3D.py
 mrarbgrad_src/Function.py
 mrarbgrad_src/Utility.py
 mrarbgrad_src/__init__.py
+mrarbgrad_src/ext.cpython-312-x86_64-linux-gnu.so
+mrarbgrad_src/__pycache__/Function.cpython-312.pyc
+mrarbgrad_src/__pycache__/Utility.cpython-312.pyc
+mrarbgrad_src/__pycache__/__init__.cpython-312.pyc
 mrarbgrad_src/ext/main.cpp
 mrarbgrad_src/ext/mag/Mag.cpp
 mrarbgrad_src/ext/mag/Mag.h

{mrarbgrad-4.4.0/MRArbGrad.egg-info → mrarbgrad-4.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MRArbGrad
-Version: 4.4.0
+Version: 4.4.1
 Summary: Gradient waveform design tool for arbitrary k-space trajectories.
 Author-email: Ryan <ryan_shanghaitech@proton.me>
 License-Expression: MIT

{mrarbgrad-4.4.0 → mrarbgrad-4.4.1}/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_VDSpiral, getG_VDSpiral_RT, getG_Yarnball, getG_Yarnball_RT
 from .Function import setSolverMtg, setTrajRev, setGoldAng, setShuf, setMaxG0, setMaxG1, setMagGradSamp, setMagTrajSamp, setMagOverSamp, setMagSFS, setMagGradRep, setMagTrajRep, setDbgPrint, saveF64, loadF64, saveF32, loadF32
-from .Utility import _calDiaphony, rotate, _calJacElip, _calCompElipInt, _calSphFibPt, cvtGrad2Traj, getGoldang, getGoldrat, rand3d, gradClip, genPermTab
+from .Utility import _calDiaphony, rotate, _calJacElip, _calCompElipInt, _calSphFibPt, cvtGrad2Traj, getGoldang, getGoldrat, rand3d, gradClip, genPermTab, unitcvt, getK_Cartesian, getK_Radial
 
 from . import trajfunc

{mrarbgrad-4.4.0 → mrarbgrad-4.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "MRArbGrad"
-version = "4.4.0"
+version = "4.4.1"
 dependencies = ["numpy"]
 
 description = "Gradient waveform design tool for arbitrary k-space trajectories."

mrarbgrad-4.4.0/MANIFEST.in

@@ -1 +0,0 @@
-global-include *.py *.c *.cpp *.h

mrarbgrad-4.4.0/example/example_BuiltInTraj.py

@@ -1,105 +0,0 @@
-import mrarbgrad as mag
-from numpy import *
-from matplotlib.pyplot import *
-from numpy.linalg import norm
-
-gamma = 42.5756e6
-fov = 0.256
-nPix = 256
-dtGrad = 10e-6
-dtADC = 2.5e-6
-sLim = 50 * gamma * fov/nPix
-gLim = 20e-3 * gamma * fov/nPix
-# gLim = 1/nPix/dtADC
-argCom = dict(fov=fov, nPix=nPix, sLim=sLim, gLim=gLim, dt=dtGrad)
-
-mag.setSolverMtg(0) # set solver, 0 for proposed method, 1 for baseline method, baseline method may be removed due to copyright reason
-mag.setTrajRev(0) # reverse the trajectory
-mag.setGoldAng(1) # enable golden-angle interleaving (only for 2D)
-mag.setShuf(0) # enable TR-shuffling
-mag.setMaxG0(0) # use maximum possible initial gradient amplitude
-mag.setMaxG1(0) # use maximum possible final gradient amplitude
-mag.setMagOverSamp(8) # set oversampling ratio (default: 8, reduce only if hardware performance is too low to support real-time)
-mag.setMagSFS(0) # disable DTFBS (experimental)
-mag.setMagGradRep(1) # enable gradient reparameterization (experimental)
-mag.setMagTrajRep(1) # enable trajectory reparameterization (experimental)
-mag.setDbgPrint(1) # enable debug info (for benchmark purpose)
-
-# calculate gradient
-# 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])
-print(f"Tacq: {nRO_Max*dtGrad*1e3:.3f} ms")
-tTR = (nRO_Max*dtGrad + 2e-3)
-print(f"TR: {tTR*1e3:.3f} ms")
-tScan = tTR*len(lstArrGrad)
-print(f"Tscan: {tScan:.3e} s")
-
-# derive shape parameter
-if nAx==2:
-    lstArrK0 = [arrK0[:2] for arrK0 in lstArrK0]
-    lstArrGrad = [arrG[:,:2] for arrG in lstArrGrad]
-nRO, nAx = lstArrGrad[0].shape
-
-# derive slewrate
-lstArrSlew = [diff(arrG, axis=0)/dtGrad for arrG in lstArrGrad]
-sMax = max(norm(concatenate(lstArrSlew)/gamma*nPix/fov, axis=-1))
-gMax = max(norm(concatenate(lstArrGrad)/gamma*nPix/fov, axis=-1))
-
-# derive trajectory
-lstArrK = []
-for arrK0, arrGrad in zip(lstArrK0, lstArrGrad):
-    arrK, _ = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC)
-    arrK += arrK0
-    lstArrK.append(arrK)
-
-iArrK = len(lstArrK)*2//3
-
-# k-space and g-space
-figure(figsize=(18,9), dpi=120)
-
-subplot(221, projection="3d" if nAx==3 else None)
-plot(*lstArrK[iArrK].T, ".-")
-axis("equal")
-grid("on")
-title(f"kspace {1}/{len(lstArrGrad)}")
-
-subplot(223, projection="3d" if nAx==3 else None)
-plot(*lstArrGrad[iArrK].T, ".-")
-axis("equal")
-grid("on")
-title("gspace")
-
-# gradient and slewrate
-subplot(222)
-for iAx in range(nAx):
-    plot(lstArrGrad[iArrK][:,iAx]/gamma*nPix/fov, ".-")
-grid("on")
-title(f"Gradient")
-
-subplot(224)
-plot(norm(lstArrSlew[iArrK],axis=-1)/gamma*nPix/fov, ".-", c="tab:blue")
-ylim(sLim/gamma*nPix/fov*0.9, sLim/gamma*nPix/fov*1.1)
-grid("on")
-
-twinx()
-plot(norm(lstArrGrad[iArrK],axis=-1)/gamma*nPix/fov*1e3, ".-", c="tab:orange")
-ylim(gLim/gamma*nPix/fov*0.9*1e3, gLim/gamma*nPix/fov*1.1*1e3)
-grid("on")
-title(f"Grad & Slew amp., max grad:{gMax*1e3:.3f}, max slew:{sMax:.3f}")
-
-subplots_adjust(0.05,0.1,0.95,0.9, 0.2, 0.2)
-
-show()

mrarbgrad-4.4.0/example/example_ExternalFunction2D.py

@@ -1,80 +0,0 @@
-from numpy import *
-from numpy.linalg import norm
-from matplotlib.pyplot import *
-import mrarbgrad as mag
-
-gamma = 42.5756e6
-fov = 0.256
-nPix = 256
-dtGrad = 10e-6
-dtADC = 1e-6
-sLim = 50 * gamma * fov/nPix
-gLim = 20e-3 * gamma * fov/nPix
-# gLim = 1/nPix/dtADC
-
-# Rosette
-nAx = 2
-om1 = 19*pi
-om2 = 17*pi
-def Rosette(t):
-    rho = 0.5*sin(om1*t)
-    return array\
-    ([
-        rho*cos(om2*t),
-        rho*sin(om2*t),
-        0*t
-    ])
-    
-pLim = [0,1]
-
-# derive slew-rate constrained trajectory
-mag.setMaxG0(0)
-mag.setMaxG1(0)
-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]
-
-arrSlew = diff(arrGrad, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
-
-arrK = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)[0]
-
-# derive reference trajectory
-arrP_Ref = linspace(pLim[0], pLim[1], int(1e4))
-arrK_Ref = Rosette(arrP_Ref).T
-
-# plot
-figure(figsize=(20,10), dpi=120)
-
-subplot(221, projection=None if nAx==2 else "3d")
-if nAx==2: plot(arrK_Ref[:,0], arrK_Ref[:,1], "--", label="K_Ref")
-if nAx==3: plot(arrK_Ref[:,0], arrK_Ref[:,1], arrK_Ref[:,2], "--", label="K_Ref")
-if nAx==2: plot(arrK[:,0], arrK[:,1], ".-", label="K_Imp")
-if nAx==3: plot(arrK[:,0], arrK[:,1], arrK[:,2], ".-", label="K_Imp")
-xlim(-0.5,0.5)
-ylim(-0.5,0.5)
-axis("equal")
-grid("on")
-legend()
-title("k-Space")
-
-subplot(222)
-for iAx in range(nAx):
-    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
-grid("on")
-title("Gradient")
-
-subplot(223, projection=None if nAx==2 else "3d")
-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(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(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
-
-show()

mrarbgrad-4.4.0/example/example_ExternalSamples2D.py

@@ -1,84 +0,0 @@
-from numpy import *
-from numpy.linalg import norm
-from matplotlib.pyplot import *
-import mrarbgrad as mag
-
-gamma = 42.5756e6
-fov = 0.256
-nPix = 256
-dtGrad = 10e-6
-dtADC = 2.5e-6
-sLim = 50 * gamma * fov/nPix
-gLim = 20e-3 * gamma * fov/nPix
-# gLim = 1/nPix/dtADC
-
-# Rosette
-om1 = 5*pi
-om2 = 3*pi
-pLim = [0,1]
-def TrajFunc(t):
-    rho = 0.5*sin(om1*t)
-    return array\
-    ([
-        rho*cos(om2*t),
-        rho*sin(om2*t),
-        zeros_like(t)
-    ])
-
-# sample
-arrP = linspace(pLim[0], pLim[1], 1000)
-arrK = TrajFunc(arrP).T
-nAx = 2
-
-# derive slew-rate constrained trajectory
-for i in range(1):
-    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]
-
-arrSlew = diff(arrGrad, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
-
-arrK, _ = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)
-arrK += TrajFunc(pLim[0])
-print(f"Err: {norm(arrK[-1,:]-TrajFunc(pLim[1])):.1e}")
-
-# derive reference trajectory
-arrP_Ref = linspace(pLim[0], pLim[1], int(1e4))
-arrK_Ref = TrajFunc(arrP_Ref).T
-
-# plot
-figure(figsize=(20,10), dpi=120)
-
-subplot(221, projection=None if nAx==2 else "3d")
-if nAx==2: plot(arrK_Ref[:,0], arrK_Ref[:,1], "--", label="K_Ref")
-if nAx==3: plot(arrK_Ref[:,0], arrK_Ref[:,1], arrK_Ref[:,2], "--", label="K_Ref")
-if nAx==2: plot(arrK[:,0], arrK[:,1], ".-", label="K_Imp")
-if nAx==3: plot(arrK[:,0], arrK[:,1], arrK[:,2], ".-", label="K_Imp")
-xlim(-0.5,0.5)
-ylim(-0.5,0.5)
-axis("equal")
-grid("on")
-legend()
-title("k-Space")
-
-subplot(222)
-for iAx in range(nAx):
-    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
-grid("on")
-title("Gradient")
-
-subplot(223, projection=None if nAx==2 else "3d")
-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(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(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
-
-show()

mrarbgrad-4.4.0/example/example_ExternalSamples3D.py

@@ -1,72 +0,0 @@
-from numpy import *
-from numpy.linalg import norm
-from matplotlib.pyplot import *
-import mrarbgrad as mag
-
-gamma = 42.5756e6
-fov = 0.256
-nPix = 256
-dtGrad = 10e-6
-dtADC = 2.5e-6
-sLim = 50 * gamma * fov/nPix
-gLim = 20e-3 * gamma * fov/nPix
-# gLim = 1/nPix/dtADC
-
-# Yarnball
-nAx = 3
-
-kRhoPhi = 0.5/(2*pi)
-Yarnball = lambda sqrtTht: mag.trajfunc.Yarnball(sqrtTht, kRhoPhi)
-pLim = mag.trajfunc.prange_Yarnball(kRhoPhi)
-    
-arrP = linspace(pLim[0], pLim[1], 1000)
-arrK = Yarnball(arrP)
-
-# derive slew-rate constrained trajectory
-mag.setDbgPrint(1)
-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]
-
-arrSlew = diff(arrGrad, axis=0)/dtGrad
-print(f"sMax: {max(norm(arrSlew,axis=-1))/(42.58e6)*(nPix/fov)}")
-
-arrK, _ = mag.cvtGrad2Traj(arrGrad, dtGrad, dtADC, 0.5)
-
-# derive reference trajectory
-arrP_Ref = linspace(pLim[0], pLim[1], int(1e4))
-arrK_Ref = Yarnball(arrP_Ref)
-
-# plot
-figure(figsize=(20,10), dpi=120)
-
-subplot(221, projection="3d")
-plot(arrK_Ref[:,0], arrK_Ref[:,1], arrK_Ref[:,2], "--", label="K_Ref")
-plot(arrK[:,0], arrK[:,1], arrK[:,2], ".-", label="K_Imp")
-xlim(-0.5,0.5)
-ylim(-0.5,0.5)
-axis("equal")
-grid("on")
-legend()
-title("k-Space")
-
-subplot(222)
-for iAx in range(nAx):
-    plot(arrGrad[:,iAx]/(42.58e6)*(nPix/fov), ".-")
-grid("on")
-title("Gradient")
-
-subplot(223, projection=None if nAx==2 else "3d")
-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(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(arrSlew,axis=-1))/(42.58e6)*(nPix/fov):.3f}")
-
-show()