Amp tanh.m - Revision history

Kuprov: Update function See also links and function index membership

2026-06-06T18:34:20Z

Update function See also links and function index membership

Kuprov: Rename Arguments section heading to Parameters

2026-06-05T17:47:18Z

Rename Arguments section heading to Parameters

Kuprov: Normalise sequential blank lines

2026-04-25T11:23:07Z

Normalise sequential blank lines

Kuprov: Restore pre-bulk-edit wiki content

2026-04-05T14:47:50Z

Restore pre-bulk-edit wiki content

Kuprov: Sync syntax/arguments/outputs with current Spinach source

2026-04-05T14:05:04Z

Sync syntax/arguments/outputs with current Spinach source

Kuprov: Created page with "{{DISPLAYTITLE:amp_tanh.m}} NOTOC Amplifier compression distortion model. Applies a saturating hyperbolic tangent distortion to the user-supplied waveform: y=a*tanh(..."

2025-05-17T11:11:58Z

Created page with "{{DISPLAYTITLE:amp_tanh.m}} __NOTOC__ Amplifier compression distortion model. Applies a saturating hyperbolic tangent distortion to the user-supplied waveform: y=a*tanh(..."

New page

{{DISPLAYTITLE:amp_tanh.m}} __NOTOC__
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)

==Arguments==

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==
[[Optimal_control_module#Optimal_control_function_list:_distortions_and_penalties|Optimal_control_function_list:_distortions_and_penalties]]

''Version 2.11, authors: [[Uluk Rasulov]], [[Ilya Kuprov]]''

@@ Line 32: / Line 32: @@
 ==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]]''

@@ Line 12: / Line 12: @@
      [w,J]=amp_tanh(w,sat_lvls)
-==Arguments==
+==Parameters==
      w         - waveform in rad/s nutation frequency units,

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:amp_tanh.m}} __NOTOC__
 Amplifier compression distortion model. Applies a saturating hyperbolic tangent
 distortion to the user-supplied waveform:
@@ Line 11: / Line 10: @@
 ==Syntax==
-[w,J]=amp_tanh(w,sat_lvls)
+    [w,J]=amp_tanh(w,sat_lvls)
 ==Arguments==
-w         - waveform in rad/s nutation frequency units,
+    w         - waveform in rad/s nutation frequency units,
-                 one time slice per column, and rows arran-
+                 one time slice per column, and rows arranged
-                 ged as XYXY... with respect to in-phase and
+                 as XYXY... with respect to in-phase and
                  quadrature parts on each control channel
-−
-     sat_lvls  - saturation levels beyond which the amplifi-
+     sat_lvls  - saturation levels beyond which the amplifier
-                 er cannot go, one value per X,Y pair in w,
+                 cannot go, one value per X,Y pair in w, giving
-                 giving the maximum output sqrt(X^2+Y^2)
+                 the maximum output sqrt(X^2+Y^2)
 ==Outputs==
-w         - distorted waveform in the same units and
+    w         - distorted waveform in the same units and
                  layout as the input
@@ Line 33: / Line 32: @@
 ==See also==
 [[Optimal_control_module#Optimal_control_function_list:_distortions_and_penalties|Optimal_control_function_list:_distortions_and_penalties]]
 ''Version 2.11, authors: [[Uluk Rasulov]], [[Ilya Kuprov]]''