from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class ClippingCls:
"""Clipping commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clipping", core, parent)
[docs]
def get_cfactor(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:CFACtor \n
Snippet: value: float = driver.source.bb.arbitrary.mcarrier.clipping.get_cfactor() \n
Sets the value of the desired crest factor, if baseband clipping is enabled. A target crest factor above the crest factor
of the unclipped multicarrier signal has no effect. \n
:return: cfactor: float Range: -50 to 50, Unit: dB
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:CFACtor?')
return Conversions.str_to_float(response)
[docs]
def set_cfactor(self, cfactor: float) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:CFACtor \n
Snippet: driver.source.bb.arbitrary.mcarrier.clipping.set_cfactor(cfactor = 1.0) \n
Sets the value of the desired crest factor, if baseband clipping is enabled. A target crest factor above the crest factor
of the unclipped multicarrier signal has no effect. \n
:param cfactor: float Range: -50 to 50, Unit: dB
"""
param = Conversions.decimal_value_to_str(cfactor)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:CFACtor {param}')
[docs]
def get_cutoff(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:CUToff \n
Snippet: value: float = driver.source.bb.arbitrary.mcarrier.clipping.get_cutoff() \n
Sets the cutoff frequency of the final low pass filter, if baseband clipping is enabled. \n
:return: cutoff: float Range: 0 to 50E6
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:CUToff?')
return Conversions.str_to_float(response)
[docs]
def set_cutoff(self, cutoff: float) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:CUToff \n
Snippet: driver.source.bb.arbitrary.mcarrier.clipping.set_cutoff(cutoff = 1.0) \n
Sets the cutoff frequency of the final low pass filter, if baseband clipping is enabled. \n
:param cutoff: float Range: 0 to 50E6
"""
param = Conversions.decimal_value_to_str(cutoff)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:CUToff {param}')
[docs]
def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:[STATe] \n
Snippet: value: bool = driver.source.bb.arbitrary.mcarrier.clipping.get_state() \n
Switches baseband clipping on and off. \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLIPping:[STATe] \n
Snippet: driver.source.bb.arbitrary.mcarrier.clipping.set_state(state = False) \n
Switches baseband clipping on and off. \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLIPping:STATe {param}')