from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class YCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("y", core, parent)
[docs]
def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> float:
"""
``CALCulate<n>:MARKer<m>:FUNCtion:FPEaks:Y`` \n
Snippet: ``value: float = driver.calculate.marker.function.fpeaks.y.get(window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n
Queries the position of the peaks on the y-axis. The order depends on the sort order that has been set with method
``RsFsw.applications.k10Xlte.calculate.marker.function.fpeaks.sort.set()`` .
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
:return: peak_position: Position of the peaks on the y-axis. The unit depends on the measurement.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:FPEaks:Y?')
return Conversions.str_to_float(response)