Source code for RsSmbv.Implementations.Source.Bb.Huwb.FilterPy.Parameter

from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.Utilities import trim_str_response


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class ParameterCls: """Parameter commands group definition. 14 total commands, 2 Subgroups, 8 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("parameter", core, parent) @property def cosine(self): """cosine commands group. 0 Sub-classes, 2 commands.""" if not hasattr(self, '_cosine'): from .Cosine import CosineCls self._cosine = CosineCls(self._core, self._cmd_group) return self._cosine @property def lte(self): """lte commands group. 0 Sub-classes, 4 commands.""" if not hasattr(self, '_lte'): from .Lte import LteCls self._lte = LteCls(self._core, self._cmd_group) return self._lte
[docs] def get_apco_25(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:APCo25 \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_apco_25() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: apco_25: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:APCo25?') return Conversions.str_to_float(response)
[docs] def set_apco_25(self, apco_25: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:APCo25 \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_apco_25(apco_25 = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param apco_25: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(apco_25) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:APCo25 {param}')
[docs] def get_gauss(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:GAUSs \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_gauss() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: gauss: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:GAUSs?') return Conversions.str_to_float(response)
[docs] def set_gauss(self, gauss: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:GAUSs \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_gauss(gauss = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param gauss: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(gauss) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:GAUSs {param}')
[docs] def get_lpass(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:LPASs \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_lpass() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: lpass: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:LPASs?') return Conversions.str_to_float(response)
[docs] def set_lpass(self, lpass: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:LPASs \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_lpass(lpass = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param lpass: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(lpass) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:LPASs {param}')
[docs] def get_lpass_evm(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:LPASsevm \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_lpass_evm() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: cutoff_frequency: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:LPASsevm?') return Conversions.str_to_float(response)
[docs] def set_lpass_evm(self, cutoff_frequency: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:LPASsevm \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_lpass_evm(cutoff_frequency = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param cutoff_frequency: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(cutoff_frequency) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:LPASsevm {param}')
[docs] def get_pgauss(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:PGAuss \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_pgauss() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: pgauss: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:PGAuss?') return Conversions.str_to_float(response)
[docs] def set_pgauss(self, pgauss: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:PGAuss \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_pgauss(pgauss = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param pgauss: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(pgauss) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:PGAuss {param}')
[docs] def get_rcosine(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:RCOSine \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_rcosine() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: rcosine: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:RCOSine?') return Conversions.str_to_float(response)
[docs] def set_rcosine(self, rcosine: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:RCOSine \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_rcosine(rcosine = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param rcosine: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(rcosine) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:RCOSine {param}')
[docs] def get_sphase(self) -> float: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:SPHase \n Snippet: value: float = driver.source.bb.huwb.filterPy.parameter.get_sphase() \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :return: sphase: float Range: 0.15 to 2.5 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:SPHase?') return Conversions.str_to_float(response)
[docs] def set_sphase(self, sphase: float) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:SPHase \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_sphase(sphase = 1.0) \n Sets the filter parameter. Table Header: Filter type / Parameter / Parameter name / Min / Max / Increment / Default \n - APCO25 / Rolloff factor / <Apco25> / 0.05 / 0.99 / 0.01 / 0.2 - COSine / Rolloff factor / <Cosine> / 0 / 1 / 0.01 / 0.1 - GAUSs / BxT / <Gauss> / 0.15 / 2.5 / 0.01 / 0.5 - LPASs / Cutoff frequency / <LPass> / 0.02 / 2 / 0.01 / 0.34 - LPASSEVM / Cutoff frequency / <CutoffFrequency> / 0.05 / 2 / 0.01 / 0.29 - PGAuss / BxT / <PGauss> / 0.15 / 2.5 / 0.01 / 0.5 - RCOSine / Rolloff factor / <RCosine> / 0 / 1 / 0.01 / 0.22 - SPHase / BxT / <SPhase> / 0.15 / 2.5 / 0.01 / 2 \n :param sphase: float Range: 0.15 to 2.5 """ param = Conversions.decimal_value_to_str(sphase) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:SPHase {param}')
[docs] def get_user(self) -> str: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:USER \n Snippet: value: str = driver.source.bb.huwb.filterPy.parameter.get_user() \n Loads the file from the default or the specified directory. Loaded are files with extension *.vaf or *.dat. Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default and in a specific directory. \n :return: filename: string """ response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:USER?') return trim_str_response(response)
[docs] def set_user(self, filename: str) -> None: """SCPI: [SOURce<HW>]:BB:HUWB:FILTer:PARameter:USER \n Snippet: driver.source.bb.huwb.filterPy.parameter.set_user(filename = 'abc') \n Loads the file from the default or the specified directory. Loaded are files with extension *.vaf or *.dat. Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default and in a specific directory. \n :param filename: string """ param = Conversions.value_to_quoted_str(filename) self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:FILTer:PARameter:USER {param}')
def clone(self) -> 'ParameterCls': """Clones the group by creating new object from it and its whole existing subgroups Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group""" new_group = ParameterCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group