Difference between revisions of "Amp tanh.m"

From Spinach Documentation Wiki
Jump to: navigation, search
m (Rename Arguments section heading to Parameters)
(Update function See also links and function index membership)
 
Line 32: Line 32:
  
 
==See also==
 
==See also==
−
[[Optimal_control_module#Optimal_control_function_list:_distortions_and_penalties|Optimal_control_function_list:_distortions_and_penalties]]
+
[[amp_root.m]], [[firf.m]], [[kernelest.m]], [[no_dist.m]], [[penalty.m]], [[restrans.m]], [[spf.m]], [[szf.m]], [[transfermat.m]], [[Optimal_control_module]]
  
 
''Version 2.11, authors: [[Uluk Rasulov]], [[Ilya Kuprov]]''
 
''Version 2.11, authors: [[Uluk Rasulov]], [[Ilya Kuprov]]''

Latest revision as of 19:34, 6 June 2026

Amplifier compression distortion model. Applies a saturating hyperbolic tangent distortion to the user-supplied waveform:

   y=a*tanh(x/a)

Treats odd channels of multi-channel waveform as X and even ones as Y components; the autodiff Jacobian is returned for the vectorisation of the input array.

Syntax

   [w,J]=amp_tanh(w,sat_lvls)

Parameters

   w         - waveform in rad/s nutation frequency units, 
               one time slice per column, and rows arranged 
               as XYXY... with respect to in-phase and 
               quadrature parts on each control channel

   sat_lvls  - saturation levels beyond which the amplifier 
               cannot go, one value per X,Y pair in w, giving
               the maximum output sqrt(X^2+Y^2)

Outputs

   w         - distorted waveform in the same units and 
               layout as the input

   J         - distortion Jacobian matrix with respect 
               to the vectorisation of the input, sparse

See also

amp_root.m, firf.m, kernelest.m, no_dist.m, penalty.m, restrans.m, spf.m, szf.m, transfermat.m, Optimal_control_module

Version 2.11, authors: Uluk Rasulov, Ilya Kuprov