Difference between revisions of "Correlation.m"

From Spinach Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
Correlation order selection function - keeps only the specified orders of spin correlation in the state vector. Syntax:
+
{{DISPLAYTITLE:correlation.m}}
 +
Correlation order selection function - keeps only the specified orders of spin correlation in the state vector. This is useful as a replacement for gradients and phase cycles because correlation order filtering can be accomplished analytically, by just picking out the required correlation orders and zeroing everything else.
 +
 
 +
==Syntax==
  
 
     rho=correlation(spin_system,rho,correlation_orders,spins)
 
     rho=correlation(spin_system,rho,correlation_orders,spins)
  
Arguments:
+
==Arguments==
 +
 
 +
  rho    -  a state vector or a horizontal stack thereof
 +
 +
  orders  -  a row vector of correlation orders to keep
 +
 +
  spins  -  which spins to consider (e.g. '1H', '13C', 'all')
 +
 
 +
==Outputs==
 +
 
 +
  rho    - the state vector with the undesired orders of
 +
            spin correlations zeroed out
  
    rho                -  a state vector or a horizontal stack thereof
+
==Notes==
    correlation_orders -  a row vector of correlation orders to keep
+
Because quantum number information is required for this function to work, it is restricted to sphten-liouv formalism. It supports Fokker-Planck direct products.
    spins              - which spins to count (e.g. '1H', '13C', 'all')
 
  
If rho is left empty then the binary state mask is returned, with ones for the states that should be kept and zeros for the states that should be wiped.
+
==See also==
 +
[[coherence.m]], [[decouple.m]]
  
This is useful as a replacement for gradients and phase cycles because coherence order filtering can be accomplished analytically, by just picking out the required coherence orders and zeroing everything else. Because projection quantum number information is required for this function to work, it is restricted to sphten-liouv formalism.
+
''Version 2.2, authors: [[Ilya Kuprov]], [[Luke Edwards]]''

Revision as of 14:24, 28 August 2018

Correlation order selection function - keeps only the specified orders of spin correlation in the state vector. This is useful as a replacement for gradients and phase cycles because correlation order filtering can be accomplished analytically, by just picking out the required correlation orders and zeroing everything else.

Syntax

    rho=correlation(spin_system,rho,correlation_orders,spins)

Arguments

  rho     -  a state vector or a horizontal stack thereof

  orders  -  a row vector of correlation orders to keep

  spins   -  which spins to consider (e.g. '1H', '13C', 'all')

Outputs

  rho     - the state vector with the undesired orders of
            spin correlations zeroed out

Notes

Because quantum number information is required for this function to work, it is restricted to sphten-liouv formalism. It supports Fokker-Planck direct products.

See also

coherence.m, decouple.m

Version 2.2, authors: Ilya Kuprov, Luke Edwards