from ..Internal.Core import Core
from ..Internal.CommandsGroup import CommandsGroup
from ..Internal import Conversions
from .. import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class HdefinitionCls:
"""
| Commands in total: 4
| Subgroups: 0
| Direct child commands: 4
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("hdefinition", core, parent)
[docs]
def get_state(self) -> bool:
"""
``HDEFinition:STATe`` \n
Snippet: ``value: bool = driver.hdefinition.get_state()`` \n
Enables high definition mode, which increases the numeric resolution of the waveform signal.
:return: state: ON: high definition mode OFF: normal oscilloscope mode
"""
response = self._core.io.query_str('HDEFinition:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``HDEFinition:STATe`` \n
Snippet: ``driver.hdefinition.set_state(state = False)`` \n
Enables high definition mode, which increases the numeric resolution of the waveform signal.
:param state: ON: high definition mode OFF: normal oscilloscope mode
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'HDEFinition:STATe {param}')
[docs]
def get_bandwidth(self) -> float:
"""
``HDEFinition:BWIDth`` \n
Snippet: ``value: float = driver.hdefinition.get_bandwidth()`` \n
Sets the filter bandwidth for the high definition mode.
:return: bandwidth: 1000 to 500E+6
"""
response = self._core.io.query_str('HDEFinition:BWIDth?')
return Conversions.str_to_float(response)
[docs]
def set_bandwidth(self, bandwidth: float) -> None:
"""
``HDEFinition:BWIDth`` \n
Snippet: ``driver.hdefinition.set_bandwidth(bandwidth = 1.0)`` \n
Sets the filter bandwidth for the high definition mode.
:param bandwidth: 1000 to 500E+6
"""
param = Conversions.decimal_value_to_str(bandwidth)
self._core.io.write(f'HDEFinition:BWIDth {param}')
# noinspection PyTypeChecker
[docs]
def get_bf_type(self) -> enums.BwFilterCharacteristics:
"""
``HDEFinition:BFTYpe`` \n
Snippet: ``value: enums.BwFilterCharacteristics = driver.hdefinition.get_bf_type()`` \n
No help available
"""
response = self._core.io.query_str('HDEFinition:BFTYpe?')
return Conversions.str_to_scalar_enum(response, enums.BwFilterCharacteristics)
[docs]
def set_bf_type(self, bw_filter_characteristics: enums.BwFilterCharacteristics) -> None:
"""
``HDEFinition:BFTYpe`` \n
Snippet: ``driver.hdefinition.set_bf_type(bw_filter_characteristics = enums.BwFilterCharacteristics.BESSel)`` \n
No help available
"""
param = Conversions.enum_scalar_to_str(bw_filter_characteristics, enums.BwFilterCharacteristics)
self._core.io.write(f'HDEFinition:BFTYpe {param}')
[docs]
def get_resolution(self) -> float:
"""
``HDEFinition:RESolution`` \n
Snippet: ``value: float = driver.hdefinition.get_resolution()`` \n
Displays the resulting vertical resolution in high definition mode. The higher the filter bandwidth, the lower the
resolution.
:return: resolution: 0 to 18
"""
response = self._core.io.query_str('HDEFinition:RESolution?')
return Conversions.str_to_float(response)