Difference between revisions of "Kernel contexts"
| Line 3: | Line 3: | ||
Most built-in pulse sequences in Spinach should be called via a context, for example: | Most built-in pulse sequences in Spinach should be called via a context, for example: | ||
| − | fid=[[liquid.m|liquid]]( | + | fid=[[liquid.m|liquid]](spin_system,[[noesy.m|@noesy]],parameters,'nmr'); |
| + | |||
| + | This calls [[liquid.m]] context and tells it that [[noesy.m]] must be called with the parameters specified for the spin system specified with the [[assume.m|assumptions]] set to liquid state NMR. The context will build the Hamiltonian, the relaxation superoperator, the kinetics superoperator, apply the offsets and the rotating frame transformations, and pass the resulting operators to [[noesy.m]], which runs the simulation. In this way, a lot of waork is saved to whoever has to program the NOESY sequence. | ||
The following contexts are available: | The following contexts are available: | ||
Revision as of 11:47, 9 July 2017
A context is an intermediate layer between the kernel (which runs the mathematics) and the experiment (which is programmed as it would be on a spectrometer). Context functions are responsible for creating operators (evolution, kinetics, relaxation, diffusion, etc.) and for running miscellaneous housekeeping operations (rotating frame transformations, transmitter offsets, powder averages, magic angle spinning, etc.).
Most built-in pulse sequences in Spinach should be called via a context, for example:
fid=liquid(spin_system,@noesy,parameters,'nmr');
This calls liquid.m context and tells it that noesy.m must be called with the parameters specified for the spin system specified with the assumptions set to liquid state NMR. The context will build the Hamiltonian, the relaxation superoperator, the kinetics superoperator, apply the offsets and the rotating frame transformations, and pass the resulting operators to noesy.m, which runs the simulation. In this way, a lot of waork is saved to whoever has to program the NOESY sequence.
The following contexts are available:
- crystal.m - single static orientation simulations.
- doublerot.m - double rotation simulations using Fokker-Planck formalism for the rotation part and a spherical grid for the powder average operation.
- floquet.m - single rotation simulations using Floquet formalism for the rotation part and a spherical grid for the powder average operation.
- gridfree.m - single rotation simulations using Fokker-Planck formalism for both the rotation part and the powder average operation. This module also supports stochastic Liouville equation formalism for spin relaxation theory.
- imaging.m - imaging and spatial encoding simulations.
- liquid.m - liquid state simulations.
- powder.m - static powder simulations using a spherical grid for the powder average operation.
- roadmap.m - static powder simulations using a spherical grid. Simulation results are returned as an array with an answer reported at each orientation found in the spherical grid.
- singlerot.m - single rotation simulations using Fokker-Planck formalism for the rotation part and a spherical grid for the powder average operation.
Call syntax for spectroscopy contexts
All context functions, except for imaging.m have the same call syntax, e.g.:
answer=doublerot(spin_system,pulse_sequence,parameters,assumptions);
and call experiment functions using the same syntax:
answer=pulse_sequence(spin_system,parameters,H,R,K);
where H is the Hamiltonian commutation superoperator, R is the relaxation superoperator, and K is the kinetics superoperator. The parameter lists of different pulse sequences are broadly similar. This allows rapid switching of the simulation context by simply calling the same experiment from a different context.
Call syntax for imaging contexts
The imaging context has a similar call:
answer=imaging(spin_system,pulse_sequence,parameters)
but the assumptions are set internally to 'nmr' and the pulse sequence must have the following syntax:
answer=pulse_sequence(spin_system,parameters,H,R,K,G,F);
where H is the Hamiltonian commutation superoperator, R is the relaxation superoperator, K is the kinetics superoperator, G is a cell array of three gradient operators normalized to 1 Tesla/m, and F is the diffusion and flow superoperator.