from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ThresholdCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("threshold", core, parent)
[docs]
def set(self, value: float, cursor=repcap.Cursor.Default) -> None:
"""
``CURSor<*>:THReshold`` \n
Snippet: ``driver.cursor.threshold.set(value = 1.0, cursor = repcap.Cursor.Default)`` \n
Defines an absolute threshold as an additional condition for the peak search. Only peaks that exceed the threshold are
detected.
:param value: Threshold in dBm
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
"""
param = Conversions.decimal_value_to_str(value)
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
self._core.io.write_with_opc(f'CURSor{cursor_cmd_val}:THReshold {param}')
[docs]
def get(self, cursor=repcap.Cursor.Default) -> float:
"""
``CURSor<*>:THReshold`` \n
Snippet: ``value: float = driver.cursor.threshold.get(cursor = repcap.Cursor.Default)`` \n
Defines an absolute threshold as an additional condition for the peak search. Only peaks that exceed the threshold are
detected.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
:return: value: Threshold in dBm
"""
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
response = self._core.io.query_str_with_opc(f'CURSor{cursor_cmd_val}:THReshold?')
return Conversions.str_to_float(response)