"""Provides methods to configure the Sem measurement."""
import functools
import nirfmxnr.attributes as attributes
import nirfmxnr.enums as enums
import nirfmxnr.errors as errors
import nirfmxnr.internal._helper as _helper
import nirfmxnr.sem_component_carrier_configuration as component_carrier
def _raise_if_disposed(f):
"""From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
@functools.wraps(f)
def aux(*xs, **kws):
meas_obj = xs[0] # parameter 0 is 'self' which is the measurement object
if meas_obj._signal_obj.is_disposed:
raise Exception("Cannot access a disposed NR signal configuration")
return f(*xs, **kws)
return aux
[docs]
class SemConfiguration(object):
"""Provides methods to configure the Sem measurement."""
def __init__(self, signal_obj):
"""Provides methods to configure the Sem measurement."""
self._signal_obj = signal_obj
self._session_function_lock = signal_obj._session_function_lock
self._interpreter = signal_obj._interpreter
self.component_carrier = component_carrier.SemComponentCarrierConfiguration(signal_obj) # type: ignore
[docs]
@_raise_if_disposed
def get_measurement_enabled(self, selector_string):
r"""Gets whether to enable the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal and result
instances. Refer to the Selector String topic for information about the string syntax for named signals and named
results.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (bool):
Specifies whether to enable the SEM measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_MEASUREMENT_ENABLED.value
)
attr_val = bool(attr_val)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_measurement_enabled(self, selector_string, value):
r"""Sets whether to enable the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal and result
instances. Refer to the Selector String topic for information about the string syntax for named signals and named
results.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
value (bool):
Specifies whether to enable the SEM measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_MEASUREMENT_ENABLED.value,
int(value),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_uplink_mask_type(self, selector_string):
r"""Gets the spectrum emission mask used in the measurement for uplink.
You must set the mask type to **Custom** to configure the custom offset masks. Refer to section 6.5.2 of the
*3GPP 38.101* specification for more information about standard-defined mask types.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **General**.
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+===========================+==========================================================================================================================+
| General (0) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.2-1 in section 6.5.2 of the |
| | 3GPP TS 38.101-1 specification, Table 6.5.2.1-1 and 6.5A.2.1-1 in section 6.5.2 of the 3GPP TS 38.101-2 specification |
| | and Table 6.5B.2.1.1-1 in section 6.5B of the 3GPP TS 38.101-3 specification. In case of non-contiguous EN-DC |
| | consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the measurement selects the |
| | offset frequencies and limits for the SEM, as defined in Table 6.6.2.1.5-1, 6.6.2.1.5-2, 6.6.2.1A.1.5-1, and |
| | 6.6.2.1A.1.5-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
| | If the band value is set to 46 or 96 or 102, the measurement selects the offset frequencies and limits for SEM as |
| | defined in Table 6.5F.2.2-1 in section 6.5F.2 of the 3GPP TS 38.101-1 Specification. |
| | If the band value is set to NTN bands 254, 255 or 256, the measurement selects the offset frequencies and limits for |
| | SEM as defined in Table 6.5.2.2.1 in section 6.5.2 of the 3GPP 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_35 (1) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification and Table 6.5B.2.1.2.1-1 in section 6.5B of the 3GPP TS 38.101-3 specification. In |
| | case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the |
| | measurement selects the offset frequencies and limits for the SEM, as defined in Table 6.6.2.2.5.5-1 in section 6.6.2 |
| | of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Custom (2) | You need to configure the SEM Num Offsets, SEM Offset Start Freq, SEM Offset Stop Freq, |
| | SEM Offset Abs Limit Start, SEM Offset Abs Limit Stop, SEM Offset Sideband, SEM Offset RBW, SEM Offset RBW Filter Type, |
| | and SEM Offset BW Integral attributes for each offset. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_03 (3) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.1-1 and 6.6.2.2.5.1-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_04 (4) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-3 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. Subcarrier spacing can be configured through BWP Subcarrier Spacing attribute. |
| | Subcarrier spacing corresponding to first bandwidth part is used for computing mask. Transform precoding can be |
| | configured through PUSCH Transform Precoding Enabled attribute. Transform precoding corresponding to first bandwidth |
| | part is used for computing mask. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.3.2-3 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_06 (5) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.4-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.3-1 and 6.6.2.2.5.3-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_21 (6) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.1-1 and 6.6.2.2.5.1-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_27 (7) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.8-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of intra-band contiguous CA consisting of at least one subblock with all NR |
| | carriers, for the NR subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.2A.2.3.2.1-1 in section 6.5A.2.3 of the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC |
| | consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the measurement selects the |
| | offset frequencies and limits for the SEM, as defined in Table 6.6.2.2.3.4-1 in section 6.6.2 of the 3GPP TS 36.521-1 |
| | specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_07 (8) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.4-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.3-1 and Table 6.6.2.2.5.3-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_03U (9) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_21 Rel 17 Onwards (10) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.9-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_04N (11) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_05N (12) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_09N (13) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_10N (14) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_11N (15) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_12N (16) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemUplinkMaskType):
Specifies the spectrum emission mask used in the measurement for uplink.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_UPLINK_MASK_TYPE.value
)
attr_val = enums.SemUplinkMaskType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_uplink_mask_type(self, selector_string, value):
r"""Sets the spectrum emission mask used in the measurement for uplink.
You must set the mask type to **Custom** to configure the custom offset masks. Refer to section 6.5.2 of the
*3GPP 38.101* specification for more information about standard-defined mask types.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **General**.
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+===========================+==========================================================================================================================+
| General (0) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.2-1 in section 6.5.2 of the |
| | 3GPP TS 38.101-1 specification, Table 6.5.2.1-1 and 6.5A.2.1-1 in section 6.5.2 of the 3GPP TS 38.101-2 specification |
| | and Table 6.5B.2.1.1-1 in section 6.5B of the 3GPP TS 38.101-3 specification. In case of non-contiguous EN-DC |
| | consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the measurement selects the |
| | offset frequencies and limits for the SEM, as defined in Table 6.6.2.1.5-1, 6.6.2.1.5-2, 6.6.2.1A.1.5-1, and |
| | 6.6.2.1A.1.5-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
| | If the band value is set to 46 or 96 or 102, the measurement selects the offset frequencies and limits for SEM as |
| | defined in Table 6.5F.2.2-1 in section 6.5F.2 of the 3GPP TS 38.101-1 Specification. |
| | If the band value is set to NTN bands 254, 255 or 256, the measurement selects the offset frequencies and limits for |
| | SEM as defined in Table 6.5.2.2.1 in section 6.5.2 of the 3GPP 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_35 (1) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification and Table 6.5B.2.1.2.1-1 in section 6.5B of the 3GPP TS 38.101-3 specification. In |
| | case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the |
| | measurement selects the offset frequencies and limits for the SEM, as defined in Table 6.6.2.2.5.5-1 in section 6.6.2 |
| | of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Custom (2) | You need to configure the SEM Num Offsets, SEM Offset Start Freq, SEM Offset Stop Freq, |
| | SEM Offset Abs Limit Start, SEM Offset Abs Limit Stop, SEM Offset Sideband, SEM Offset RBW, SEM Offset RBW Filter Type, |
| | and SEM Offset BW Integral attributes for each offset. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_03 (3) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.1-1 and 6.6.2.2.5.1-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_04 (4) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-3 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. Subcarrier spacing can be configured through BWP Subcarrier Spacing attribute. |
| | Subcarrier spacing corresponding to first bandwidth part is used for computing mask. Transform precoding can be |
| | configured through PUSCH Transform Precoding Enabled attribute. Transform precoding corresponding to first bandwidth |
| | part is used for computing mask. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.3.2-3 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_06 (5) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.4-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.3-1 and 6.6.2.2.5.3-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_21 (6) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.1-1 and 6.6.2.2.5.1-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_27 (7) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.8-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of intra-band contiguous CA consisting of at least one subblock with all NR |
| | carriers, for the NR subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.2A.2.3.2.1-1 in section 6.5A.2.3 of the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC |
| | consisting of at least one subblock with all E-UTRA carriers, for the E-UTRA subblock, the measurement selects the |
| | offset frequencies and limits for the SEM, as defined in Table 6.6.2.2.3.4-1 in section 6.6.2 of the 3GPP TS 36.521-1 |
| | specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_07 (8) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.4-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. In case of non-contiguous EN-DC consisting of at least one subblock with all E-UTRA |
| | carriers, for the E-UTRA subblock, the measurement selects the offset frequencies and limits for the SEM, as defined in |
| | Table 6.6.2.2.5.3-1 and Table 6.6.2.2.5.3-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_03U (9) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_21 Rel 17 Onwards (10) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.9-1 in section 6.5.2 of |
| | the 3GPP TS 38.101-1 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_04N (11) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_05N (12) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_09N (13) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_10N (14) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.3-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_11N (15) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.1-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
| NS_12N (16) | The measurement selects the offset frequencies and limits for SEM as defined in Table 6.5.2.3.2-1 in section 6.5.2.3 of |
| | the |
| | 3GPP TS 38.101-5 specification. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemUplinkMaskType, int):
Specifies the spectrum emission mask used in the measurement for uplink.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemUplinkMaskType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_UPLINK_MASK_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_downlink_mask_type(self, selector_string):
r"""Gets the limits to be used in the measurement for Downlink.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **Standard**.
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+==========================================================================================================================+
| Standard (0) | The measurement selects the offset frequencies and limits for SEM, as defined in Table 6.6.4.2.1-1, Table 6.6.4.2.1-2, |
| | Table 6.6.4.2.2.1-1, Table 6.6.4.2.2.1-2, Table 6.6.4.2.2.2-1, Table 6.6.4.2.3-1, Table 6.6.4.2.3-2, and Table |
| | 6.6.4.2.4-1 in section 6.6.4 and Table 9.7.4.3.2-1, 9.7.4.3.2-2, 9.7.4.3.3-1 and 9.7.4.3.3-2 in section 9.7.4 of the |
| | 3GPP TS 38.104 Specification. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Custom (2) | Specifies that limits are applied based on user-defined offset segments. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemDownlinkMaskType):
Specifies the limits to be used in the measurement for Downlink.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE.value
)
attr_val = enums.SemDownlinkMaskType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_downlink_mask_type(self, selector_string, value):
r"""Sets the limits to be used in the measurement for Downlink.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **Standard**.
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+==========================================================================================================================+
| Standard (0) | The measurement selects the offset frequencies and limits for SEM, as defined in Table 6.6.4.2.1-1, Table 6.6.4.2.1-2, |
| | Table 6.6.4.2.2.1-1, Table 6.6.4.2.2.1-2, Table 6.6.4.2.2.2-1, Table 6.6.4.2.3-1, Table 6.6.4.2.3-2, and Table |
| | 6.6.4.2.4-1 in section 6.6.4 and Table 9.7.4.3.2-1, 9.7.4.3.2-2, 9.7.4.3.3-1 and 9.7.4.3.3-2 in section 9.7.4 of the |
| | 3GPP TS 38.104 Specification. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Custom (2) | Specifies that limits are applied based on user-defined offset segments. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemDownlinkMaskType, int):
Specifies the limits to be used in the measurement for Downlink.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemDownlinkMaskType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_delta_f_maximum(self, selector_string):
r"""Gets the stop frequency for 3rd offset segment to be used in the measurement. This attribute is valid only for
downlink and when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE` attribute to
**Standard**.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 15 MHz. The minimum value is 9.5 MHz.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the stop frequency for 3rd offset segment to be used in the measurement. This attribute is valid only for
downlink and when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE` attribute to
**Standard**.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_DELTA_F_MAXIMUM.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_delta_f_maximum(self, selector_string, value):
r"""Sets the stop frequency for 3rd offset segment to be used in the measurement. This attribute is valid only for
downlink and when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE` attribute to
**Standard**.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 15 MHz. The minimum value is 9.5 MHz.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the stop frequency for 3rd offset segment to be used in the measurement. This attribute is valid only for
downlink and when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_DOWNLINK_MASK_TYPE` attribute to
**Standard**.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_DELTA_F_MAXIMUM.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_subblock_integration_bandwidth(self, selector_string):
r"""Gets the integration bandwidth of a subblock. This value is expressed in Hz. Integration bandwidth is the span from
the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.
Use "subblock<*n*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to read this result.
The default value is 0.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Returns the integration bandwidth of a subblock. This value is expressed in Hz. Integration bandwidth is the span from
the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_SUBBLOCK_INTEGRATION_BANDWIDTH.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def get_subblock_aggregated_channel_bandwidth(self, selector_string):
r"""Gets the aggregated channel bandwidth of a configured subblock. This value is expressed in Hz. The aggregated
channel bandwidth is the sum of the subblock integration bandwidth and the guard bands on either side of the subblock
integration bandwidth.
Use "subblock<*n*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to read this result.
The default value is 0.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Returns the aggregated channel bandwidth of a configured subblock. This value is expressed in Hz. The aggregated
channel bandwidth is the sum of the subblock integration bandwidth and the guard bands on either side of the subblock
integration bandwidth.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_SUBBLOCK_AGGREGATED_CHANNEL_BANDWIDTH.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def get_number_of_offsets(self, selector_string):
r"""Gets the number of SEM offset segments.
Use "subblock<*n*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the number of SEM offset segments.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_NUMBER_OF_OFFSETS.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_number_of_offsets(self, selector_string, value):
r"""Sets the number of SEM offset segments.
Use "subblock<*n*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the number of SEM offset segments.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_NUMBER_OF_OFFSETS.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_start_frequency(self, selector_string):
r"""Gets the start frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 0.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the start frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_START_FREQUENCY.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_start_frequency(self, selector_string, value):
r"""Sets the start frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 0.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the start frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_START_FREQUENCY.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_stop_frequency(self, selector_string):
r"""Gets the stop frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1 MHz.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the stop frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_STOP_FREQUENCY.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_stop_frequency(self, selector_string, value):
r"""Sets the stop frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1 MHz.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the stop frequency of an offset segment. Refer to the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION` attribute for more details.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_STOP_FREQUENCY.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_sideband(self, selector_string):
r"""Gets whether the offset segment is present either on one side or on both sides of a carrier.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is **Both**.
+--------------+---------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+===========================================================================+
| Neg (0) | Configures a lower offset segment to the left of the leftmost carrier. |
+--------------+---------------------------------------------------------------------------+
| Pos (1) | Configures an upper offset segment to the right of the rightmost carrier. |
+--------------+---------------------------------------------------------------------------+
| Both (2) | Configures both the negative and the positive offset segments. |
+--------------+---------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemOffsetSideband):
Specifies whether the offset segment is present either on one side or on both sides of a carrier.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_SIDEBAND.value
)
attr_val = enums.SemOffsetSideband(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_sideband(self, selector_string, value):
r"""Sets whether the offset segment is present either on one side or on both sides of a carrier.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is **Both**.
+--------------+---------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+===========================================================================+
| Neg (0) | Configures a lower offset segment to the left of the leftmost carrier. |
+--------------+---------------------------------------------------------------------------+
| Pos (1) | Configures an upper offset segment to the right of the rightmost carrier. |
+--------------+---------------------------------------------------------------------------+
| Both (2) | Configures both the negative and the positive offset segments. |
+--------------+---------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemOffsetSideband, int):
Specifies whether the offset segment is present either on one side or on both sides of a carrier.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemOffsetSideband else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_SIDEBAND.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_rbw_filter_bandwidth(self, selector_string):
r"""Gets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you
set the SEM Offset RBW Auto attribute to **False**. This value is expressed in Hz.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 30000 Hz.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you
set the SEM Offset RBW Auto attribute to **False**. This value is expressed in Hz.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RBW_FILTER_BANDWIDTH.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_rbw_filter_bandwidth(self, selector_string, value):
r"""Sets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you
set the SEM Offset RBW Auto attribute to **False**. This value is expressed in Hz.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 30000 Hz.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you
set the SEM Offset RBW Auto attribute to **False**. This value is expressed in Hz.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RBW_FILTER_BANDWIDTH.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_rbw_filter_type(self, selector_string):
r"""Gets the shape of a digital RBW filter.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is **Gaussian**.
+---------------+-----------------------------------------+
| Name (Value) | Description |
+===============+=========================================+
| FFT Based (0) | No RBW filtering is performed. |
+---------------+-----------------------------------------+
| Gaussian (1) | The RBW filter has a Gaussian response. |
+---------------+-----------------------------------------+
| Flat (2) | The RBW filter has a flat response. |
+---------------+-----------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemOffsetRbwFilterType):
Specifies the shape of a digital RBW filter.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_RBW_FILTER_TYPE.value
)
attr_val = enums.SemOffsetRbwFilterType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_rbw_filter_type(self, selector_string, value):
r"""Sets the shape of a digital RBW filter.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is **Gaussian**.
+---------------+-----------------------------------------+
| Name (Value) | Description |
+===============+=========================================+
| FFT Based (0) | No RBW filtering is performed. |
+---------------+-----------------------------------------+
| Gaussian (1) | The RBW filter has a Gaussian response. |
+---------------+-----------------------------------------+
| Flat (2) | The RBW filter has a flat response. |
+---------------+-----------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemOffsetRbwFilterType, int):
Specifies the shape of a digital RBW filter.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemOffsetRbwFilterType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RBW_FILTER_TYPE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_bandwidth_integral(self, selector_string):
r"""Gets the resolution of a spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
When you set this attribute to a value greater than 1, the measurement acquires the spectrum with a narrow
resolution and then processes it digitally to get a wider resolution that is equal to the product of a bandwidth
integral and a RBW.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the resolution of a spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_BANDWIDTH_INTEGRAL.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_bandwidth_integral(self, selector_string, value):
r"""Sets the resolution of a spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
When you set this attribute to a value greater than 1, the measurement acquires the spectrum with a narrow
resolution and then processes it digitally to get a wider resolution that is equal to the product of a bandwidth
integral and a RBW.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the resolution of a spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_BANDWIDTH_INTEGRAL.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_limit_fail_mask(self, selector_string):
r"""Gets the criteria to determine the measurement fail status.
The default value is **Absolute**.
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+=================+================================================================================================================+
| Abs AND Rel (0) | Specifies that the measurement fails if the power in the segment exceeds both the absolute and relative masks. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Abs OR Rel (1) | Specifies that the measurement fails if the power in the segment exceeds either the absolute or relative mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Absolute (2) | Specifies that the measurement fails if the power in the segment exceeds the absolute mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Relative (3) | Specifies that the measurement fails if the power in the segment exceeds the relative mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemOffsetLimitFailMask):
Specifies the criteria to determine the measurement fail status.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_LIMIT_FAIL_MASK.value
)
attr_val = enums.SemOffsetLimitFailMask(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_limit_fail_mask(self, selector_string, value):
r"""Sets the criteria to determine the measurement fail status.
The default value is **Absolute**.
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+=================+================================================================================================================+
| Abs AND Rel (0) | Specifies that the measurement fails if the power in the segment exceeds both the absolute and relative masks. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Abs OR Rel (1) | Specifies that the measurement fails if the power in the segment exceeds either the absolute or relative mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Absolute (2) | Specifies that the measurement fails if the power in the segment exceeds the absolute mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
| Relative (3) | Specifies that the measurement fails if the power in the segment exceeds the relative mask. |
+-----------------+----------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemOffsetLimitFailMask, int):
Specifies the criteria to determine the measurement fail status.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemOffsetLimitFailMask else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_LIMIT_FAIL_MASK.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_frequency_definition(self, selector_string):
r"""Gets the definition of the the start frequency and stop frequency of the offset segments.
If this attribute is not configured, the following values are used based on other configurations - Carrier Edge
to Meas BW Center for a single-carrier configuration, Subblock Edge to Meas BW Center for a multi-carrier
configuration, and Carrier Center to Meas BW Center for a single-carrier configuration in the bands n46, n96, and n102
as defined in the 3GPP TS 37.213 for the shared spectrum channel access.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+======================================+==========================================================================================================================+
| Carrier Center to Meas BW Center (0) | The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the |
| | center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Carrier Edge to Meas BW Center (2) | The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to |
| | the center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Subblock Edge to Meas BW Center (6) | The start frequency and stop frequency are defined from the subblock edge of the closest subblock bandwidth to the |
| | center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemOffsetFrequencyDefinition):
Specifies the definition of the the start frequency and stop frequency of the offset segments.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION.value,
)
attr_val = enums.SemOffsetFrequencyDefinition(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_frequency_definition(self, selector_string, value):
r"""Sets the definition of the the start frequency and stop frequency of the offset segments.
If this attribute is not configured, the following values are used based on other configurations - Carrier Edge
to Meas BW Center for a single-carrier configuration, Subblock Edge to Meas BW Center for a multi-carrier
configuration, and Carrier Center to Meas BW Center for a single-carrier configuration in the bands n46, n96, and n102
as defined in the 3GPP TS 37.213 for the shared spectrum channel access.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+======================================+==========================================================================================================================+
| Carrier Center to Meas BW Center (0) | The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the |
| | center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Carrier Edge to Meas BW Center (2) | The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to |
| | the center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Subblock Edge to Meas BW Center (6) | The start frequency and stop frequency are defined from the subblock edge of the closest subblock bandwidth to the |
| | center of the offset segment measurement bandwidth. |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemOffsetFrequencyDefinition, int):
Specifies the definition of the the start frequency and stop frequency of the offset segments.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemOffsetFrequencyDefinition else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_FREQUENCY_DEFINITION.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_absolute_limit_start(self, selector_string):
r"""Gets the absolute power limit corresponding to the beginning of an offset segment. This value is expressed in dBm.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -21.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the absolute power limit corresponding to the beginning of an offset segment. This value is expressed in dBm.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_ABSOLUTE_LIMIT_START.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_absolute_limit_start(self, selector_string, value):
r"""Sets the absolute power limit corresponding to the beginning of an offset segment. This value is expressed in dBm.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -21.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the absolute power limit corresponding to the beginning of an offset segment. This value is expressed in dBm.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_ABSOLUTE_LIMIT_START.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_absolute_limit_stop(self, selector_string):
r"""Gets the absolute power limit corresponding to the end of an offset segment. This value is expressed in dBm.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -21.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the absolute power limit corresponding to the end of an offset segment. This value is expressed in dBm.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_ABSOLUTE_LIMIT_STOP.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_absolute_limit_stop(self, selector_string, value):
r"""Sets the absolute power limit corresponding to the end of an offset segment. This value is expressed in dBm.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -21.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the absolute power limit corresponding to the end of an offset segment. This value is expressed in dBm.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_ABSOLUTE_LIMIT_STOP.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_relative_limit_start(self, selector_string):
r"""Gets the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -53.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RELATIVE_LIMIT_START.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_relative_limit_start(self, selector_string, value):
r"""Sets the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -53.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RELATIVE_LIMIT_START.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_offset_relative_limit_stop(self, selector_string):
r"""Gets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -60.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_OFFSET_RELATIVE_LIMIT_STOP.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_offset_relative_limit_stop(self, selector_string, value):
r"""Sets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.
Use "offset<*k*>" or "subblock<*n*>" or "subblock<*n*>/offset<*k*>" as the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute.
The default value is -60.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.SEM_OFFSET_RELATIVE_LIMIT_STOP.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_sweep_time_auto(self, selector_string):
r"""Gets whether the measurement sets the sweep time.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **True**.
+--------------+---------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=======================================================================================+
| False (0) | The measurement uses the sweep time that you specify in the SEM Sweep Time attribute. |
+--------------+---------------------------------------------------------------------------------------+
| True (1) | The measurement uses a sweep time of 1 ms. |
+--------------+---------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemSweepTimeAuto):
Specifies whether the measurement sets the sweep time.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_SWEEP_TIME_AUTO.value
)
attr_val = enums.SemSweepTimeAuto(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_sweep_time_auto(self, selector_string, value):
r"""Sets whether the measurement sets the sweep time.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **True**.
+--------------+---------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=======================================================================================+
| False (0) | The measurement uses the sweep time that you specify in the SEM Sweep Time attribute. |
+--------------+---------------------------------------------------------------------------------------+
| True (1) | The measurement uses a sweep time of 1 ms. |
+--------------+---------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemSweepTimeAuto, int):
Specifies whether the measurement sets the sweep time.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemSweepTimeAuto else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_SWEEP_TIME_AUTO.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_sweep_time_interval(self, selector_string):
r"""Gets the sweep time when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_SWEEP_TIME_AUTO` attribute to
**False**. This value is expressed in seconds.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 1 ms.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the sweep time when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_SWEEP_TIME_AUTO` attribute to
**False**. This value is expressed in seconds.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_SWEEP_TIME_INTERVAL.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_sweep_time_interval(self, selector_string, value):
r"""Sets the sweep time when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_SWEEP_TIME_AUTO` attribute to
**False**. This value is expressed in seconds.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 1 ms.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the sweep time when you set the :py:attr:`~nirfmxnr.attributes.AttributeID.SEM_SWEEP_TIME_AUTO` attribute to
**False**. This value is expressed in seconds.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string, attributes.AttributeID.SEM_SWEEP_TIME_INTERVAL.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_enabled(self, selector_string):
r"""Gets whether to enable averaging for the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **False**.
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+==========================================================================================================================+
| False (0) | The measurement is performed on a single acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| True (1) | The SEM measurement uses the value of the SEM Averaging Count attribute as the number of acquisitions over which the |
| | SEM measurement is averaged. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemAveragingEnabled):
Specifies whether to enable averaging for the SEM measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_ENABLED.value
)
attr_val = enums.SemAveragingEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_enabled(self, selector_string, value):
r"""Sets whether to enable averaging for the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **False**.
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+==========================================================================================================================+
| False (0) | The measurement is performed on a single acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
| True (1) | The SEM measurement uses the value of the SEM Averaging Count attribute as the number of acquisitions over which the |
| | SEM measurement is averaged. |
+--------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemAveragingEnabled, int):
Specifies whether to enable averaging for the SEM measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemAveragingEnabled else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_ENABLED.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_count(self, selector_string):
r"""Gets the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_AVERAGING_ENABLED` attribute to **True**.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 10.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_AVERAGING_ENABLED` attribute to **True**.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_COUNT.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_count(self, selector_string, value):
r"""Sets the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_AVERAGING_ENABLED` attribute to **True**.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 10.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxnr.attributes.AttributeID.SEM_AVERAGING_ENABLED` attribute to **True**.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_COUNT.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_type(self, selector_string):
r"""Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM
measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **RMS**.
+--------------+-------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=============================================================================================================+
| RMS (0) | The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Log (1) | The power spectrum is averaged in a logarithmic scale. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Scalar (2) | The square root of the power spectrum is averaged. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Max (3) | The peak power in the spectrum at each frequency bin is retained from one acquisition to the next. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Min (4) | The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next. |
+--------------+-------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemAveragingType):
Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM
measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_TYPE.value
)
attr_val = enums.SemAveragingType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_type(self, selector_string, value):
r"""Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM
measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **RMS**.
+--------------+-------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=============================================================================================================+
| RMS (0) | The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Log (1) | The power spectrum is averaged in a logarithmic scale. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Scalar (2) | The square root of the power spectrum is averaged. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Max (3) | The peak power in the spectrum at each frequency bin is retained from one acquisition to the next. |
+--------------+-------------------------------------------------------------------------------------------------------------+
| Min (4) | The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next. |
+--------------+-------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemAveragingType, int):
Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM
measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemAveragingType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AVERAGING_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_fft_window(self, selector_string):
r"""Gets the FFT window type to be used to reduce spectral leakage.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **Flat Top**.
+---------------------+----------------------------------------------------------------+
| Name (Value) | Description |
+=====================+================================================================+
| None (0) | No spectral leakage. |
+---------------------+----------------------------------------------------------------+
| Flat Top (1) | Spectral leakage is reduced using flat top window type. |
+---------------------+----------------------------------------------------------------+
| Hanning (2) | Spectral leakage is reduced using Hanning window type. |
+---------------------+----------------------------------------------------------------+
| Hamming (3) | Spectral leakage is reduced using Hamming window type. |
+---------------------+----------------------------------------------------------------+
| Gaussian (4) | Spectral leakage is reduced using Gaussian window type. |
+---------------------+----------------------------------------------------------------+
| Blackman (5) | Spectral leakage is reduced using Blackman window type. |
+---------------------+----------------------------------------------------------------+
| Blackman-Harris (6) | Spectral leakage is reduced using Blackman-Harris window type. |
+---------------------+----------------------------------------------------------------+
| Kaiser-Bessel (7) | Spectral leakage is reduced using Kaiser-Bessel window type. |
+---------------------+----------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemFftWindow):
Specifies the FFT window type to be used to reduce spectral leakage.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_FFT_WINDOW.value
)
attr_val = enums.SemFftWindow(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_fft_window(self, selector_string, value):
r"""Sets the FFT window type to be used to reduce spectral leakage.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **Flat Top**.
+---------------------+----------------------------------------------------------------+
| Name (Value) | Description |
+=====================+================================================================+
| None (0) | No spectral leakage. |
+---------------------+----------------------------------------------------------------+
| Flat Top (1) | Spectral leakage is reduced using flat top window type. |
+---------------------+----------------------------------------------------------------+
| Hanning (2) | Spectral leakage is reduced using Hanning window type. |
+---------------------+----------------------------------------------------------------+
| Hamming (3) | Spectral leakage is reduced using Hamming window type. |
+---------------------+----------------------------------------------------------------+
| Gaussian (4) | Spectral leakage is reduced using Gaussian window type. |
+---------------------+----------------------------------------------------------------+
| Blackman (5) | Spectral leakage is reduced using Blackman window type. |
+---------------------+----------------------------------------------------------------+
| Blackman-Harris (6) | Spectral leakage is reduced using Blackman-Harris window type. |
+---------------------+----------------------------------------------------------------+
| Kaiser-Bessel (7) | Spectral leakage is reduced using Kaiser-Bessel window type. |
+---------------------+----------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemFftWindow, int):
Specifies the FFT window type to be used to reduce spectral leakage.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemFftWindow else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_FFT_WINDOW.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_amplitude_correction_type(self, selector_string):
r"""Gets whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at
the RF center frequency, or at the individual frequency bins. Use the
:py:meth:`nirfmxinstr.session.Session.configure_external_attenuation_table` method to configure the external
attenuation table.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **RF Center Frequency**.
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+============================+==========================================================================================================================+
| RF Center Frequency (0) | All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the |
| | RF center frequency. |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Spectrum Frequency Bin (1) | An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that |
| | frequency. |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SemAmplitudeCorrectionType):
Specifies whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at
the RF center frequency, or at the individual frequency bins. Use the
:py:meth:`nirfmxinstr.session.Session.configure_external_attenuation_table` method to configure the external
attenuation table.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_AMPLITUDE_CORRECTION_TYPE.value
)
attr_val = enums.SemAmplitudeCorrectionType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_amplitude_correction_type(self, selector_string, value):
r"""Sets whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at
the RF center frequency, or at the individual frequency bins. Use the
:py:meth:`nirfmxinstr.session.Session.configure_external_attenuation_table` method to configure the external
attenuation table.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is **RF Center Frequency**.
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+============================+==========================================================================================================================+
| RF Center Frequency (0) | All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the |
| | RF center frequency. |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Spectrum Frequency Bin (1) | An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that |
| | frequency. |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SemAmplitudeCorrectionType, int):
Specifies whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at
the RF center frequency, or at the individual frequency bins. Use the
:py:meth:`nirfmxinstr.session.Session.configure_external_attenuation_table` method to configure the external
attenuation table.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.SemAmplitudeCorrectionType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_AMPLITUDE_CORRECTION_TYPE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_all_traces_enabled(self, selector_string):
r"""Gets whether to enable the traces to be stored and retrieved after performing the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (bool):
Specifies whether to enable the traces to be stored and retrieved after performing the SEM measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_ALL_TRACES_ENABLED.value
)
attr_val = bool(attr_val)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_all_traces_enabled(self, selector_string, value):
r"""Sets whether to enable the traces to be stored and retrieved after performing the SEM measurement.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
value (bool):
Specifies whether to enable the traces to be stored and retrieved after performing the SEM measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_ALL_TRACES_ENABLED.value,
int(value),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_number_of_analysis_threads(self, selector_string):
r"""Gets the maximum number of threads used for parallelism for the SEM measurement.
The number of threads can range from 1 to the number of physical cores. The number of threads you set may not
be used in calculations. The actual number of threads used depends on the problem size, system resources, data
availability, and other considerations.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the maximum number of threads used for parallelism for the SEM measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.SEM_NUMBER_OF_ANALYSIS_THREADS.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_number_of_analysis_threads(self, selector_string, value):
r"""Sets the maximum number of threads used for parallelism for the SEM measurement.
The number of threads can range from 1 to the number of physical cores. The number of threads you set may not
be used in calculations. The actual number of threads used depends on the problem size, system resources, data
availability, and other considerations.
You do not need to use a selector string to configure or read this attribute for the default signal instance.
Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ topic for
information about the string syntax for named signals.
The default value is 1.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the maximum number of threads used for parallelism for the SEM measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.SEM_NUMBER_OF_ANALYSIS_THREADS.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code