from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class RfSettingsCls:
"""RfSettings commands group definition. 8 total commands, 1 Subgroups, 7 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("rfSettings", core, parent)
@property
def lrStart(self):
"""lrStart commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_lrStart'):
from .LrStart import LrStartCls
self._lrStart = LrStartCls(self._core, self._cmd_group)
return self._lrStart
[docs]
def get_frequency(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:FREQuency \n
Snippet: value: float = driver.configure.rfSettings.get_frequency() \n
Selects the center frequency of the RF analyzer. This command is only relevant for the standalone scenario.
For the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. For the supported frequency range,
see 'Frequency ranges'. \n
:return: analyzer_freq: numeric Unit: Hz
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:FREQuency?')
return Conversions.str_to_float(response)
[docs]
def set_frequency(self, analyzer_freq: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:FREQuency \n
Snippet: driver.configure.rfSettings.set_frequency(analyzer_freq = 1.0) \n
Selects the center frequency of the RF analyzer. This command is only relevant for the standalone scenario.
For the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. For the supported frequency range,
see 'Frequency ranges'. \n
:param analyzer_freq: numeric Unit: Hz
"""
param = Conversions.decimal_value_to_str(analyzer_freq)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:FREQuency {param}')
[docs]
def get_envelope_power(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:ENPower \n
Snippet: value: float = driver.configure.rfSettings.get_envelope_power() \n
Sets the expected nominal power of the measured RF signal. This command is only relevant for the standalone scenario. For
the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:return: exp_nominal_power: numeric The range of the expected nominal power can be calculated as follows: Range (Expected Nominal Power) = Range (Input Power) + External Attenuation - User Margin The input power range is stated in the data sheet. Unit: dBm
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:ENPower?')
return Conversions.str_to_float(response)
[docs]
def set_envelope_power(self, exp_nominal_power: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:ENPower \n
Snippet: driver.configure.rfSettings.set_envelope_power(exp_nominal_power = 1.0) \n
Sets the expected nominal power of the measured RF signal. This command is only relevant for the standalone scenario. For
the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:param exp_nominal_power: numeric The range of the expected nominal power can be calculated as follows: Range (Expected Nominal Power) = Range (Input Power) + External Attenuation - User Margin The input power range is stated in the data sheet. Unit: dBm
"""
param = Conversions.decimal_value_to_str(exp_nominal_power)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:ENPower {param}')
[docs]
def get_eattenuation(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:EATTenuation \n
Snippet: value: float = driver.configure.rfSettings.get_eattenuation() \n
Defines an external attenuation (or gain, if the value is negative) , to be applied to the input connector. This command
is only relevant for the standalone scenario. For the combined signal path scenario, use the corresponding ...:SIGN<i>:..
command. \n
:return: rf_input_ext_att: numeric Range: -50 dB to 90 dB, Unit: dB
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:EATTenuation?')
return Conversions.str_to_float(response)
[docs]
def set_eattenuation(self, rf_input_ext_att: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:EATTenuation \n
Snippet: driver.configure.rfSettings.set_eattenuation(rf_input_ext_att = 1.0) \n
Defines an external attenuation (or gain, if the value is negative) , to be applied to the input connector. This command
is only relevant for the standalone scenario. For the combined signal path scenario, use the corresponding ...:SIGN<i>:..
command. \n
:param rf_input_ext_att: numeric Range: -50 dB to 90 dB, Unit: dB
"""
param = Conversions.decimal_value_to_str(rf_input_ext_att)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:EATTenuation {param}')
[docs]
def get_umargin(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:UMARgin \n
Snippet: value: float = driver.configure.rfSettings.get_umargin() \n
Sets the margin that the measurement adds to the expected nominal power to determine the reference power. The reference
power minus the external input attenuation must be within the power range of the selected input connector. Refer to the
data sheet. This command is only relevant for the standalone scenario. For the combined signal path scenario, use the
corresponding ...:SIGN<i>:.. command. \n
:return: user_margin: numeric Range: 0 dB to (55 dB + external attenuation - expected nominal power) , Unit: dB
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:UMARgin?')
return Conversions.str_to_float(response)
[docs]
def set_umargin(self, user_margin: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:UMARgin \n
Snippet: driver.configure.rfSettings.set_umargin(user_margin = 1.0) \n
Sets the margin that the measurement adds to the expected nominal power to determine the reference power. The reference
power minus the external input attenuation must be within the power range of the selected input connector. Refer to the
data sheet. This command is only relevant for the standalone scenario. For the combined signal path scenario, use the
corresponding ...:SIGN<i>:.. command. \n
:param user_margin: numeric Range: 0 dB to (55 dB + external attenuation - expected nominal power) , Unit: dB
"""
param = Conversions.decimal_value_to_str(user_margin)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:UMARgin {param}')
[docs]
def get_ml_offset(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:MLOFfset \n
Snippet: value: float = driver.configure.rfSettings.get_ml_offset() \n
Varies the input level of the mixer in the analyzer path. This command is only relevant for the standalone scenario. For
the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:return: mix_lev_offset: numeric Range: -10 dB to 16 dB, Unit: dB
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:MLOFfset?')
return Conversions.str_to_float(response)
[docs]
def set_ml_offset(self, mix_lev_offset: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:MLOFfset \n
Snippet: driver.configure.rfSettings.set_ml_offset(mix_lev_offset = 1.0) \n
Varies the input level of the mixer in the analyzer path. This command is only relevant for the standalone scenario. For
the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:param mix_lev_offset: numeric Range: -10 dB to 16 dB, Unit: dB
"""
param = Conversions.decimal_value_to_str(mix_lev_offset)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:MLOFfset {param}')
[docs]
def get_foffset(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:FOFFset \n
Snippet: value: float = driver.configure.rfSettings.get_foffset() \n
Specifies a positive or negative frequency offset to be added to the center frequency (see method RsCmwGprfMeas.Configure.
RfSettings.frequency) . This command does not apply to spectrum analysis in frequency sweep mode (see method
RsCmwGprfMeas.Configure.Spectrum.Frequency.Span.mode) . This command is only relevant for the standalone scenario.
For the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:return: freq_offset: numeric Range: -100 kHz to 100 kHz, Unit: Hz
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:FOFFset?')
return Conversions.str_to_float(response)
[docs]
def set_foffset(self, freq_offset: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:FOFFset \n
Snippet: driver.configure.rfSettings.set_foffset(freq_offset = 1.0) \n
Specifies a positive or negative frequency offset to be added to the center frequency (see method RsCmwGprfMeas.Configure.
RfSettings.frequency) . This command does not apply to spectrum analysis in frequency sweep mode (see method
RsCmwGprfMeas.Configure.Spectrum.Frequency.Span.mode) . This command is only relevant for the standalone scenario.
For the combined signal path scenario, use the corresponding ...:SIGN<i>:.. command. \n
:param freq_offset: numeric Range: -100 kHz to 100 kHz, Unit: Hz
"""
param = Conversions.decimal_value_to_str(freq_offset)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:FOFFset {param}')
[docs]
def get_lr_interval(self) -> float:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:LRINterval \n
Snippet: value: float = driver.configure.rfSettings.get_lr_interval() \n
No command help available \n
:return: lvl_rang_interval: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:RFSettings:LRINterval?')
return Conversions.str_to_float(response)
[docs]
def set_lr_interval(self, lvl_rang_interval: float) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:RFSettings:LRINterval \n
Snippet: driver.configure.rfSettings.set_lr_interval(lvl_rang_interval = 1.0) \n
No command help available \n
:param lvl_rang_interval: No help available
"""
param = Conversions.decimal_value_to_str(lvl_rang_interval)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:RFSettings:LRINterval {param}')
def clone(self) -> 'RfSettingsCls':
"""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 = RfSettingsCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group