Difference between revisions of "Nearest spin.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
(Update function See also links and function index membership)
 
(3 intermediate revisions by the same user not shown)
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,d]=nearest_spin(spin_system,n)
+
    k=nearest_spin(spin_system,n)
  
==Arguments==
+
==Parameters==
  
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==
 
+
[[chemshifts.m]], [[cubic_lattice.m]], [[dilute.m]], [[get_coupling.m]], [[gtensorof.m]], [[idxof.m]], [[iselectron.m]], [[isnucleus.m]], [[isoswap.m]], [[kill_spin.m]], [[shift_iso.m]], [[Spin system specification]], [[Kernel_utilities]]
[[Spin system specification]]
 
 
 
[[Kernel_utilities#Spin_system_editing|Spin system editing]]
 
 
 
  
 
''Version 2.8, authors: [[Ilya Kuprov]]''
 
''Version 2.8, authors: [[Ilya Kuprov]]''

Latest revision as of 19:39, 6 June 2026

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

Syntax

    k=nearest_spin(spin_system,n)

Parameters

    n   - index of the spin in question

Outputs

    k   - index of the nearest spin

See also

chemshifts.m, cubic_lattice.m, dilute.m, get_coupling.m, gtensorof.m, idxof.m, iselectron.m, isnucleus.m, isoswap.m, kill_spin.m, shift_iso.m, Spin system specification, Kernel_utilities

Version 2.8, authors: Ilya Kuprov