Difference between revisions of "Ctrl trajan.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(→‎See also)
(Update function See also links and function index membership)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:ctrl_trajan.m}}
+
{{DISPLAYTITLE:ctrl_trajan.m}} __NOTOC__
−
 
+
Diagnostic plotting function for the optimal control toolbox that plots trajectory and control-pulse analysis; it is called internally by the optimal control module, and all settings should be specified through [[optimcon.m]] when the optimal control problem is set up.
−
Diagnostic plotting function for optimal control toolbox. Plots trajectory and control pulse analysis.
 
  
 
==Syntax==
 
==Syntax==
Line 7: Line 6:
 
     ctrl_trajan(spin_system,waveform,trajectory,fidelities)
 
     ctrl_trajan(spin_system,waveform,trajectory,fidelities)
  
−
==Description==
+
==Parameters==
−
This function is called internally by the optimal control module, you should not be calling it directly. All settings should be specified in the call to [[optimcon.m]] when the optimal control problem is set up.
 
−
 
 
−
==Arguments==
 
  
 
     waveform  - waveform, as supplied to a user-end
 
     waveform  - waveform, as supplied to a user-end
Line 29: Line 25:
  
 
==See also==
 
==See also==
−
[[grape_xy.m]], [[grape_phase.m]], [[optimcon.m]], [[trajan.m]], [[trajsimil.m]]
+
[[grape_xy.m]], [[grape_phase.m]], [[optimcon.m]], [[trajan.m]], [[trajsimil.m]], [[bruker_write.m]], [[fapt2sfo.m]], [[heterodyne.m]], [[inst_freq.m]], [[read_wave.m]], [[Optimal_control_module]]
−
 
 
  
 
''Version 2.0, authors: [[Ilya Kuprov]], [[David Goodwin]]''
 
''Version 2.0, authors: [[Ilya Kuprov]], [[David Goodwin]]''

Latest revision as of 19:35, 6 June 2026

Diagnostic plotting function for the optimal control toolbox that plots trajectory and control-pulse analysis; it is called internally by the optimal control module, and all settings should be specified through optimcon.m when the optimal control problem is set up.

Syntax

    ctrl_trajan(spin_system,waveform,trajectory,fidelities)

Parameters

    waveform   - waveform, as supplied to a user-end
                 function, such as grape_xy.m

    trajectory - spin system trajectory, a stack of
                 complex vectors

    fidelities - fidelities array, as returned by 
                 user-end functions, such as grape_xy

Returns

The function plots a graph similar to the one below. Ctrl trajan figure.png

Examples

See the optimal control examples in the standard example set - all of them make use of this function indirectly when they are calling Spinach optimal control functionality.

See also

grape_xy.m, grape_phase.m, optimcon.m, trajan.m, trajsimil.m, bruker_write.m, fapt2sfo.m, heterodyne.m, inst_freq.m, read_wave.m, Optimal_control_module

Version 2.0, authors: Ilya Kuprov, David Goodwin