Product Documentation
Virtuoso Visualization and Analysis XL SKILL Reference
Product Version IC23.1, November 2023

awvPlotWaveformOption

awvPlotWaveformOption(
w_windowID
x_waveIndex
t_plotOption
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Sets the specified plotting option for a waveform in a subwindow.

Arguments

w_windowID

Waveform window ID.

x_waveIndex

Index number of the waveform.

You can use the awvGetWaveNameList function to return a list of index numbers of the waveforms plotted in a subwindow.

t_plotOption

Specifies the plotting option of the specified waveform.

Valid values are:

  • magnitude: Plots the magnitude of the waveform against an independent variable.
  • dB10: Calculates 10*log of the magnitude of each point in the waveform and plots the results against an independent variable.
  • dB20: Calculates 20*log of the magnitude of each point in the waveform and plots the results against an independent variable.
  • dBm: Adds 30 to the value calculated by dB10.
  • phaseDeg: Plots the phase, in degrees, of the waveform against an independent variable.
  • phaseRad: Plots the phase, in radians, of the waveform against an independent variable.
  • wrappedPhaseDeg: Plots the wrapped phase, in degrees, of the waveform against an independent variable.
  • wrappedPhaseRad: Plots the wrapped phase, in radians, of the waveform against an independent variable.
  • real: Plots the real part of the waveform against an independent variable.
  • imaginary: Plots the imaginary part of the waveform against an independent variable.

?subwindow x_subwindow

Identification number of the subwindow, which is found in the top-right corner of the subwindow.

If you do not specify this argument, the current subwindow is used.

Value Returned

t

The specified plotting option for the waveform is set successfully.

nil

The specified Waveform window, subwindow, or the waveform index does not exist.

Examples

The following example returns the indexes and signal names of the waveforms plotted in the subwindow 2 of the current Waveform window.

win=awvGetCurrentWindow()
=> window:4
awvGetWaveNameList(win ?subwindow 2)
=>
((26 17 18 19) 
    ("/net027" "/net028" "/net029" "/net030")
)

The following example sets the plotting option for the waveform net029 to dB20 in the subwindow 2 of the specified Waveform window.

awvPlotWaveformOption(
      window(4)
      18
      "dB20"
      ?subwindow 2
      )
=> t

Return to top
 ⠀
X