from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SubrangesCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("subranges", core, parent)
[docs]
def set(self, number_peaks: float, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:PSEarch:SUBRanges`` \n
Snippet: ``driver.calculate.peakSearch.subranges.set(number_peaks = 1.0, window = repcap.Window.Default)`` \n
Defines the number of peaks included in the peak list. After this number of peaks has been found, the FSW stops the peak
search and continues the search in the next measurement range.
:param number_peaks: Range: 1 to 50
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.decimal_value_to_str(number_peaks)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:PSEarch:SUBRanges {param}')
[docs]
def get(self, window=repcap.Window.Default) -> float:
"""
``CALCulate<n>:PSEarch:SUBRanges`` \n
Snippet: ``value: float = driver.calculate.peakSearch.subranges.get(window = repcap.Window.Default)`` \n
Defines the number of peaks included in the peak list. After this number of peaks has been found, the FSW stops the peak
search and continues the search in the next measurement range.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: number_peaks: Range: 1 to 50
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:PSEarch:SUBRanges?')
return Conversions.str_to_float(response)