Difference between revisions of "Nearest spin.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
Line 1: Line 1:
 
{{DISPLAYTITLE:nearest_spin.m}} __NOTOC__
 
{{DISPLAYTITLE:nearest_spin.m}} __NOTOC__
 +
 
Returns the index of the nearest spin to the one specified. Only spins for which Cartesian coordinates are available are considered.
 
Returns the index of the nearest spin to the one specified. Only spins for which Cartesian coordinates are available are considered.
  
 
==Syntax==
 
==Syntax==
  
    k=nearest_spin(spin_system,n)
+
[k,d]=nearest_spin(spin_system,n)
  
 
==Arguments==
 
==Arguments==
  
    n  - index of the spin in question
+
n  - index of the spin in question
  
 
==Outputs==
 
==Outputs==
  
    k  - index of the nearest spin
+
k  - index of the nearest spin
 +
 
 +
    d  - distance to the nearest spin, Angstrom
 +
 
 +
ilya.kuprov@weizmann.ac.il
  
 
==See also==
 
==See also==
 +
 
[[Spin system specification]]
 
[[Spin system specification]]
  

Revision as of 15:03, 5 April 2026


Returns the index of the nearest spin to the one specified. Only spins for which Cartesian coordinates are available are considered.

Syntax

[k,d]=nearest_spin(spin_system,n)

Arguments

n - index of the spin in question

Outputs

k - index of the nearest spin

   d   - distance to the nearest spin, Angstrom
ilya.kuprov@weizmann.ac.il

See also

Spin system specification

Spin system editing


Version 2.8, authors: Ilya Kuprov