Shaped pulse xy.m - Revision history

Kuprov: Update function See also links and function index membership

2026-06-06T18:41:25Z

Update function See also links and function index membership

Kuprov: Rename Arguments section heading to Parameters

2026-06-05T17:52:16Z

Rename Arguments section heading to Parameters

Kuprov: Normalise preformatted blank lines in function documentation blocks

2026-06-05T16:41:31Z

Normalise preformatted blank lines in function documentation blocks

Kuprov: Normalise sequential blank lines

2026-04-25T11:30:13Z

Normalise sequential blank lines

Kuprov at 16:11, 8 May 2024

2024-05-08T16:11:04Z

Kuprov at 16:04, 8 May 2024

2024-05-08T16:04:48Z

Kuprov at 16:04, 8 May 2024

2024-05-08T16:04:37Z

Kuprov: /* Notes */

2019-08-01T14:43:12Z

‎Notes

Kuprov: /* Notes */

2019-08-01T14:42:37Z

‎Notes

Kuprov at 14:41, 1 August 2019

2019-08-01T14:41:10Z

@@ Line 64: / Line 64: @@
 ==See also==
-[[shaped_pulse_af.m]], [[read_wave.m]], [[vg_pulse.m]], [[pulse_shape.m]], [[chirp_pulse.m]]
+[[shaped_pulse_af.m]], [[read_wave.m]], [[vg_pulse.m]], [[pulse_shape.m]], [[chirp_pulse.m]], [[bruker_write.m]], [[cartesian2polar.m]], [[grad_pulse.m]], [[grad_sandw.m]], [[pmlg5.m]], [[polar2cartesian.m]], [[restrans.m]], [[rseq_compiler.m]], [[rsequence.m]], [[sawtooth.m]], [[sech_pulse.m]], [[spinal.m]], [[triwave.m]], [[wave_basis.m]], [[Kernel_functions]]
 ''Version 2.9, authors: [[Ilya Kuprov]], [[Anupama Acharya]]''

@@ Line 7: / Line 7: @@
                                        amplitudes,slice_durs,rho,method)
-==Arguments==
+==Parameters==
         drift - the drift Liouvillian, the part of the Liouvillian that

@@ Line 26: / Line 26: @@
                 For piecewise-linear methods, there should be one ele-
                 ment more in the amplitude array.
-−
           rho - initial state vector or a bookshelf matrix thereof
@@ Line 42: / Line 42: @@
                   Spinach evolution function call:
-−
                      'evol-pwc' - piecewise-constant
                      'evol-pwl' - 2nd order Lie quadrature

← Older revision		Revision as of 11:30, 25 April 2026
Line 67:		Line 67:

	[[Kernel_functions#Shaped_pulses_and_gradients\|Shaped pulses and gradients]]		[[Kernel_functions#Shaped_pulses_and_gradients\|Shaped pulses and gradients]]
−

	''Version 2.9, authors: [[Ilya Kuprov]], [[Anupama Acharya]]''		''Version 2.9, authors: [[Ilya Kuprov]], [[Anupama Acharya]]''

@@ Line 5: / Line 5: @@
       [rho,traj,P]=shaped_pulse_xy(spin_system,drift,controls,...
-                                  amplitudes,slice_durs,rho,method)
+                                      amplitudes,slice_durs,rho,method)
 ==Arguments==
@@ Line 11: / Line 11: @@
         drift - the drift Liouvillian, the part of the Liouvillian that
                 should continue running in the background. This should
-                include the pulse transmitter offset, if any.
+                include the transmitter offset term, if any.
      controls - a cell array of control operators corresponding to each
@@ Line 17: / Line 17: @@
                 of freedom, such as gradients and diffusion.
-   amplitudes - a cell array of control amplitude vectors in angular
+   amplitudes - a cell array of control amplitude vectors in rad/s, one
-                frequency units.
+                vector per control channel; the elements of each vector
    slice_durs - a vector containing the duration of each pulse slice,
-                seconds.
+                seconds. For piecewise-constant methods, the number of
-         rho - state vector of the initial state, or a stack thereof.
+      method - propagation method and product quadrature:
-      method - propagation method, 'expv' for Krylov propagation,
+                 Krylov algorithm (recommended):
-               'expm' for exponential propagation, 'evolution' for
-               Spinach evolution function
+                    'expv-pwc' - piecewise-constant
 ==Outputs==
           rho - state vector for the final state, or a stack thereof
-−
          traj - system trajectory as a [1 x (nsteps+1)] cell array,
                 the first point is the initial condition
-−
-            P - effective pulse propagator (expensive)
+            P - effective pulse propagator (expensive, best avoided)
 ==Examples==
@@ Line 52: / Line 69: @@
-''Version 2.4, authors: [[Ilya Kuprov]]''
+''Version 2.9, authors: [[Ilya Kuprov]], [[Anupama Acharya]]''

← Older revision		Revision as of 16:04, 8 May 2024
Line 1:		Line 1:
−	{{DISPLAYTITLE:shaped_pulse_xy.m}}	+	{{DISPLAYTITLE:shaped_pulse_xy.m}} __NOTOC__
	Shaped pulse function using Cartesian coordinates. Applies a user-specified pulse shape on user-specified operators while the rest of the drift Liouvillian continues to affect the spin system. The pulse is assumed to be piecewise-constant and should be supplied with sufficiently fine time discretization to properly reproduce the waveform.		Shaped pulse function using Cartesian coordinates. Applies a user-specified pulse shape on user-specified operators while the rest of the drift Liouvillian continues to affect the spin system. The pulse is assumed to be piecewise-constant and should be supplied with sufficiently fine time discretization to properly reproduce the waveform.

@@ Line 45: / Line 45: @@
 ==Notes==
 # Of the three propagation methods, 'expv' is recommended because it runs Krylov propagation that avoids explicit matrix exponentiation. The 'expm' option forces Matlab's very inefficient matrix exponentiation path and should only be used for debugging pourposes. In very anomalous cases (long pulses, large state vector stacks, very large state spaces), the 'evolution' option might become necessary.
 ==See also==