Source code for RsFsw.Implementations.Calculate.Marker.Function.Fpeaks.X

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class XCls: """X commands group definition. 1 total commands, 0 Subgroups, 1 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("x", core, parent)
[docs] def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> float: """SCPI: CALCulate<n>:MARKer<m>:FUNCtion:FPEaks:X \n Snippet: value: float = driver.calculate.marker.function.fpeaks.x.get(window = repcap.Window.Default, marker = repcap.Marker.Default) \n Queries the position of the peaks on the x-axis. The order depends on the sort order that has been set with method RsFsw. Calculate.Marker.Function.Fpeaks.Sort.set. \n :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 x-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:X?') return Conversions.str_to_float(response)