from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PpeakCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("ppeak", core, parent)
[docs]
def get(self, measIndex=repcap.MeasIndex.Default) -> float:
"""
``MEASurement<*>:RESult:PPEak`` \n
Snippet: ``value: float = driver.measurement.result.ppeak.get(measIndex = repcap.MeasIndex.Default)`` \n
Return the statistic results of the specified measurement. The measurement type is defined with method
``RsMxo.measurement.main.set()`` .
To define the path and file names, use the EXPort:WAVeform:AUTonaming:* commands: \n
- [:ACTual]: current measurement result
- AVG: arithmetic mean of the measurement results
- EVTCount: number of measurement results in the measurement
- NPEak: negative peak value of the measurement results
- PPEak: positive peak value of the measurement results
- RMS: RMS value of the measurement results
- STDDev: standard deviation of the measurement results
- RSTDdev: relative standard deviation (STDDev / AVG)
- WFMCount: number of measured waveforms
:param measIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: max_peak: Numeric result value
"""
measIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(measIndex, repcap.MeasIndex)
response = self._core.io.query_str(f'MEASurement{measIndex_cmd_val}:RESult:PPEak?')
return Conversions.str_to_float(response)