Difference between revisions of "Correlation.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
m (Rename Arguments section heading to Parameters)
Line 6: Line 6:
 
     rho=correlation(spin_system,rho,correlation_orders,spins)
 
     rho=correlation(spin_system,rho,correlation_orders,spins)
  
==Arguments==
+
==Parameters==
  
 
   rho    -  a state vector or a horizontal stack thereof
 
   rho    -  a state vector or a horizontal stack thereof

Revision as of 18:47, 5 June 2026

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)

Parameters

  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 order selection

State space indexing and manipulation

Version 2.8, authors: Ilya Kuprov, Luke Edwards