Source code for RsFsw.Implementations.Calculate.Marker.Z

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ZCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("z", core, parent)

[docs] def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> float: """ ``CALCulate<n>:MARKer<m>:Z`` \n Snippet: ``value: float = driver.calculate.marker.z.get(window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n Queries the z-axis value of the indicated marker in the persistence spectrum result display. You can select whether to query the results of the persistence trace or the maxhold trace with method ``RsFsw.applications.k10Xlte.calculate.deltaMarker.trace.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: result: The return value is the percentage of hits on the marker position. """ 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}:Z?') return Conversions.str_to_float(response)