electricpy.bode.zbode

electricpy.bode.zbode(f, dt=0.01, NN=1000, title='', mn=0, mx=6.283185307179586, xlim=False, ylim=False, approx=False, sv=False, disp3db=False, lowcut=None, magnitude=True, angle=True)[source]

Z-Domain Bode Plotting Function.

Parameters:

  • f (function) – The Input Function, must be callable function object. Must be specified as transfer function of type: - S-Domain (when approx=False, default) - Z-Domain (when approx=True)

  • dt (float, optional) – The time-step used, default=0.01

  • NN (int, optional) – The Interval over which to be generated, default=1000

  • mn (float, optional) – The minimum phi value to be generated, default=0

  • mx (float, optional) – The maximum phi value to be generated, default=2*pi

  • approx (bool, optional, callable) – Control argument to specify whether input funciton should be treated as Z-Domain function or approximated Z-Domain function. default=False

  • title (string, optional) – Additional string to be added to plot titles; default=””.

  • xlim (list of float, optional) – Limit in x-axis for graph plot. Accepts tuple of: (xmin, xmax). Default is False.

  • ylim (list of float, optional) – Limit in y-axis for graph plot. Accepts tuple of: (ymin, ymax). Default is False.

  • sv (bool, optional) – Save the plots as PNG files. Default is False.

  • disp3db (bool, optional) – Control argument to enable the display of the 3dB line, default=False.

  • lowcut (float, optional) – An additional marking line that can be plotted, default=None

  • magnitude (bool, optional) – Control argument to enable plotting of magnitude, default=True

  • angle (bool, optional) – Control argument to enable plotting of angle, default=True