Difference between revisions of "Correlation.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
(Update function See also links and function index membership)
 
(One intermediate revision by the same user not shown)
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
Line 23: Line 23:
  
 
==See also==
 
==See also==
[[Kernel_functions#Coherence_order_selection|Coherence order selection]]
+
[[adelim.m]], [[coherence.m]], [[dfpt.m]], [[homospoil.m]], [[human2opspec.m]], [[lin2lm.m]], [[lin2lmn.m]], [[lm2lin.m]], [[lmn2lin.m]], [[path_trace.m]], [[scomponents.m]], [[sinkhole.m]], [[sparse2csr.m]], [[sphten2zeeman.m]], [[stitch.m]], [[zte.m]], [[Kernel_functions]], [[Kernel_utilities]]
 
 
[[Kernel_utilities#State_space_indexing_and_manipulation|State space indexing and manipulation]]
 
  
 
''Version 2.8, authors: [[Ilya Kuprov]], [[Luke Edwards]]''
 
''Version 2.8, authors: [[Ilya Kuprov]], [[Luke Edwards]]''

Latest revision as of 19:35, 6 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

adelim.m, coherence.m, dfpt.m, homospoil.m, human2opspec.m, lin2lm.m, lin2lmn.m, lm2lin.m, lmn2lin.m, path_trace.m, scomponents.m, sinkhole.m, sparse2csr.m, sphten2zeeman.m, stitch.m, zte.m, Kernel_functions, Kernel_utilities

Version 2.8, authors: Ilya Kuprov, Luke Edwards