Difference between revisions of "Floquet.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "Floquet magic angle spinning context. Generates a Liouvillian super- operator and passes it on to the pulse sequence function, which sho- uld be supplied as a handle. Syntax: ...")
 
Line 1: Line 1:
Floquet magic angle spinning context. Generates a Liouvillian super-
+
{{DISPLAYTITLE:floquet.m}}
operator and passes it on to the pulse sequence function, which sho-
+
Floquet magic angle spinning context. This function generates Floquet Hamiltonian at a particular orientation, relaxation superoperator, kinetics superoperator, applies the necessary offsets, updates the parameter set, and passes all of that to the pulse sequence, which should be supplied as a handle. Parallel powder averaging is applied.
uld be supplied as a handle. Syntax:
 
  
    answer=floquet(spin_system,pulse_sequence,parameters,assumptions)
+
==Syntax==
  
where pulse sequence is a function handle to one of the pulse sequences
+
    answer=floquet(spin_system,@pulse_sequence,parameters,assumptions)
located in the experiments directory, assumptions is a string that would
 
be passed to assume.m when the Hamiltonian is built and parameters is a
 
structure with the following subfields:
 
  
  parameters.rate    - spinning rate in Hz
+
==Arguments==
  
  parameters.axis    - spinning axis, given as a normalized
+
    @pulse_sequence    - pulse sequence function handle
                        3-element vector
+
 +
    parameters.rate    - spinning rate in Hz
 +
 +
    parameters.axis    - spinning axis, given as a normalized
 +
                          3-element vector
 +
 +
    parameters.spins    - a cell array giving the spins that
 +
                          the pulse sequence involves, e.g.
 +
                          {'1H','13C'}
 +
 +
    parameters.offset  - a cell array giving transmitter off-
 +
                          sets in Hz on each of the spins listed
 +
                          in parameters.spins array
 +
 +
    parameters.max_rank - maximum harmonic rank to retain in
 +
                          the solution (increase till conver-
 +
                          gence is achieved, approximately
 +
                          equal to the number of spinning si-
 +
                          debands in the spectrum)
 +
 +
    parameters.grid    - spherical grid file name. See grids
 +
                          directory in the kernel.
  
  parameters.spins    - a cell array giving the spins that
+
Additional subfields may be required by the pulse sequence. The parameters structure is passed to the pulse sequence with the following additional parameters set:
                        the pulse sequence involves, e.g.
 
                        {'1H','13C'}
 
  
  parameters.offset  - a cell array giving transmitter off-
+
    parameters.spc_dim  - matrix dimension for the spatial
                        sets in Hz on each of the spins listed
+
                          dynamics subspace
                        in parameters.spins array
+
 +
    parameters.spn_dim  - matrix dimension for the spin
 +
                          dynamics subspace
  
  parameters.max_rank - maximum harmonic rank to retain in
+
==Outputs==
                        the solution (increase till conver-
+
This function returns the powder average of whatever it is that the pulse sequence returns.
                        gence is achieved, approximately
 
                        equal to the number of spinning si-
 
                        debands in the spectrum)
 
  
  parameters.grid    - spherical grid file name. See grids
+
==Examples==
                        directory in the kernel.
+
The following example files in the Spinach example set make use of this context function:
  
Additional subfields may be required by the pulse sequence. The parameters
+
'''nmr_solids/mas_powder_trp_floquet.m''' - large-scale simulation of tryptophan 13C MAS NMR
structure is passed to the pulse sequence with the following additional
 
parameters set:
 
  
  parameters.spc_dim  - matrix dimension for the spatial
+
'''nmr_solids/mas_powder_gly_floquet.m''' - glycine 13C MAS NMR spectrum
                        dynamics subspace
 
  
  parameters.spn_dim  - matrix dimension for the spin
+
'''nmr_solids/mas_powder_suc_floquet.m''' - large-scale simulation of sucrose 13C MAS NMR
                        dynamics subspace
 
  
This function returns the powder average of whatever it is that the pulse
+
'''nmr_solids/mas_powder_ala_floquet.m''' - alanine 13C MAS NMR spectrum
sequence returns.
 
  
Note: the choice of the rank depends on the spinning rate (the slower
+
'''nmr_solids/mas_powder_nqi_floquet.m''' - deuterium NQI MAS NMR, no second-order rotating frame corrections
the spinning, the greater ranks are required). The rank is appro-
+
 
 +
'''nmr_solids/mas_powder_dip_floquet.m''' - MAS NMR on a pair of dipole coupled spins
 +
 
 +
'''nmr_solids/mas_powder_csa_floquet.m''' - MAS NMR on a simple system with a CSA
 +
 
 +
==Notes==
 +
#The choice of the rank depends on the spinning rate (the slower the spinning, the greater ranks are required). The rank is appro-
 
ximately equal to the number of spinning sidebands.
 
ximately equal to the number of spinning sidebands.
 +
#The state projector assumes a powder - single crystal MAS is not supported, use [[singlerot.m]] instead.
 +
#Terturbative corrections to the rotating frame transformation are not supported - use [[singlerot.m]] instead.
 +
 +
 +
==See also==
 +
[[powder.m]], [[liquid.m]], [[roadmap.m]], [[singlerot.m]], [[doublerot.m]], [[imaging.m]], [[gridfree.m]], [[crystal.m]]
 +
  
Note: the state projector assumes a powder -- single crystal MAS is not
+
''Version 2.2, authors: [[Ilya Kuprov]], [[Luke Edwards]]''
currently supported.
 

Revision as of 11:52, 8 July 2018

Floquet magic angle spinning context. This function generates Floquet Hamiltonian at a particular orientation, relaxation superoperator, kinetics superoperator, applies the necessary offsets, updates the parameter set, and passes all of that to the pulse sequence, which should be supplied as a handle. Parallel powder averaging is applied.

Syntax

    answer=floquet(spin_system,@pulse_sequence,parameters,assumptions)

Arguments

    @pulse_sequence     - pulse sequence function handle

    parameters.rate     - spinning rate in Hz

    parameters.axis     - spinning axis, given as a normalized
                          3-element vector

    parameters.spins    - a cell array giving the spins that 
                          the pulse sequence involves, e.g. 
                          {'1H','13C'}

    parameters.offset   - a cell array giving transmitter off-
                          sets in Hz on each of the spins listed
                          in parameters.spins array

    parameters.max_rank - maximum harmonic rank to retain in
                          the solution (increase till conver-
                          gence is achieved, approximately
                          equal to the number of spinning si-
                          debands in the spectrum)

    parameters.grid     - spherical grid file name. See grids
                          directory in the kernel.

Additional subfields may be required by the pulse sequence. The parameters structure is passed to the pulse sequence with the following additional parameters set:

    parameters.spc_dim  - matrix dimension for the spatial
                          dynamics subspace

    parameters.spn_dim  - matrix dimension for the spin 
                          dynamics subspace

Outputs

This function returns the powder average of whatever it is that the pulse sequence returns.

Examples

The following example files in the Spinach example set make use of this context function:

nmr_solids/mas_powder_trp_floquet.m - large-scale simulation of tryptophan 13C MAS NMR

nmr_solids/mas_powder_gly_floquet.m - glycine 13C MAS NMR spectrum

nmr_solids/mas_powder_suc_floquet.m - large-scale simulation of sucrose 13C MAS NMR

nmr_solids/mas_powder_ala_floquet.m - alanine 13C MAS NMR spectrum

nmr_solids/mas_powder_nqi_floquet.m - deuterium NQI MAS NMR, no second-order rotating frame corrections

nmr_solids/mas_powder_dip_floquet.m - MAS NMR on a pair of dipole coupled spins

nmr_solids/mas_powder_csa_floquet.m - MAS NMR on a simple system with a CSA

Notes

  1. The choice of the rank depends on the spinning rate (the slower the spinning, the greater ranks are required). The rank is appro-

ximately equal to the number of spinning sidebands.

  1. The state projector assumes a powder - single crystal MAS is not supported, use singlerot.m instead.
  2. Terturbative corrections to the rotating frame transformation are not supported - use singlerot.m instead.


See also

powder.m, liquid.m, roadmap.m, singlerot.m, doublerot.m, imaging.m, gridfree.m, crystal.m


Version 2.2, authors: Ilya Kuprov, Luke Edwards