Difference between revisions of "Shaped pulse xy.m"

From Spinach Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
−
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. Syntax:
+
{{DISPLAYTITLE:shaped_pulse_xy.m}}
 +
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.
  
−
  [rho,P]=shaped_pulse_xy(spin_system,drift,controls,amplitudes,time_grid,rho)
+
==Syntax==
  
−
Parameters:
+
    [rho,P]=shaped_pulse_xy(spin_system,drift,controls,...
 +
                            amplitudes,slice_durs,rho,method)
 +
 
 +
==Arguments==
  
 
       drift - the drift Liouvillian, the part of the Liouvillian that
 
       drift - the drift Liouvillian, the part of the Liouvillian that
 
               should continue running in the background. This should  
 
               should continue running in the background. This should  
−
               include the pulse frequency offset, if any.  
+
               include the pulse transmitter offset, if any.  
−
 
+
−
     controls - cell array of control operators corresponding to each  
+
     controls - a cell array of control operators corresponding to each
−
               channel, this may include operators for spatial degrees  
+
               channel, this may include operators for spatial degrees
−
               of freedom.
+
               of freedom, such as gradients and diffusion.
 +
 +
  amplitudes - a cell array of control amplitude vectors in angular
 +
              frequency units.
 +
 +
  slice_durs - a vector containing the duration of each pulse slice,
 +
              seconds.
 +
 +
        rho - state vector of the initial state, or a stack thereof.
 +
 +
      method - propagation method, 'expv' for Krylov propagation,
 +
              'expm' for exponential propagation, 'evolution' for
 +
              Spinach evolution function
  
−
  amplitudes - a cell array of control amplitude vectors {ncontrols}
+
==Outputs==
−
              (nsteps), in angular frequency units. Order of cell array
 
−
              corresponds to the same order of the control operator
 
−
              cell array.
 
  
−
  time_grid - a vector containing the duration (not time position!)
+
        rho - state vector for the final state, or a stack thereof
−
              of each pulse slice, seconds.
+
 +
          P - pulse propagator (expensive)
  
−
        rho - state vector of the initial state, or a stack thereof.
+
==Examples==
 +
A description of what is done in the example below:
  
−
The pulse is assumed to be piecewise-constant and should be supplied with sufficiently fine time discretization to properly reproduce the waveform.
+
    % Comment
 +
    matlab code
 +
 +
    % Comment
 +
    matlab code
  
−
Outputs:
+
==Notes==
 +
An example of a Veshtort-Griggin shaped excitation pulse applied to a system with 100 coupled spins (examples/nmr_liquids/shaped_pulse_3.m):
  
−
        rho - the final state vector or a stack thereof
+
[[File:vg_pulse.png]]
  
−
          P - total pulse propagator
+
==See also==
 +
[[shaped_pulse_af.m]], [[read_wave.m]], [[vg_pulse.m]], [[pulse_shape.m]], [[chirp_pulse_af.m]], [[chirp_pulse_xy.m]]
  
−
Note: pulse propagators are expensive, do not request unless you really need that propagator.
 
  
−
''Revision 3141, authors: [[Ilya Kuprov]]''
+
''Version 2.2, authors: [[Author 1]]''

Revision as of 14:51, 15 August 2018

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.

Syntax

    [rho,P]=shaped_pulse_xy(spin_system,drift,controls,...
                            amplitudes,slice_durs,rho,method)

Arguments

      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. 

   controls - a cell array of control operators corresponding to each
              channel, this may include operators for spatial degrees
              of freedom, such as gradients and diffusion.

 amplitudes - a cell array of control amplitude vectors in angular
              frequency units.

 slice_durs - a vector containing the duration of each pulse slice,
              seconds.

        rho - state vector of the initial state, or a stack thereof.

     method - propagation method, 'expv' for Krylov propagation, 
              'expm' for exponential propagation, 'evolution' for
              Spinach evolution function

Outputs

        rho - state vector for the final state, or a stack thereof

          P - pulse propagator (expensive)

Examples

A description of what is done in the example below: 

    % Comment
    matlab code

    % Comment
    matlab code

Notes

An example of a Veshtort-Griggin shaped excitation pulse applied to a system with 100 coupled spins (examples/nmr_liquids/shaped_pulse_3.m):

Vg pulse.png

See also

shaped_pulse_af.m, read_wave.m, vg_pulse.m, pulse_shape.m, chirp_pulse_af.m, chirp_pulse_xy.m


Version 2.2, authors: Author 1

Retrieved from "https://spindynamics.org/wiki/index.php?title=Shaped_pulse_xy.m&oldid=3116"