Difference between revisions of "Ngridpts.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)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:ngridpts.m}} __NOTOC__
 
{{DISPLAYTITLE:ngridpts.m}} __NOTOC__
 
+
Estimates the minimum number of spatial grid points needed for a valid explicit spatial-grid treatment of gradient-driven experiments by checking the Larmor condition for the tightest possible gradient spiral.
Estimates the minimum number of spatial grid points necessary to have a valid treatment of gradient driven experiments with explicit digitization of spatial dimensions.
 
  
 
==Syntax==
 
==Syntax==
  
n=ngridpts(grad_amps,grad_durs,isotope,max_coh_order,sample_size)
+
    n=ngridpts(grad_amps,grad_durs,isotope,max_coh_order)
  
==Arguments==
+
==Parameters==
  
grad_amps    - a row vector of all gradient amplitudes
+
  grad_amps    - a row vector of all gradient amplitudes
 
                   in the sequence, T/m
 
                   in the sequence, T/m
 
   
 
   
Line 26: Line 25:
 
==Outputs==
 
==Outputs==
  
n - the minimum recommended number of discretisation points
+
  n - the minimum recommended number of discretisation points
  
 
==Notes==
 
==Notes==
 
 
The function returns the minimum number of points, it may in practice be necessary to have several times the number, depending on your accuracy requirements.
 
The function returns the minimum number of points, it may in practice be necessary to have several times the number, depending on your accuracy requirements.
  
 
==See also==
 
==See also==
 
+
[[imaging.m]], [[fdmat.m]], [[hydrodynamics.m]], [[g2fplanck.m]], [[mri_2d_plot.m]], [[phantoms.m]], [[v2fplanck.m]], [[Imaging_module]]
[[imaging.m]], [[fdmat.m]], [[hydrodynamics.m]]
 
 
 
  
 
''Version 2.1, authors: [[Ilya Kuprov]]''
 
''Version 2.1, authors: [[Ilya Kuprov]]''
 
==Description==
 
 
The function checks the Larmor condition for the tightest possible gradient spiral.
 

Latest revision as of 19:39, 6 June 2026

Estimates the minimum number of spatial grid points needed for a valid explicit spatial-grid treatment of gradient-driven experiments by checking the Larmor condition for the tightest possible gradient spiral.

Syntax

    n=ngridpts(grad_amps,grad_durs,isotope,max_coh_order)

Parameters

  grad_amps     - a row vector of all gradient amplitudes
                  in the sequence, T/m

  grad_durs     - a row vector of all gradient durations 
                  in the sequence, s

  isotope       - the highest magnetogyric ratio isotope in
                  the spin system, e.g. '1H'

  max_coh_order - maximum order of coherence (either positive
                  or negative) expected during the experiment
                  being simulated

  sample_size   - spatial extent of the sample, m

Outputs

  n - the minimum recommended number of discretisation points

Notes

The function returns the minimum number of points, it may in practice be necessary to have several times the number, depending on your accuracy requirements.

See also

imaging.m, fdmat.m, hydrodynamics.m, g2fplanck.m, mri_2d_plot.m, phantoms.m, v2fplanck.m, Imaging_module

Version 2.1, authors: Ilya Kuprov