from typing import List
from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.Types import DataType
from ......Internal.StructBase import StructBase
from ......Internal.ArgStruct import ArgStruct
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class AverageCls:
"""Average commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("average", core, parent)
# noinspection PyTypeChecker
[docs]
class ResultData(StructBase):
"""Response structure. Fields: \n
- Reliability: int: See 'Reliability indicator'
- Frequency: List[float]: Frequency of the detected peak
- Level: List[float]: Level of the detected peak"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct('Frequency', DataType.FloatList, None, False, True, 1),
ArgStruct('Level', DataType.FloatList, None, False, True, 1)]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Frequency: List[float] = None
self.Level: List[float] = None
[docs]
def read(self) -> ResultData:
"""SCPI: READ:GPRF:MEASurement<Instance>:FFTSanalyzer:PEAKs:AVERage \n
Snippet: value: ResultData = driver.gprf.measurement.fftSpecAn.peaks.average.read() \n
Returns the results of the peak search in the spectrum diagram. Separate commands retrieve results for the current trace
and for the average trace. The results are returned in the following order: <Reliability>, {<Frequency>, <Level>}marker 0,
..., {<Frequency>, <Level>}marker 4 \n
:return: structure: for return value, see the help for ResultData structure arguments."""
return self._core.io.query_struct(f'READ:GPRF:MEASurement<Instance>:FFTSanalyzer:PEAKs:AVERage?', self.__class__.ResultData())
[docs]
def fetch(self) -> ResultData:
"""SCPI: FETCh:GPRF:MEASurement<Instance>:FFTSanalyzer:PEAKs:AVERage \n
Snippet: value: ResultData = driver.gprf.measurement.fftSpecAn.peaks.average.fetch() \n
Returns the results of the peak search in the spectrum diagram. Separate commands retrieve results for the current trace
and for the average trace. The results are returned in the following order: <Reliability>, {<Frequency>, <Level>}marker 0,
..., {<Frequency>, <Level>}marker 4 \n
:return: structure: for return value, see the help for ResultData structure arguments."""
return self._core.io.query_struct(f'FETCh:GPRF:MEASurement<Instance>:FFTSanalyzer:PEAKs:AVERage?', self.__class__.ResultData())