Difference between revisions of "Amp root.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:amp_root.m}} __NOTOC__ Amplifier compression distortion model. Applies a saturating root-sigmoidal distortion to the waveform amplitude: y=x/(1+(x/a)^s)^(...")
 
(Update function See also links and function index membership)
 
(2 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
     [w,J]=amp_root(w,sat_lvls,s)
 
     [w,J]=amp_root(w,sat_lvls,s)
  
==Arguments==
+
==Parameters==
  
 
     w        - waveform in rad/s nutation frequency units,
 
     w        - waveform in rad/s nutation frequency units,
Line 35: Line 35:
  
 
==See also==
 
==See also==
[[Optimal_control_module#Optimal_control_function_list:_distortions_and_penalties|Optimal_control_function_list:_distortions_and_penalties]]
+
[[amp_tanh.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 root-sigmoidal distortion to the waveform amplitude:

    y=x/(1+(x/a)^s)^(1/s)

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_root(w,sat_lvls,s)

Parameters

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

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

   s         - a vector of positive integers (one value per
               X,Y pair in w) regulating the sharpness of
               the transition from linear to saturating be-
               haviour, a good starting choice is 4

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_tanh.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