From 210a940181d3ba84d3a77ac4c21466fa398d61d5 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Wed, 17 Nov 2021 03:01:09 +0000 Subject: CTAN sync 202111170301 --- graphics/pgf/contrib/bodeplot/README.md | 86 ++++++++++++++++----------------- 1 file changed, 43 insertions(+), 43 deletions(-) (limited to 'graphics/pgf/contrib/bodeplot/README.md') diff --git a/graphics/pgf/contrib/bodeplot/README.md b/graphics/pgf/contrib/bodeplot/README.md index f00aca2523..51253697ee 100644 --- a/graphics/pgf/contrib/bodeplot/README.md +++ b/graphics/pgf/contrib/bodeplot/README.md @@ -1,43 +1,43 @@ -# bodeplot -LaTeX package to plot Bode, Nichols, and Nyquist diagrams. - -Inspired by the `bodegraph` package. - -Limitation: Phase plots from TF commands are wrapped between 0 and 360 degrees. - -Added functionality: - - New `\BodeZPK` and `\BodeTF` commands to generate Bode plots of any transfer function given either poles, zeros, gain, and delay, or numerator and denominator coefficients and delay - - Support for unstable poles and zeros. - - Support for complex poles and zeros. - - Support for general stable and unstable second order transfer functions. - - Support for both `gnuplot` (default) and `pgfplots` (package option `pgf`). - - Support for linear and asymptotic approximation of magnitude and phase plots of any transfer function given poles, zeros, and gain. - -Main Bode/Nyquist/Nichols commands: -Given Zeros, Poles, Gain, and Delay (Bode plots support asymptotic and linear approximation for systems without delays): - - `\BodeZPK[object1/type1/{options1},object2/type2/{options2},...]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` - - `\NicholsZPK[plot/{options},axes/{options}]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` - - `\NyquistZPK[plot/{options},axes/{options}]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` - -Given Numerator and denominator coefficients and delay (does not support approximation yet): - - `\BodeTF[object1/type1/{options1},object2/type2/{options2},...]{num/{coeff},den/{coeff},d/delay}{min-frequency}{max-frequency}` - - `\NicholsTF[plot/{options},axes/{options}]{num/{coeff},den/{coeff},d/delay}` - - `\NyquistTF[plot/{options},axes/{options}]{num/{coeff},den/{coeff},d/delay}` - -Other new environments and associated commands: - - `BodePlot` environment - - `\addBodeZPKPlots[{approximation1/{plot-options1}},{approximation2/{plot-options2}},...]{plot-type (phase or magnitude)}{z/{zeros},p/{poles},k/gain,d/delay}` - - `\addBodeTFPlot[plot-options]{plot-type (phase or magnitude)}{num/{coeff},den/{coeff},d/delay}` - - `\addBodeComponentPlot[plot-options]{basic_component_plot_command}` - - Basic component plot commands: ***(append `Lin` to get linear approximation and `Asymp` to get asymptotic approximation)*** ***(change `Pole` to `Zero` to get inverse plots)*** ***(change `Mag` to `Ph` to get phase plots)*** - - `\MagK{a}` - Pure gain, G(s) = a. - - `\MagPole{a}{b}` - Single pole at s = a+bi, G(s) = 1/(s - a-bi). - - `\MagCSPoles{z}{w}` - Cannonical Second order system, G(s) = 1/(s^2 + 2zws + w^2). - - `\MagSOPoles{a}{b}` - Second Order system, G(s) = 1/(s^2 + as + b). - - `\MagDel{T}` - Pure delay, G(s) = exp(-Ts) (does not admit asymptotic approximation). - - `NicholsChart` environment - - `\addNicholsZPKChart[plot-options]{z/{zeros},p/{poles},k/gain,d/delay}` - - `\addNicholsTFChart[plot-options]{num/{coeff},den/{coeff},d/delay}` - - `NyquistPlot` environment - - `\addNyquistZPKPlot[plot-options]{z/{zeros},p/{poles},k/gain,d/delay}` - - `\addNyquistTFPlot[plot-options]{num/{coeff},den/{coeff},d/delay}` +# bodeplot +LaTeX package to plot Bode, Nichols, and Nyquist diagrams. + +Inspired by the `bodegraph` package. + +Limitation: Phase plots from TF commands are wrapped between 0 and 360 degrees. + +Added functionality: + - New `\BodeZPK` and `\BodeTF` commands to generate Bode plots of any transfer function given either poles, zeros, gain, and delay, or numerator and denominator coefficients and delay + - Support for unstable poles and zeros. + - Support for complex poles and zeros. + - Support for general stable and unstable second order transfer functions. + - Support for both `gnuplot` (default) and `pgfplots` (package option `pgf`). + - Support for linear and asymptotic approximation of magnitude and phase plots of any transfer function given poles, zeros, and gain. + +Main Bode/Nyquist/Nichols commands: +Given Zeros, Poles, Gain, and Delay (Bode plots support asymptotic and linear approximation for systems without delays): + - `\BodeZPK[object1/type1/{options1},object2/type2/{options2},...]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` + - `\NicholsZPK[plot/{options},axes/{options}]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` + - `\NyquistZPK[plot/{options},axes/{options}]{z/{zeros},p/{poles},k/gain,d/delay}{min-frequency}{max-frequency}` + +Given Numerator and denominator coefficients and delay (does not support approximation yet): + - `\BodeTF[object1/type1/{options1},object2/type2/{options2},...]{num/{coeff},den/{coeff},d/delay}{min-frequency}{max-frequency}` + - `\NicholsTF[plot/{options},axes/{options}]{num/{coeff},den/{coeff},d/delay}` + - `\NyquistTF[plot/{options},axes/{options}]{num/{coeff},den/{coeff},d/delay}` + +Other new environments and associated commands: + - `BodePlot` environment + - `\addBodeZPKPlots[{approximation1/{plot-options1}},{approximation2/{plot-options2}},...]{plot-type (phase or magnitude)}{z/{zeros},p/{poles},k/gain,d/delay}` + - `\addBodeTFPlot[plot-options]{plot-type (phase or magnitude)}{num/{coeff},den/{coeff},d/delay}` + - `\addBodeComponentPlot[plot-options]{basic_component_plot_command}` + - Basic component plot commands: ***(append `Lin` to get linear approximation and `Asymp` to get asymptotic approximation)*** ***(change `Pole` to `Zero` to get inverse plots)*** ***(change `Mag` to `Ph` to get phase plots)*** + - `\MagK{a}` - Pure gain, G(s) = a. + - `\MagPole{a}{b}` - Single pole at s = a+bi, G(s) = 1/(s - a-bi). + - `\MagCSPoles{z}{w}` - Cannonical Second order system, G(s) = 1/(s^2 + 2zws + w^2). + - `\MagSOPoles{a}{b}` - Second Order system, G(s) = 1/(s^2 + as + b). + - `\MagDel{T}` - Pure delay, G(s) = exp(-Ts) (does not admit asymptotic approximation). + - `NicholsChart` environment + - `\addNicholsZPKChart[plot-options]{z/{zeros},p/{poles},k/gain,d/delay}` + - `\addNicholsTFChart[plot-options]{num/{coeff},den/{coeff},d/delay}` + - `NyquistPlot` environment + - `\addNyquistZPKPlot[plot-options]{z/{zeros},p/{poles},k/gain,d/delay}` + - `\addNyquistTFPlot[plot-options]{num/{coeff},den/{coeff},d/delay}` -- cgit v1.2.3