Difference between revisions of "Sp acquire.m"

From Spinach Documentation Wiki
Jump to: navigation, search
m (Add missing Version/authors metadata and remove raw author emails)
(sync with Spinach main f053e432: remove duplicated stale header block, add Syntax and Outputs sections, fix indentation)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:sp_acquire.m}} __NOTOC__
 
{{DISPLAYTITLE:sp_acquire.m}} __NOTOC__
 +
Soft pulse followed by acquisition. The soft pulse is simulated using the Fokker-Planck formalism.
  
−
Soft pulse followed by acquisition. The soft pulse is simulated using the Fokker-Planck formalism. Syntax:
+
==Syntax==
  
 
     fid=sp_acquire(spin_system,parameters,H,R,K)
 
     fid=sp_acquire(spin_system,parameters,H,R,K)
  
−
Parameters:
+
==Parameters==
  
−
     parameters.pulse_frq - frequency of the soft pulse, Hz
+
     parameters.pulse_frq - frequency of the soft pulse,
 +
                            relative to the frequency of
 +
                            the current rotating frame, Hz
 
   
 
   
 
     parameters.pulse_phi - phase of the soft pulse, rad
 
     parameters.pulse_phi - phase of the soft pulse, rad
 
   
 
   
−
     parameters.pulse_pwr - power of the soft pulse, Hz
+
     parameters.pulse_pwr - power of the soft pulse, rad/s
 
   
 
   
 
     parameters.pulse_dur - duration of the sof pulse, s
 
     parameters.pulse_dur - duration of the sof pulse, s
 
   
 
   
−
    parameters.pulse_rnk - Fokker-Planck cut-off rank
 
−
 
−
    parameters.method  - method to use during the call
 
−
                          to shaped_pulse_af()
 
−
 
−
The last parameter should be increased until convergence is achieved in the output.
 
−
 
−
 
−
==Arguments==
 
−
 
−
parameters.pulse_frq - frequency of the soft pulse,
 
−
                            relative to the frequency of
 
−
                            the current rotating frame, Hz
 
−
 
−
    parameters.pulse_phi - phase of the soft pulse, rad
 
−
 
−
    parameters.pulse_pwr - power of the soft pulse, rad/s
 
−
 
−
    parameters.pulse_dur - duration of the sof pulse, s
 
−
 
 
     parameters.pulse_rnk - Fokker-Planck cut-off rank,
 
     parameters.pulse_rnk - Fokker-Planck cut-off rank,
 
                             a small integer: start with 2
 
                             a small integer: start with 2
 
                             and increase until the answer
 
                             and increase until the answer
 
                             stops changing
 
                             stops changing
−
 
+
 
     parameters.offset    - transmitter / receiver offset
 
     parameters.offset    - transmitter / receiver offset
 
                             for the time domain pulses and
 
                             for the time domain pulses and
 
                             detection, relative to the cur-
 
                             detection, relative to the cur-
 
                             rent rotating frame, Hz
 
                             rent rotating frame, Hz
−
 
+
 
     parameters.sweep    - sweep width for time domain
 
     parameters.sweep    - sweep width for time domain
 
                             detection, Hz
 
                             detection, Hz
−
 
+
 
     parameters.npoints  - number of points in the free
 
     parameters.npoints  - number of points in the free
 
                             induction decay
 
                             induction decay
−
 
+
 
     parameters.rho0      - initial state
 
     parameters.rho0      - initial state
−
 
+
 
     parameters.coil      - detection state
 
     parameters.coil      - detection state
−
 
+
 
     parameters.method    - soft puse propagation method,
 
     parameters.method    - soft puse propagation method,
 
                             'expv' for Krylov propagation,
 
                             'expv' for Krylov propagation,
Line 61: Line 44:
 
                             ach evolution function
 
                             ach evolution function
  
 +
==Outputs==
 +
 +
    fid - dynamics of the coil state as a function of time
  
 
==See also==
 
==See also==
−
[[acquire.m]], [[hp_acquire.m]], [[rapidscan.m]], [[Built-in_experiments#General_experiments|General experiments]]
+
[[acquire.m]], [[hp_acquire.m]], [[rapidscan.m]], [[cpmg.m]], [[holeburn.m]], [[impound.m]], [[relaxan.m]], [[slowpass.m]], [[traject.m]], [[Built-in_experiments]]
  
 
''Version 1.8, authors: [[Ilya Kuprov]]''
 
''Version 1.8, authors: [[Ilya Kuprov]]''

Latest revision as of 08:39, 30 August 2026

Soft pulse followed by acquisition. The soft pulse is simulated using the Fokker-Planck formalism.

Syntax

    fid=sp_acquire(spin_system,parameters,H,R,K)

Parameters

    parameters.pulse_frq - frequency of the soft pulse,
                           relative to the frequency of
                           the current rotating frame, Hz

    parameters.pulse_phi - phase of the soft pulse, rad

    parameters.pulse_pwr - power of the soft pulse, rad/s

    parameters.pulse_dur - duration of the sof pulse, s

    parameters.pulse_rnk - Fokker-Planck cut-off rank,
                           a small integer: start with 2
                           and increase until the answer
                           stops changing

    parameters.offset    - transmitter / receiver offset
                           for the time domain pulses and
                           detection, relative to the cur-
                           rent rotating frame, Hz

    parameters.sweep     - sweep width for time domain
                           detection, Hz

    parameters.npoints   - number of points in the free
                           induction decay

    parameters.rho0      - initial state

    parameters.coil      - detection state

    parameters.method    - soft puse propagation method,
                           'expv' for Krylov propagation,
                           'expm' for exponential propa-
                           gation, 'evolution' for Spin-
                           ach evolution function

Outputs

    fid - dynamics of the coil state as a function of time

See also

acquire.m, hp_acquire.m, rapidscan.m, cpmg.m, holeburn.m, impound.m, relaxan.m, slowpass.m, traject.m, Built-in_experiments

Version 1.8, authors: Ilya Kuprov