Average

SCPI Commands :

CALCulate:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
FETCh:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
READ:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
class AverageCls[source]

Average commands group definition. 3 total commands, 0 Subgroups, 3 group commands

calculate(list_index: int) → List[ResultStatus2][source]
# SCPI: CALCulate:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
value: List[enums.ResultStatus2] = driver.gprf.measurement.power.listPy.average.calculate(list_index = 1)
Returns power results for segment <ListIndex>, see ‘Results in list mode’.

INTRO_CMD_HELP: The following powers can be retrieved:

  • Current RMS (…:LIST:CURRent?)

  • Current Min. (…:MINimum:CURRent?)

  • Current Max. (…:MAXimum:CURRent?)

  • Average RMS (…:AVERage?)

  • Minimum (…:PEAK:MINimum?)

  • Maximum (…:PEAK:MAXimum?)

  • Standard Deviation (…:SDEViation?)

The values described below are returned by FETCh and READ commands. CALCulate commands return error codes instead, one value for each result listed below.

Suppressed linked return values: reliability

param list_index:

Index of the segment

return:

power_average_rms: Power value for the selected segment

fetch(list_index: int) → List[float][source]
# SCPI: FETCh:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
value: List[float] = driver.gprf.measurement.power.listPy.average.fetch(list_index = 1)
Returns power results for segment <ListIndex>, see ‘Results in list mode’.

INTRO_CMD_HELP: The following powers can be retrieved:

  • Current RMS (…:LIST:CURRent?)

  • Current Min. (…:MINimum:CURRent?)

  • Current Max. (…:MAXimum:CURRent?)

  • Average RMS (…:AVERage?)

  • Minimum (…:PEAK:MINimum?)

  • Maximum (…:PEAK:MAXimum?)

  • Standard Deviation (…:SDEViation?)

The values described below are returned by FETCh and READ commands. CALCulate commands return error codes instead, one value for each result listed below.

Suppressed linked return values: reliability

param list_index:

Index of the segment

return:

power_average_rms: Power value for the selected segment

read(list_index: int) → List[float][source]
# SCPI: READ:GPRF:MEASurement<Instance>:POWer:LIST:AVERage
value: List[float] = driver.gprf.measurement.power.listPy.average.read(list_index = 1)
Returns power results for segment <ListIndex>, see ‘Results in list mode’.

INTRO_CMD_HELP: The following powers can be retrieved:

  • Current RMS (…:LIST:CURRent?)

  • Current Min. (…:MINimum:CURRent?)

  • Current Max. (…:MAXimum:CURRent?)

  • Average RMS (…:AVERage?)

  • Minimum (…:PEAK:MINimum?)

  • Maximum (…:PEAK:MAXimum?)

  • Standard Deviation (…:SDEViation?)

The values described below are returned by FETCh and READ commands. CALCulate commands return error codes instead, one value for each result listed below.

Suppressed linked return values: reliability

param list_index:

Index of the segment

return:

power_average_rms: Power value for the selected segment