from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MaxPeakPeakCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("maxPeakPeak", core, parent)
[docs]
def get(self, advJitter=repcap.AdvJitter.Default, advJitterComponents=repcap.AdvJitterComponents.Default) -> float:
"""
``ADVJitter<*>:RESult:COMPonents<*>:STATistics:MAXPeakpeak`` \n
Snippet: ``value: float = driver.advJitter.result.components.statistics.maxPeakPeak.get(advJitter = repcap.AdvJitter.Default, advJitterComponents = repcap.AdvJitterComponents.Default)`` \n
Return the statistic results of the specified measurement.
The command affects the content of export files as well as data retrieved with: \n
- MAXPeakpeak: absolute maximum value of the component.
- MAXStddev: standard deviation of the maximum value.
- MINPeakpeak: absolute minimum value of the component.
- MINStddev: standard deviation of the minimum value.
- PEAKpeak: peak to peak value of the long-term measurement results.
- WFMCount: number of waveforms (acquisitions) the measurement is based on.
- STDDev: standard deviation of the long-term measurement results.
:param advJitter: optional repeated capability selector. Default value: Nr1 (settable in the interface 'AdvJitter')
:param advJitterComponents: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Components')
:return: max_abs_peak_peak: -100E+24 to 100E+24
"""
advJitter_cmd_val = self._cmd_group.get_repcap_cmd_value(advJitter, repcap.AdvJitter)
advJitterComponents_cmd_val = self._cmd_group.get_repcap_cmd_value(advJitterComponents, repcap.AdvJitterComponents)
response = self._core.io.query_str(f'ADVJitter{advJitter_cmd_val}:RESult:COMPonents{advJitterComponents_cmd_val}:STATistics:MAXPeakpeak?')
return Conversions.str_to_float(response)