Model.xyplotchangemode

Model.xyplotchangemode(plotname, mode)

Changes the mode of an extended plot.

Parameters:

• plotname (hwString) – Name of the extended (dual) plot to change.

• mode (int) –

  Mode in which data will be displayed. Valid options are:

  2 - Complex mode.

  5 - Phase/Magnitude mode.

Note

Extended (or dual) plots can display data in two modes. In complex mode, (mode=2), the Y-axis of the bottom plot is the real component, while the Y-axis of the top plot is the imaginary component. In phase/magnitude mode (mode=5), the Y-axis of the bottom plot is magnitude (in logarithmic form), while the Y-axis of the top plot is phase. Other mode indices (besides 2 and 5) are reserved for future use.

Example

Change the mode of plot with name * results * to * Phase / Magnitude *

import hm
import hm.entities as ent

model = hm.Model()

model.xyplotchangemode(plotname="results", mode=5)