"""Provides methods to fetch and read the Chp measurement results."""
import functools
import nirfmxwcdma.attributes as attributes
import nirfmxwcdma.errors as errors
import nirfmxwcdma.internal._helper as _helper
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 Wcdma signal configuration")
return f(*xs, **kws)
return aux
[docs]
class ChpResults(object):
"""Provides methods to fetch and read the Chp measurement results."""
def __init__(self, signal_obj):
"""Provides methods to fetch and read the Chp measurement results."""
self._signal_obj = signal_obj
self._session_function_lock = signal_obj._session_function_lock
self._interpreter = signal_obj._interpreter
[docs]
@_raise_if_disposed
def get_total_carrier_power(self, selector_string):
r"""Gets the sum of all active carrier powers, where each carrier power corresponds to the value of the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_CARRIER_ABSOLUTE_POWER` attribute. For a single-carrier
measurement, total carrier power is the same as carrier absolute power.
This value is expressed in dBm.
You do not need to use a selector string to read this result for the default signal and result instances. 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 and named results.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Returns the sum of all active carrier powers, where each carrier power corresponds to the value of the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_CARRIER_ABSOLUTE_POWER` attribute. For a single-carrier
measurement, total carrier power is the same as carrier absolute power.
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.CHP_RESULTS_TOTAL_CARRIER_POWER.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def get_carrier_absolute_power(self, selector_string):
r"""Gets the carrier power integrated over a bandwidth of 5 MHz.
The carrier is centered at a frequency determined by the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CENTER_FREQUENCY` and
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CARRIER_FREQUENCY` attributes.
Use "carrier<*k*>" as the selector string to read this result.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Returns the carrier power integrated over a bandwidth of 5 MHz.
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.CHP_RESULTS_CARRIER_ABSOLUTE_POWER.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def get_carrier_relative_power(self, selector_string):
r"""Gets the carrier power relative to the value of the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_TOTAL_CARRIER_POWER` attribute.
This value is expressed in dB.
Use "carrier<*k*>" as the selector string to read this result.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Returns the carrier power relative to the value of the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_TOTAL_CARRIER_POWER` attribute.
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.CHP_RESULTS_CARRIER_RELATIVE_POWER.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def fetch_carrier_measurement(self, selector_string, timeout):
r"""Fetches the absolute and relative powers of the carrier for the CHP measurement. The relative power is relative to the
total carrier power.
Use "carrier<*n*>" as the selector string to configure this method.
Args:
selector_string (string):
This parameter specifies a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ comprising of result
name, and carrier number.
Example:
"carrier0"
"result::r1/carrier0"
You can use the :py:meth:`build_carrier_string` method to build the selector string.
timeout (float):
This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed
in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.
Returns:
Tuple (absolute_power, relative_power, error_code):
absolute_power (float):
This parameter returns the carrier power integrated over a bandwidth of 5 MHz. This value is expressed in dBm.
relative_power (float):
This parameter returns the carrier power relative to the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_TOTAL_CARRIER_POWER` attribute. 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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
absolute_power, relative_power, error_code = (
self._interpreter.chp_fetch_carrier_measurement(updated_selector_string, timeout)
)
finally:
self._session_function_lock.exit_read_lock()
return absolute_power, relative_power, error_code
[docs]
@_raise_if_disposed
def fetch_total_carrier_power(self, selector_string, timeout):
r"""Fetches the total carrier power for the CHP measurement.
Args:
selector_string (string):
This parameter specifies a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ comprising of result
name.
Example:
"result::r1"
You can use the :py:meth:`build_result_string` method to build the selector string.
timeout (float):
This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed
in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.
Returns:
Tuple (total_carrier_power, error_code):
total_carrier_power (float):
This parameter returns the total integrated power of all the active carriers. 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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
total_carrier_power, error_code = self._interpreter.chp_fetch_total_carrier_power(
updated_selector_string, timeout
)
finally:
self._session_function_lock.exit_read_lock()
return total_carrier_power, error_code
[docs]
@_raise_if_disposed
def fetch_carrier_measurement_array(self, selector_string, timeout):
r"""Fetches an array of absolute powers and array of relative powers of the carriers for the CHP measurement. The relative
power is relative to the total carrier power.
Args:
selector_string (string):
This parameter specifies a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ comprising of result
name.
Example:
"result::r1"
You can use the :py:meth:`build_result_string` method to build the selector string.
timeout (float):
This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed
in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.
Returns:
Tuple (absolute_power, relative_power, error_code):
absolute_power (float):
This parameter returns an array of carrier powers integrated over a bandwidth of 5 MHz. This value is expressed in dBm.
relative_power (float):
This parameter returns an array of carrier powers relative to the
:py:attr:`~nirfmxwcdma.attributes.AttributeID.CHP_RESULTS_TOTAL_CARRIER_POWER` attribute. 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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
absolute_power, relative_power, error_code = (
self._interpreter.chp_fetch_carrier_measurement_array(
updated_selector_string, timeout
)
)
finally:
self._session_function_lock.exit_read_lock()
return absolute_power, relative_power, error_code
[docs]
@_raise_if_disposed
def fetch_spectrum(self, selector_string, timeout, spectrum):
r"""Fetches the spectrum used for the CHP measurement.
Args:
selector_string (string):
This parameter specifies a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ comprising of result
name.
Example:
"result::r1"
You can use the :py:meth:`build_result_string` method to build the selector string.
timeout (float):
This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed
in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.
spectrum (numpy.float32):
This parameter returns the averaged power at each frequency bin. The value is expressed in dBm.
Returns:
Tuple (x0, dx, error_code):
x0 (float):
This parameter returns the start frequency. This value is expressed in Hz.
dx (float):
This parameter returns the frequency bin spacing. 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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
x0, dx, error_code = self._interpreter.chp_fetch_spectrum(
updated_selector_string, timeout, spectrum
)
finally:
self._session_function_lock.exit_read_lock()
return x0, dx, error_code