"""Defines a root class which is used to identify and control Pulse signal configuration."""
import functools
import math
import nirfmxinstr
import nirfmxpulse.attributes as attributes
import nirfmxpulse.enums as enums
import nirfmxpulse.errors as errors
import nirfmxpulse.internal._helper as _helper
import nirfmxpulse.pulse_measurement as pulse_measurement
from nirfmxpulse.internal._helper import SignalConfiguration
class _PulseSignalConfiguration:
"""Contains static methods to create and delete Pulse signal."""
@staticmethod
def get_pulse_signal_configuration(instr_session, signal_name="", cloning=False):
updated_signal_name = signal_name
if signal_name:
updated_signal_name = _helper.validate_and_remove_signal_qualifier(
signal_name, "signal_name"
)
_helper.validate_signal_not_empty(updated_signal_name, "signal_name")
return _PulseSignalConfiguration.init(instr_session, updated_signal_name, cloning) # type: ignore
@staticmethod
def init(instr_session, signal_name, cloning):
with instr_session._signal_lock:
if signal_name.lower() == Pulse._default_signal_name_user_visible.lower():
signal_name = Pulse._default_signal_name
existing_signal = instr_session._signal_manager.find_signal_configuration(
Pulse._signal_configuration_type, signal_name
)
if existing_signal is None:
signal_configuration = Pulse(instr_session, signal_name, cloning) # type: ignore
instr_session._signal_manager.add_signal_configuration(signal_configuration)
else:
signal_configuration = existing_signal
# Checking if signal exists in C layer
if signal_configuration._interpreter.check_if_current_signal_exists() is False:
if not signal_configuration.signal_configuration_name.lower():
instr_session._interpreter.create_default_signal_configuration(
Pulse._default_signal_name_user_visible,
int(math.log(nirfmxinstr.Personalities.PULSE.value, 2.0)) + 1,
)
else:
signal_configuration._interpreter.create_signal_configuration(signal_name)
return signal_configuration
@staticmethod
def remove_signal_configuration(instr_session, signal_configuration):
with instr_session._signal_lock:
instr_session._signal_manager.remove_signal_configuration(signal_configuration)
def _raise_if_disposed(f):
"""From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
@functools.wraps(f)
def aux(*xs, **kws):
signal = xs[0] # parameter 0 is 'self' which is the signal object
if signal.is_disposed:
raise Exception("Cannot access a disposed Pulse signal configuration")
return f(*xs, **kws)
return aux
class _PulseBase(SignalConfiguration):
"""Defines a base class for Pulse."""
_default_signal_name = ""
_default_signal_name_user_visible = "default@Pulse"
_signal_configuration_type = "<'nirfmxpulse.pulse.Pulse'>"
def __init__(self, session, signal_name="", cloning=False):
self.is_disposed = False
self._rfmxinstrsession = session
self._rfmxinstrsession_interpreter = session._interpreter
self.signal_configuration_name = signal_name
self.signal_configuration_type = type(self) # type: ignore
self._signal_configuration_mode = "Signal"
if session._is_remote_session:
import nirfmxpulse.internal._grpc_stub_interpreter as _grpc_stub_interpreter
interpreter = _grpc_stub_interpreter.GrpcStubInterpreter(session._grpc_options, session, self) # type: ignore
else:
from nirfmxpulse.internal._library_interpreter import LibraryInterpreter
interpreter = LibraryInterpreter("windows-1251", session, self) # type: ignore
self._interpreter = interpreter
self._interpreter.set_session_handle(self._rfmxinstrsession_interpreter._vi) # type: ignore
self._session_function_lock = _helper.SessionFunctionLock()
# Measurements object
self.pulse_measurement = pulse_measurement.Pulse(self) # type: ignore
if not signal_name and not cloning:
signal_exists, personality, _ = (
self._rfmxinstrsession_interpreter.check_if_signal_exists(
self._default_signal_name_user_visible
)
)
if not (signal_exists and personality.value == nirfmxinstr.Personalities.PULSE.value):
self._rfmxinstrsession_interpreter.create_default_signal_configuration(
self._default_signal_name_user_visible,
int(math.log(nirfmxinstr.Personalities.PULSE.value, 2.0)) + 1,
)
elif signal_name and not cloning:
signal_exists, personality, _ = (
self._rfmxinstrsession_interpreter.check_if_signal_exists(signal_name)
)
if not (signal_exists and personality.value == nirfmxinstr.Personalities.PULSE.value):
self._interpreter.create_signal_configuration(signal_name) # type: ignore
def __enter__(self):
"""Enters the context of the Pulse signal configuration."""
return self
def __exit__(self, exc_type, exc_value, traceback):
"""Exits the context of the Pulse signal configuration."""
self.dispose() # type: ignore
pass
def dispose(self):
r"""Deletes the signal configuration if it is not the default signal configuration
and clears any trace of the current signal configuration, if any.
.. note::
You can call this function safely more than once, even if the signal is already deleted.
"""
if not self.is_disposed:
if self.signal_configuration_name == self._default_signal_name:
self.is_disposed = True
return
else:
_ = self._delete_signal_configuration(True) # type: ignore
self.is_disposed = True
@_raise_if_disposed
def delete_signal_configuration(self):
r"""Deletes the current instance of a signal.
Returns:
error_code:
Returns the status code of this method.
The status code either indicates success or describes a warning condition.
"""
error_code = self._delete_signal_configuration(False) # type: ignore
return error_code
def _delete_signal_configuration(self, ignore_driver_error):
error_code = 0
try:
if not self.is_disposed:
self._session_function_lock.enter_write_lock()
error_code = self._interpreter.delete_signal_configuration(ignore_driver_error) # type: ignore
_PulseSignalConfiguration.remove_signal_configuration(self._rfmxinstrsession, self) # type: ignore
self.is_disposed = True
finally:
self._session_function_lock.exit_write_lock()
return error_code
@_raise_if_disposed
def get_warning(self):
r"""Retrieves and then clears the warning information for the session.
Returns:
Tuple (warning_code, warning_message):
warning_code (int):
Contains the latest warning code.
warning_message (string):
Contains the latest warning description.
"""
try:
self._session_function_lock.enter_read_lock()
warning_code, warning_message = self._interpreter.get_error() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return warning_code, warning_message
@_raise_if_disposed
def get_error_string(self, error_code):
r"""Gets the description of a driver error code.
Args:
error_code (int):
Specifies an error or warning code.
Returns:
string:
Contains the error description.
"""
try:
self._session_function_lock.enter_read_lock()
error_message = self._interpreter.get_error_string(error_code) # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return error_message
@_raise_if_disposed
def reset_attribute(self, selector_string, attribute_id):
r"""Resets the attribute to its default value.
Args:
selector_string (string):
Specifies the selector string for the property being reset.
attribute_id (PropertyId):
Specifies an attribute identifier.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
attribute_id = (
attribute_id.value if type(attribute_id) is attributes.AttributeID else attribute_id
)
error_code = self._interpreter.reset_attribute( # type: ignore
updated_selector_string, attribute_id
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_selected_ports(self, selector_string):
r"""Gets the instrument port to be configured to acquire a signal. Use
:py:meth:`nirfmxinstr.session.Session.get_available_ports` method to get the valid port names.
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.
**Valid values**
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (value) | Description |
+================+==========================================================================================================================+
| PXIe-5830 | if0, if1 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| PXIe-5831/5832 | if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the |
| | mmRH-5582 front panel |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Other devices | "" (empty string) |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
**Default values**
+---------------------+-------------------+
| Name (value) | Description |
+=====================+===================+
| PXIe-5830/5831/5832 | if1 |
+---------------------+-------------------+
| Other devices | "" (empty string) |
+---------------------+-------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (string):
Specifies the instrument port to be configured to acquire a signal. Use
:py:meth:`nirfmxinstr.session.Session.get_available_ports` method to get the valid port names.
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
)
attr_val, error_code = self._interpreter.get_attribute_string( # type: ignore
updated_selector_string, attributes.AttributeID.SELECTED_PORTS.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_selected_ports(self, selector_string, value):
r"""Sets the instrument port to be configured to acquire a signal. Use
:py:meth:`nirfmxinstr.session.Session.get_available_ports` method to get the valid port names.
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.
**Valid values**
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (value) | Description |
+================+==========================================================================================================================+
| PXIe-5830 | if0, if1 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| PXIe-5831/5832 | if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the |
| | mmRH-5582 front panel |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Other devices | "" (empty string) |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
**Default values**
+---------------------+-------------------+
| Name (value) | Description |
+=====================+===================+
| PXIe-5830/5831/5832 | if1 |
+---------------------+-------------------+
| Other devices | "" (empty string) |
+---------------------+-------------------+
Args:
selector_string (string):
Pass an empty string.
value (string):
Specifies the instrument port to be configured to acquire a signal. Use
:py:meth:`nirfmxinstr.session.Session.get_available_ports` method to get the valid port names.
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
)
_helper.validate_not_none(value, "value")
error_code = self._interpreter.set_attribute_string( # type: ignore
updated_selector_string, attributes.AttributeID.SELECTED_PORTS.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_center_frequency(self, selector_string):
r"""Gets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer
tunes to this frequency.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer
tunes to this frequency.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.CENTER_FREQUENCY.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_center_frequency(self, selector_string, value):
r"""Sets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer
tunes to this frequency.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer
tunes to this frequency.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.CENTER_FREQUENCY.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_reference_level(self, selector_string):
r"""Gets the reference level that represents the maximum expected power of the RF input signal. This value is
expressed in dBm for RF devices and V\ :sub:`pk-pk`\ for baseband devices.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the reference level that represents the maximum expected power of the RF input signal. This value is
expressed in dBm for RF devices and V\ :sub:`pk-pk`\ for baseband devices.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.REFERENCE_LEVEL.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_reference_level(self, selector_string, value):
r"""Sets the reference level that represents the maximum expected power of the RF input signal. This value is
expressed in dBm for RF devices and V\ :sub:`pk-pk`\ for baseband devices.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the reference level that represents the maximum expected power of the RF input signal. This value is
expressed in dBm for RF devices and V\ :sub:`pk-pk`\ for baseband devices.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.REFERENCE_LEVEL.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_external_attenuation(self, selector_string):
r"""Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is
expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your
device in the *NI RF Vector Signal Analyzers Help*.
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 0.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is
expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your
device in the *NI RF Vector Signal Analyzers Help*.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.EXTERNAL_ATTENUATION.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_external_attenuation(self, selector_string, value):
r"""Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is
expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your
device in the *NI RF Vector Signal Analyzers Help*.
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 0.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is
expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your
device in the *NI RF Vector Signal Analyzers Help*.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.EXTERNAL_ATTENUATION.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_reference_level_headroom(self, selector_string):
r"""Gets the margin RFmx adds to the :py:attr:`~nirfmxpulse.attributes.AttributeID.REFERENCE_LEVEL` attribute. The
margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous
power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input
power of the signal precisely or previously included the margin in the Reference Level, you could improve the
signal-to-noise ratio by reducing the Reference Level Headroom.
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.
**Supported devices: **PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.
**Default values**
+------------------------------------+-------------+
| Name (value) | Description |
+====================================+=============+
| PXIe-5668 | 6 dB |
+------------------------------------+-------------+
| PXIe-5830/5831/5832/5841/5842/5860 | 1 dB |
+------------------------------------+-------------+
| PXIe-5840 | 0 dB |
+------------------------------------+-------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the margin RFmx adds to the :py:attr:`~nirfmxpulse.attributes.AttributeID.REFERENCE_LEVEL` attribute. The
margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.REFERENCE_LEVEL_HEADROOM.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_reference_level_headroom(self, selector_string, value):
r"""Sets the margin RFmx adds to the :py:attr:`~nirfmxpulse.attributes.AttributeID.REFERENCE_LEVEL` attribute. The
margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous
power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input
power of the signal precisely or previously included the margin in the Reference Level, you could improve the
signal-to-noise ratio by reducing the Reference Level Headroom.
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.
**Supported devices: **PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.
**Default values**
+------------------------------------+-------------+
| Name (value) | Description |
+====================================+=============+
| PXIe-5668 | 6 dB |
+------------------------------------+-------------+
| PXIe-5830/5831/5832/5841/5842/5860 | 1 dB |
+------------------------------------+-------------+
| PXIe-5840 | 0 dB |
+------------------------------------+-------------+
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the margin RFmx adds to the :py:attr:`~nirfmxpulse.attributes.AttributeID.REFERENCE_LEVEL` attribute. The
margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.REFERENCE_LEVEL_HEADROOM.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_trigger_type(self, selector_string):
r"""Gets the trigger type.
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 **None**.
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+===================+==========================================================================================================================+
| None (0) | No Reference Trigger is configured. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Digital Edge (1) | The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified |
| | using the Digital Edge Source attribute. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| IQ Power Edge (2) | The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), |
| | which is configured using the IQ Power Edge Slope attribute. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Software (3) | The Reference Trigger is not asserted until a software trigger occurs. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.TriggerType):
Specifies the trigger type.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.TRIGGER_TYPE.value
)
attr_val = enums.TriggerType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_trigger_type(self, selector_string, value):
r"""Sets the trigger type.
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 **None**.
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+===================+==========================================================================================================================+
| None (0) | No Reference Trigger is configured. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Digital Edge (1) | The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified |
| | using the Digital Edge Source attribute. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| IQ Power Edge (2) | The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), |
| | which is configured using the IQ Power Edge Slope attribute. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
| Software (3) | The Reference Trigger is not asserted until a software trigger occurs. |
+-------------------+--------------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.TriggerType, int):
Specifies the trigger type.
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
)
value = value.value if type(value) is enums.TriggerType else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.TRIGGER_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_digital_edge_trigger_source(self, selector_string):
r"""Gets the source terminal for the digital edge trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (string):
Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_string( # type: ignore
updated_selector_string, attributes.AttributeID.DIGITAL_EDGE_TRIGGER_SOURCE.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_digital_edge_trigger_source(self, selector_string, value):
r"""Sets the source terminal for the digital edge trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (string):
Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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
)
_helper.validate_not_none(value, "value")
error_code = self._interpreter.set_attribute_string( # type: ignore
updated_selector_string,
attributes.AttributeID.DIGITAL_EDGE_TRIGGER_SOURCE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_digital_edge_trigger_edge(self, selector_string):
r"""Gets the active edge for the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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 **Rising Edge**.
+------------------+--------------------------------------------------------+
| Name (Value) | Description |
+==================+========================================================+
| Rising Edge (0) | The trigger asserts on the rising edge of the signal. |
+------------------+--------------------------------------------------------+
| Falling Edge (1) | The trigger asserts on the falling edge of the signal. |
+------------------+--------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.DigitalEdgeTriggerEdge):
Specifies the active edge for the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.DIGITAL_EDGE_TRIGGER_EDGE.value
)
attr_val = enums.DigitalEdgeTriggerEdge(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_digital_edge_trigger_edge(self, selector_string, value):
r"""Sets the active edge for the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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 **Rising Edge**.
+------------------+--------------------------------------------------------+
| Name (Value) | Description |
+==================+========================================================+
| Rising Edge (0) | The trigger asserts on the rising edge of the signal. |
+------------------+--------------------------------------------------------+
| Falling Edge (1) | The trigger asserts on the falling edge of the signal. |
+------------------+--------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.DigitalEdgeTriggerEdge, int):
Specifies the active edge for the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **Digital Edge**.
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
)
value = value.value if type(value) is enums.DigitalEdgeTriggerEdge else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.DIGITAL_EDGE_TRIGGER_EDGE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_iq_power_edge_trigger_source(self, selector_string):
r"""Gets the channel from which the device monitors the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (string):
Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_string( # type: ignore
updated_selector_string, attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SOURCE.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_iq_power_edge_trigger_source(self, selector_string, value):
r"""Sets the channel from which the device monitors the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (string):
Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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
)
_helper.validate_not_none(value, "value")
error_code = self._interpreter.set_attribute_string( # type: ignore
updated_selector_string,
attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SOURCE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_iq_power_edge_trigger_level(self, selector_string):
r"""Gets the power level at which the device triggers. This value is expressed in dB when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE` attribute to **Relative** and in dBm
when you set the IQ Power Edge Level Type attribute to **Absolute**. The device asserts the trigger when the signal
exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the power level at which the device triggers. This value is expressed in dB when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE` attribute to **Relative** and in dBm
when you set the IQ Power Edge Level Type attribute to **Absolute**. The device asserts the trigger when the signal
exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_iq_power_edge_trigger_level(self, selector_string, value):
r"""Sets the power level at which the device triggers. This value is expressed in dB when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE` attribute to **Relative** and in dBm
when you set the IQ Power Edge Level Type attribute to **Absolute**. The device asserts the trigger when the signal
exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the power level at which the device triggers. This value is expressed in dB when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE` attribute to **Relative** and in dBm
when you set the IQ Power Edge Level Type attribute to **Absolute**. The device asserts the trigger when the signal
exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_iq_power_edge_trigger_level_type(self, selector_string):
r"""Gets the reference for the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute.
The IQ Power Edge Level Type attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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 **Absolute**.
+--------------+-----------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+===========================================================================================================+
| Relative (0) | The value of the IQ Power Edge Level attribute is relative to the value of the Reference Level attribute. |
+--------------+-----------------------------------------------------------------------------------------------------------+
| Absolute (1) | The IQ Power Edge Level attribute specifies the absolute power. |
+--------------+-----------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.IQPowerEdgeTriggerLevelType):
Specifies the reference for the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute.
The IQ Power Edge Level Type attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE.value,
)
attr_val = enums.IQPowerEdgeTriggerLevelType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_iq_power_edge_trigger_level_type(self, selector_string, value):
r"""Sets the reference for the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute.
The IQ Power Edge Level Type attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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 **Absolute**.
+--------------+-----------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+===========================================================================================================+
| Relative (0) | The value of the IQ Power Edge Level attribute is relative to the value of the Reference Level attribute. |
+--------------+-----------------------------------------------------------------------------------------------------------+
| Absolute (1) | The IQ Power Edge Level attribute specifies the absolute power. |
+--------------+-----------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.IQPowerEdgeTriggerLevelType, int):
Specifies the reference for the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute.
The IQ Power Edge Level Type attribute is used only when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ Power Edge**.
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
)
value = value.value if type(value) is enums.IQPowerEdgeTriggerLevelType else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_iq_power_edge_trigger_slope(self, selector_string):
r"""Gets whether the device asserts the trigger when the signal power is rising or when it is falling. The device
asserts the trigger when the signal power exceeds the level that you specify in the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute with the slope you specify. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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 **Rising Slope**.
+-------------------+-------------------------------------------------------+
| Name (Value) | Description |
+===================+=======================================================+
| Rising Slope (0) | The trigger asserts when the signal power is rising. |
+-------------------+-------------------------------------------------------+
| Falling Slope (1) | The trigger asserts when the signal power is falling. |
+-------------------+-------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.IQPowerEdgeTriggerSlope):
Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device
asserts the trigger when the signal power exceeds the level that you specify in the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute with the slope you specify. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SLOPE.value
)
attr_val = enums.IQPowerEdgeTriggerSlope(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_iq_power_edge_trigger_slope(self, selector_string, value):
r"""Sets whether the device asserts the trigger when the signal power is rising or when it is falling. The device
asserts the trigger when the signal power exceeds the level that you specify in the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute with the slope you specify. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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 **Rising Slope**.
+-------------------+-------------------------------------------------------+
| Name (Value) | Description |
+===================+=======================================================+
| Rising Slope (0) | The trigger asserts when the signal power is rising. |
+-------------------+-------------------------------------------------------+
| Falling Slope (1) | The trigger asserts when the signal power is falling. |
+-------------------+-------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.IQPowerEdgeTriggerSlope, int):
Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device
asserts the trigger when the signal power exceeds the level that you specify in the
:py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_LEVEL` attribute with the slope you specify. This
attribute is used only when you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.TRIGGER_TYPE` attribute to **IQ
Power Edge**.
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
)
value = value.value if type(value) is enums.IQPowerEdgeTriggerSlope else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SLOPE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_trigger_delay(self, selector_string):
r"""Gets the trigger delay time. This value is expressed in seconds.
If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the
measurement acquires post-trigger samples.
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 0.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the trigger delay time. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.TRIGGER_DELAY.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_trigger_delay(self, selector_string, value):
r"""Sets the trigger delay time. This value is expressed in seconds.
If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the
measurement acquires post-trigger samples.
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 0.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the trigger delay time. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.TRIGGER_DELAY.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_trigger_minimum_quiet_time_mode(self, selector_string):
r"""Gets whether the measurement computes the minimum quiet time used for triggering.
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 **Manual**.
+--------------+---------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=============================================================================================+
| Manual (0) | The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute. |
+--------------+---------------------------------------------------------------------------------------------+
| Auto (1) | The measurement computes the minimum quiet time used for triggering. |
+--------------+---------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.TriggerMinimumQuietTimeMode):
Specifies whether the measurement computes the minimum quiet time used for triggering.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.TRIGGER_MINIMUM_QUIET_TIME_MODE.value,
)
attr_val = enums.TriggerMinimumQuietTimeMode(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_trigger_minimum_quiet_time_mode(self, selector_string, value):
r"""Sets whether the measurement computes the minimum quiet time used for triggering.
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 **Manual**.
+--------------+---------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+=============================================================================================+
| Manual (0) | The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute. |
+--------------+---------------------------------------------------------------------------------------------+
| Auto (1) | The measurement computes the minimum quiet time used for triggering. |
+--------------+---------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.TriggerMinimumQuietTimeMode, int):
Specifies whether the measurement computes the minimum quiet time used for triggering.
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
)
value = value.value if type(value) is enums.TriggerMinimumQuietTimeMode else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.TRIGGER_MINIMUM_QUIET_TIME_MODE.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_trigger_minimum_quiet_time_duration(self, selector_string):
r"""Gets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge
trigger. This value is expressed in seconds.
If you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SLOPE` attribute to
**Rising Slope**, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to
**Falling Slope**, the signal is quiet above the trigger level.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge
trigger. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.TRIGGER_MINIMUM_QUIET_TIME_DURATION.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_trigger_minimum_quiet_time_duration(self, selector_string, value):
r"""Sets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge
trigger. This value is expressed in seconds.
If you set the :py:attr:`~nirfmxpulse.attributes.AttributeID.IQ_POWER_EDGE_TRIGGER_SLOPE` attribute to
**Rising Slope**, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to
**Falling Slope**, the signal is quiet above the trigger level.
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 of this attribute is hardware dependent.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge
trigger. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.TRIGGER_MINIMUM_QUIET_TIME_DURATION.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_measurement_bandwidth(self, selector_string):
r"""Gets the bandwidth of the filter used for the required sample rate. This value is expressed in Hz.
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 **80 MHz**.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the bandwidth of the filter used for the required sample rate. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.MEASUREMENT_BANDWIDTH.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_measurement_bandwidth(self, selector_string, value):
r"""Sets the bandwidth of the filter used for the required sample rate. This value is expressed in Hz.
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 **80 MHz**.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the bandwidth of the filter used for the required sample rate. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.MEASUREMENT_BANDWIDTH.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_measurement_filter_type(self, selector_string):
r"""Gets the demodulation filter type to be used in the measurements.
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 **Gaussian**.
+-----------------+------------------------------------+
| Name (Value) | Description |
+=================+====================================+
| Rectangular (0) | The Rectangular filter is applied. |
+-----------------+------------------------------------+
| Gaussian (1) | The Gaussian filter is applied. |
+-----------------+------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.MeasurementFilterType):
Specifies the demodulation filter type to be used in the measurements.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.MEASUREMENT_FILTER_TYPE.value
)
attr_val = enums.MeasurementFilterType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_measurement_filter_type(self, selector_string, value):
r"""Sets the demodulation filter type to be used in the measurements.
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 **Gaussian**.
+-----------------+------------------------------------+
| Name (Value) | Description |
+=================+====================================+
| Rectangular (0) | The Rectangular filter is applied. |
+-----------------+------------------------------------+
| Gaussian (1) | The Gaussian filter is applied. |
+-----------------+------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.MeasurementFilterType, int):
Specifies the demodulation filter type to be used in the measurements.
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
)
value = value.value if type(value) is enums.MeasurementFilterType else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.MEASUREMENT_FILTER_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_acquisition_length(self, selector_string):
r"""Gets the acquisition length for the pulse measurement. This value is expressed in seconds.
You configure this attribute when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **False**.
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 0.001 seconds.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the acquisition length for the pulse measurement. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.ACQUISITION_LENGTH.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_acquisition_length(self, selector_string, value):
r"""Sets the acquisition length for the pulse measurement. This value is expressed in seconds.
You configure this attribute when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **False**.
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 0.001 seconds.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the acquisition length for the pulse measurement. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.ACQUISITION_LENGTH.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_maximum_pulse_count_enabled(self, selector_string):
r"""Gets whether to enable the maximum pulse count for pulse measurements.
You must configure this attribute when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **False**.
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 maximum pulse count is disabled. |
+--------------+--------------------------------------+
| True (1) | The maximum pulse count is enabled. |
+--------------+--------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.MaximumPulseCountEnabled):
Specifies whether to enable the maximum pulse count for pulse measurements.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.MAXIMUM_PULSE_COUNT_ENABLED.value
)
attr_val = enums.MaximumPulseCountEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_maximum_pulse_count_enabled(self, selector_string, value):
r"""Sets whether to enable the maximum pulse count for pulse measurements.
You must configure this attribute when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **False**.
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 maximum pulse count is disabled. |
+--------------+--------------------------------------+
| True (1) | The maximum pulse count is enabled. |
+--------------+--------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.MaximumPulseCountEnabled, int):
Specifies whether to enable the maximum pulse count for pulse measurements.
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
)
value = value.value if type(value) is enums.MaximumPulseCountEnabled else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.MAXIMUM_PULSE_COUNT_ENABLED.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_maximum_pulse_count(self, selector_string):
r"""Gets the maximum number of pulses to be measured when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.MAXIMUM_PULSE_COUNT_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 100. Valid values are 1 to 10000, inclusive.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the maximum number of pulses to be measured when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.MAXIMUM_PULSE_COUNT_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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.MAXIMUM_PULSE_COUNT.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_maximum_pulse_count(self, selector_string, value):
r"""Sets the maximum number of pulses to be measured when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.MAXIMUM_PULSE_COUNT_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 100. Valid values are 1 to 10000, inclusive.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the maximum number of pulses to be measured when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.MAXIMUM_PULSE_COUNT_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
)
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.MAXIMUM_PULSE_COUNT.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_segmented_acquisition_enabled(self, selector_string):
r"""Gets whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced.
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) | Segmented acquisition is disabled. |
+--------------+------------------------------------+
| True (1) | Segmented acquisition is enabled. |
+--------------+------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.SegmentedAcquisitionEnabled):
Specifies whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced.
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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED.value
)
attr_val = enums.SegmentedAcquisitionEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_segmented_acquisition_enabled(self, selector_string, value):
r"""Sets whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced.
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) | Segmented acquisition is disabled. |
+--------------+------------------------------------+
| True (1) | Segmented acquisition is enabled. |
+--------------+------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.SegmentedAcquisitionEnabled, int):
Specifies whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced.
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
)
value = value.value if type(value) is enums.SegmentedAcquisitionEnabled else value
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string,
attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_number_of_segments(self, selector_string):
r"""Gets the number of segments to acquire when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_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 1. Valid values are 1 to 10000, inclusive.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the number of segments to acquire when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_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
)
attr_val, error_code = self._interpreter.get_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.NUMBER_OF_SEGMENTS.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_number_of_segments(self, selector_string, value):
r"""Sets the number of segments to acquire when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_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 1. Valid values are 1 to 10000, inclusive.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the number of segments to acquire when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_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
)
error_code = self._interpreter.set_attribute_i32( # type: ignore
updated_selector_string, attributes.AttributeID.NUMBER_OF_SEGMENTS.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_segment_acquisition_length(self, selector_string):
r"""Gets the acquisition length for the pulse measurement when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **True**. This value is
expressed in seconds.
You must set this attribute to a value slightly higher than the desired pulse ON duration.
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 0.00001 seconds.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the acquisition length for the pulse measurement when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **True**. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.SEGMENT_ACQUISITION_LENGTH.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_segment_acquisition_length(self, selector_string, value):
r"""Sets the acquisition length for the pulse measurement when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **True**. This value is
expressed in seconds.
You must set this attribute to a value slightly higher than the desired pulse ON duration.
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 0.00001 seconds.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the acquisition length for the pulse measurement when you set the
:py:attr:`~nirfmxpulse.attributes.AttributeID.SEGMENTED_ACQUISITION_ENABLED` attribute to **True**. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.SEGMENT_ACQUISITION_LENGTH.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_auto_level_initial_reference_level(self, selector_string):
r"""Gets the initial reference level, in dBm, which the :py:meth:`auto_level` method uses to estimate the peak power
of the input signal.
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 30.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the initial reference level, in dBm, which the :py:meth:`auto_level` method uses to estimate the peak power
of the input signal.
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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.AUTO_LEVEL_INITIAL_REFERENCE_LEVEL.value,
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_auto_level_initial_reference_level(self, selector_string, value):
r"""Sets the initial reference level, in dBm, which the :py:meth:`auto_level` method uses to estimate the peak power
of the input signal.
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 30.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the initial reference level, in dBm, which the :py:meth:`auto_level` method uses to estimate the peak power
of the input signal.
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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string,
attributes.AttributeID.AUTO_LEVEL_INITIAL_REFERENCE_LEVEL.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_result_fetch_timeout(self, selector_string):
r"""Gets the wait time before results are available in the RFmxPulse Attribute. This value is expressed in seconds.
Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the
RFmxPulse Attribute waits until the measurement is complete.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute for
the default signal instance. Refer to the Selector String 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 (float):
Specifies the wait time before results are available in the RFmxPulse Attribute. 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
)
attr_val, error_code = self._interpreter.get_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.RESULT_FETCH_TIMEOUT.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
@_raise_if_disposed
def set_result_fetch_timeout(self, selector_string, value):
r"""Sets the wait time before results are available in the RFmxPulse Attribute. This value is expressed in seconds.
Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the
RFmxPulse Attribute waits until the measurement is complete.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute for
the default signal instance. Refer to the Selector String topic for information about the string syntax for named
signals.
The default value is 10.
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the wait time before results are available in the RFmxPulse Attribute. 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
)
error_code = self._interpreter.set_attribute_f64( # type: ignore
updated_selector_string, attributes.AttributeID.RESULT_FETCH_TIMEOUT.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def abort_measurements(self, selector_string):
r"""Stops acquisition and measurements associated with signal instance that you specify in the **Selector String**
parameter, which were previously initiated by the :py:meth:`initiate` method or measurement read methods. Calling this
method is optional, unless you want to stop a measurement before it is complete. This method executes even if there is
an incoming error.
Args:
selector_string (string):
This parameter specifies the signal name and result name. The result name can either be specified through this input
or the **Result Name** parameter. If you do
not specify the result name in this parameter, either the result name specified by the **Result Name** parameter or
the default result instance is used.
Example:
""
"result::r1"
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.abort_measurements( # type: ignore
updated_selector_string
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def auto_level(self, selector_string, bandwidth, measurement_interval):
r"""Examines the input signal to calculate the peak power level and sets it as the value of the
:py:attr:`~nirfmxpulse.attributes.AttributeID.REFERENCE_LEVEL` attribute. Use this method to help calculate an
approximate setting for the reference level.
The RFmxPulse Auto Level method does the following:
#. Resets the mixer level, mixer level offset and IF output power offset.
#. Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation and preamp enabled settings.
#. Iterates to adjust the reference level based on the input signal peak power.
#. Uses immediate triggering and restores the trigger settings back to user setting after completing execution.
You can also specify the starting reference level using the
:py:attr:`~nirfmxpulse.attributes.AttributeID.AUTO_LEVEL_INITIAL_REFERENCE_LEVEL` attribute.
When using PXIe-5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical
attenuation before calling the RFmx Pulse Auto Level method. Setting an appropriate value for mechanical attenuation
reduces the number of times the attenuator settings are changed by this method, thus reducing wear and tear, and
maximizing the life time of the attenuator.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
bandwidth (float):
This parameter specifies the bandwidth, in Hz, of the signal to be analyzed. The default value is 80 MHz.
measurement_interval (float):
This parameter specifies the acquisition length. Use this value to compute the number of samples to acquire from the
signal analyzer. This value is expressed in seconds. The default value is 10 ms.
Auto Level method does not use any trigger for acquisition. It ignores the user-configured trigger attributes.
NI recommends that you set a sufficiently high measurement interval to ensure that the acquired waveform is at least as
long as one period of the signal.
Returns:
Tuple (reference_level, error_code):
reference_level (float):
This parameter returns the estimated peak power level of the input signal. This value is expressed in dBm for RF
devices and as Vpk-pk for baseband devices.
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
)
reference_level, error_code = self._interpreter.auto_level( # type: ignore
updated_selector_string, bandwidth, measurement_interval
)
finally:
self._session_function_lock.exit_read_lock()
return reference_level, error_code
@_raise_if_disposed
def check_measurement_status(self, selector_string):
r"""Checks the status of the measurement. Use this method to check for any errors that may occur during measurement or to
check whether the measurement is complete and results are available.
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"
Returns:
Tuple (is_done, error_code):
is_done (bool):
This parameter indicates whether the measurement is complete.
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
)
is_done, error_code = self._interpreter.check_measurement_status( # type: ignore
updated_selector_string
)
finally:
self._session_function_lock.exit_read_lock()
return is_done, error_code
@_raise_if_disposed
def clear_all_named_results(self, selector_string):
r"""Clears all results for the signal that you specify in the **Selector String** parameter.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.clear_all_named_results( # type: ignore
updated_selector_string
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def clear_named_result(self, selector_string):
r"""Clears a result instance specified by the result name in the **Selector String** parameter.
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"
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.clear_named_result( # type: ignore
updated_selector_string
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def commit(self, selector_string):
r"""Commits settings to the hardware. Calling this method is optional. RFmxPulse commits settings to the hardware when you
call the :py:meth:`initiate` method or any of the measurement Read methods.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.commit(updated_selector_string) # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_digital_edge_trigger(
self, selector_string, digital_edge_source, digital_edge, trigger_delay, enable_trigger
):
r"""Configures the device to wait for a digital edge trigger and then marks a reference point within the record.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
digital_edge_source (string):
This parameter specifies the source terminal for the digital edge trigger. The default of this attribute is hardware
dependent.
+----------------------------+-----------------------------------------------------------+
| Name (Value) | Description |
+============================+===========================================================+
| PFI0 (PFI0) | The trigger is received on PFI 0. |
+----------------------------+-----------------------------------------------------------+
| PFI1 (PFI1) | The trigger is received on PFI 1. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig0 (PXI_Trig0) | The trigger is received on PXI trigger line 0. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig1 (PXI_Trig1) | The trigger is received on PXI trigger line 1. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig2 (PXI_Trig2) | The trigger is received on PXI trigger line 2. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig3 (PXI_Trig3) | The trigger is received on PXI trigger line 3. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig4 (PXI_Trig4) | The trigger is received on PXI trigger line 4. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig5 (PXI_Trig5) | The trigger is received on PXI trigger line 5. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig6 (PXI_Trig6) | The trigger is received on PXI trigger line 6. |
+----------------------------+-----------------------------------------------------------+
| PXI_Trig7 (PXI_Trig7) | The trigger is received on PXI trigger line 7. |
+----------------------------+-----------------------------------------------------------+
| PXI_STAR (PXI_STAR) | The trigger is received on the PXI star trigger line. |
+----------------------------+-----------------------------------------------------------+
| PXIe_DStarB (PXIe_DStarB ) | The trigger is received on the PXIe DStar B trigger line. |
+----------------------------+-----------------------------------------------------------+
| TimerEvent (TimerEvent) | The trigger is received from the timer event. |
+----------------------------+-----------------------------------------------------------+
digital_edge (enums.DigitalEdgeTriggerEdge, int):
This parameter specifies the trigger edge to detect. The default value is **Rising Edge**.
+------------------+--------------------------------------------------------+
| Name (Value) | Description |
+==================+========================================================+
| Rising Edge (0) | The trigger asserts on the rising edge of the signal. |
+------------------+--------------------------------------------------------+
| Falling Edge (1) | The trigger asserts on the falling edge of the signal. |
+------------------+--------------------------------------------------------+
trigger_delay (float):
This parameter specifies the trigger delay time, in seconds. The default value is 0.
enable_trigger (bool):
This parameter specifies whether to enable the trigger. The default value is 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()
_helper.validate_not_none(selector_string, "selector_string")
_helper.validate_not_none(digital_edge_source, "digital_edge_source")
digital_edge = (
digital_edge.value
if type(digital_edge) is enums.DigitalEdgeTriggerEdge
else digital_edge
)
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_digital_edge_trigger( # type: ignore
updated_selector_string,
digital_edge_source,
digital_edge,
trigger_delay,
int(enable_trigger),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_external_attenuation(self, selector_string, external_attenuation):
r"""Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
external_attenuation (float):
This parameter specifies the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal
analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in
the* NI RF Vector Signal Analyzers Help*. The default value is 0.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_external_attenuation( # type: ignore
updated_selector_string, external_attenuation
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_frequency(self, selector_string, center_frequency):
r"""Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
center_frequency (float):
This parameter specifies the expected carrier frequency, in Hz, of the RF signal to acquire. The signal analyzer tunes
to this frequency. The default of this attribute is hardware dependent.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_frequency( # type: ignore
updated_selector_string, center_frequency
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_iq_power_edge_trigger(
self,
selector_string,
iq_power_edge_source,
iq_power_edge_slope,
iq_power_edge_level,
trigger_delay,
trigger_min_quiet_time_mode,
trigger_min_quiet_time_duration,
iq_power_edge_level_type,
enable_trigger,
):
r"""Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a
reference point within the record.
To trigger on bursty signals, specify a minimum quiet time, which ensures that the trigger does not occur in
the middle of the burst signal. The quiet time must be set to a value smaller than the time between bursts, but large
enough to ignore power changes within a burst.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
iq_power_edge_source (string):
This parameter specifies the channel from which the device monitors the trigger. The default of this attribute is
hardware dependent.
iq_power_edge_slope (enums.IQPowerEdgeTriggerSlope, int):
This parameter specifies whether the device asserts the trigger when the signal power is rising or when it is falling.
The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. The
default value is **Rising Slope**.
+-------------------+-------------------------------------------------------+
| Name (Value) | Description |
+===================+=======================================================+
| Rising Slope (0) | The trigger asserts when the signal power is rising. |
+-------------------+-------------------------------------------------------+
| Falling Slope (1) | The trigger asserts when the signal power is falling. |
+-------------------+-------------------------------------------------------+
iq_power_edge_level (float):
This parameter specifies the power level at which the device triggers. This value is expressed in dB when you set the
**IQ Power Edge Level Type** parameter to **Relative** and is expressed in dBm when you set the **IQ Power Edge Level
Type** parameter to **Absolute**. The device asserts the trigger when the signal exceeds the level specified by the
value of this parameter, taking into consideration the specified slope. The default of this attribute is hardware
dependent.
trigger_delay (float):
This parameter specifies the trigger delay time, in seconds. The default value is 0.
trigger_min_quiet_time_mode (enums.TriggerMinimumQuietTimeMode, int):
This parameter specifies whether the measurement computes the minimum quiet time used for triggering. The default value
is **Manual**.
+--------------+------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+==========================================================================================+
| Manual (0) | The minimum quiet time used for triggering is the value of the Min Quiet Time parameter. |
+--------------+------------------------------------------------------------------------------------------+
| Auto (1) | The measurement computes the minimum quiet time used for triggering. |
+--------------+------------------------------------------------------------------------------------------+
trigger_min_quiet_time_duration (float):
This parameter specifies the duration, in seconds, for which the signal must be quiet before the signal analyzer arms
the I/Q Power Edge trigger. If you set the **IQ Power Edge Slope** parameter to **Rising Slope**, the signal is quiet
when it is below the trigger level. If you set the **IQ Power Edge Slope** parameter to **Falling Slope**, the signal
is quiet when it is above the trigger level. The default of this attribute is hardware dependent.
iq_power_edge_level_type (enums.IQPowerEdgeTriggerLevelType, int):
This parameter specifies the reference for the ** IQ Power Edge Level** parameter. The default value is **Absolute**.
+--------------+-----------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+===============================================================================================+
| Relative (0) | The |
| | IQ Power Edge Level parameter is relative to the value of the Reference Level attribute. |
+--------------+-----------------------------------------------------------------------------------------------+
| Absolute (1) | The |
| | IQ Power Edge Level parameter specifies the absolute power. |
+--------------+-----------------------------------------------------------------------------------------------+
enable_trigger (bool):
This parameter specifies whether to enable the trigger. The default value is 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()
_helper.validate_not_none(selector_string, "selector_string")
_helper.validate_not_none(iq_power_edge_source, "iq_power_edge_source")
iq_power_edge_slope = (
iq_power_edge_slope.value
if type(iq_power_edge_slope) is enums.IQPowerEdgeTriggerSlope
else iq_power_edge_slope
)
trigger_min_quiet_time_mode = (
trigger_min_quiet_time_mode.value
if type(trigger_min_quiet_time_mode) is enums.TriggerMinimumQuietTimeMode
else trigger_min_quiet_time_mode
)
iq_power_edge_level_type = (
iq_power_edge_level_type.value
if type(iq_power_edge_level_type) is enums.IQPowerEdgeTriggerLevelType
else iq_power_edge_level_type
)
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_iq_power_edge_trigger( # type: ignore
updated_selector_string,
iq_power_edge_source,
iq_power_edge_slope,
iq_power_edge_level,
trigger_delay,
trigger_min_quiet_time_mode,
trigger_min_quiet_time_duration,
iq_power_edge_level_type,
int(enable_trigger),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_reference_level(self, selector_string, reference_level):
r"""Configures the reference level, which represents the maximum expected power of an RF input signal.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
reference_level (float):
This parameter specifies the reference level which represents the maximum expected power of an RF input signal. This
value is configured in dBm for RF devices and as V\ :sub:`pk-pk`\ for baseband devices. The default of this attribute
is hardware dependent.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_reference_level( # type: ignore
updated_selector_string, reference_level
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_rf(
self, selector_string, center_frequency, reference_level, external_attenuation
):
r"""Configures the RF attributes of the signal specified by the selector string.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
center_frequency (float):
This parameter specifies the expected carrier frequency, in Hz, of the RF signal to acquire. The signal analyzer tunes
to this frequency. The default of this attribute is hardware dependent.
reference_level (float):
This parameter specifies the reference level which represents the maximum expected power of an RF input signal. This
value is configured in dBm for RF devices and as V\ :sub:`pk-pk`\ for baseband devices. The default of this attribute
is hardware dependent.
external_attenuation (float):
This parameter specifies the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal
analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in
the* NI RF Vector Signal Analyzers Help*. The default value is 0.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_rf( # type: ignore
updated_selector_string, center_frequency, reference_level, external_attenuation
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def configure_software_edge_trigger(self, selector_string, trigger_delay, enable_trigger):
r"""Configures the device to wait for a software trigger and then marks a reference point within the record.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
trigger_delay (float):
This parameter specifies the trigger delay time, in seconds. The default value is 0.
enable_trigger (bool):
This parameter specifies whether to enable the trigger. The default value is 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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.configure_software_edge_trigger( # type: ignore
updated_selector_string, trigger_delay, int(enable_trigger)
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def disable_trigger(self, selector_string):
r"""Configures the device to not wait for a trigger to mark a reference point within a record. This method defines the
signal triggering as immediate.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.disable_trigger(updated_selector_string) # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def initiate(self, selector_string, result_name):
r"""Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method
asynchronously launches measurements in the background and immediately returns to the caller program. You can fetch
measurement results using the Fetch methods or result attributes in the attribute node. To get the status of
measurements, use the :py:meth:`wait_for_measurement_complete` method or :py:meth:`check_measurement_status` method.
Args:
selector_string (string):
This parameter specifies the signal name and result name. The result name can either be specified through this input
or the **Result Name** parameter. If you do
not specify the result name in this parameter, either the result name specified by the **Result Name** parameter or
the default result instance is used.
Example:
""
"result::r1"
result_name (string):
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to
enable fetching of multiple measurement results and traces. This input accepts the result name with or without the
"result::" prefix. The default value is "" (empty string), which refers to the default result instance.
Example:
""
"result::r1"
"r1"
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()
_helper.validate_not_none(selector_string, "selector_string")
_helper.validate_not_none(result_name, "result_name")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.initiate( # type: ignore
updated_selector_string, result_name
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def reset_to_default(self, selector_string):
r"""Resets a signal to the default values.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.reset_to_default(updated_selector_string) # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def select_measurements(self, selector_string, measurements, enable_all_traces):
r"""Enables the measurement that you specify in the **Measurement** parameter and disables all other measurements.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
measurements (enums.MeasurementTypes, int):
This parameter specifies the measurement to perform. You can specify one of the following measurements. The default
value is **Pulse**.
+--------------+----------------------------+
| Name (Value) | Description |
+==============+============================+
| Pulse (0) | Enables Pulse measurement. |
+--------------+----------------------------+
enable_all_traces (bool):
This parameter specifies whether to enable all traces for the selected measurement. The default value is FALSE.
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()
_helper.validate_not_none(selector_string, "selector_string")
measurements = (
measurements.value if type(measurements) is enums.MeasurementTypes else measurements
)
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.select_measurements( # type: ignore
updated_selector_string, measurements, int(enable_all_traces)
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def wait_for_measurement_complete(self, selector_string, timeout):
r"""Waits for the specified number for seconds for all the measurements to complete.
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"
timeout (float):
This parameter specifies the time, in seconds, for which the method waits for the measurement to complete. A value of
-1 specifies that the method waits until the measurement is complete.
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()
_helper.validate_not_none(selector_string, "selector_string")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.wait_for_measurement_complete( # type: ignore
updated_selector_string, timeout
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
@staticmethod
def build_result_string(result_name):
r"""Creates selector string for use with configuration or fetch.
Args:
result_name (string):
Specifies the result name for building the selector string.
This input accepts the result name with or without the "result::" prefix.
Example: "", "result::r1", "r1".
Returns:
string:
Contains the selector string created by this method.
"""
_helper.validate_not_none(result_name, "result_name")
return _helper.build_result_string(result_name)
@_raise_if_disposed
def clone_signal_configuration(self, new_signal_name):
r"""Creates a new instance of a signal by copying all the properties from an existing signal instance.
Args:
new_signal_name (string):
This parameter specifies the name of the new signal. This parameter accepts the signal name with or without the \"signal::\" prefix.
Example:
\"signal::NewSigName\"
\"NewSigName\"
Returns:
Tuple (cloned_signal, error_code):
cloned_signal (pulse):
Contains a new Pulse signal instance.
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(new_signal_name, "new_signal_name")
updated_new_signal_name = _helper.validate_and_remove_signal_qualifier(
new_signal_name, self
)
cloned_signal, error_code = self._interpreter.clone_signal_configuration( # type: ignore
self.signal_configuration_name, updated_new_signal_name
)
finally:
self._session_function_lock.exit_read_lock()
return cloned_signal, error_code
@_raise_if_disposed
def send_software_edge_trigger(self):
r"""Sends a trigger to the device when you use the `RFmxPulse Configure Trigger <RFmxPulse_Configure_Trigger.html>`_ method to
choose a software version of a trigger and the device is waiting for the trigger to be sent. You can also use this
method to override a hardware trigger.
This method returns an error in the following situations:
- You configure an invalid trigger.
- You have not previously called the :py:meth:`initiate` method.
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()
error_code = self._interpreter.send_software_edge_trigger() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return error_code
@_raise_if_disposed
def get_all_named_result_names(self, selector_string):
r"""Returns all the named result names of the signal that you specify in the Selector String parameter.
Args:
selector_string (string):
Pass an empty string.
The signal name that is passed when creating the signal configuration is used.
Returns:
Tuple (result_names, default_result_exists, error_code):
result_names (string):
Returns an array of result names.
default_result_exists (bool):
Indicates whether the default result exists.
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
)
result_names, default_result_exists, error_code = (
self._interpreter.get_all_named_result_names(updated_selector_string) # type: ignore
)
finally:
self._session_function_lock.exit_read_lock()
return result_names, default_result_exists, error_code
@_raise_if_disposed
def analyze_iq_1_waveform(self, selector_string, result_name, x0, dx, iq, reset):
r"""Performs the enabled measurements on the I/Q complex waveform that you specify in **IQ** parameter. Call this method
after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch methods or
result attributes in the attribute node.
Use this method only if the :py:attr:`~nirfmxinstr.attribute.AttributeID.RECOMMENDED_ACQUISITION_TYPE` attribute value
is either **IQ** or **IQ or Spectral**.
When using the Analysis-Only mode in RFmxPulse, the RFmx driver ignores the RFmx hardware settings such as
reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and
trigger type, since it is needed for spectral measurement traces as well as some measurements.
.. note::
Query the Recommended Acquisition Type attribute from the RFmxInstr Attribute after calling the :py:meth:`commit`
method.
Args:
selector_string (string):
This parameter specifies the signal name and result name. The result name can either be specified through this input
or the **Result Name** parameter. If you do
not specify the result name in this parameter, either the result name specified by the **Result Name** parameter or
the default result instance is used.
Example:
""
"result::r1"
You can use the :py:meth:`build_result_string` method to build the `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_.
result_name (string):
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to
enable fetching of multiple measurement results and traces. This input accepts the result name with or without the
"result::" prefix. The default value is "" (empty string), which refers to the default result instance.
Example:
""
"result::r1"
"r1"
x0 (float):
This parameter specifies the start time of the input **y** array. This value is expressed in seconds.
dx (float):
This parameter specifies the time interval between the samples in the input **y** array. This value is expressed in
seconds. The reciprocal of **dx** indicates the I/Q rate of the input signal.
iq (numpy.complex64):
This parameter specifies an array of complex-valued time domain data. The real and imaginary parts of this complex data
array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.
reset (bool):
This parameter resets measurement averaging. If you enable averaging, set this parameter to TRUE for the first record
and FALSE for the subsequent records.
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()
_helper.validate_not_none(selector_string, "selector_string")
_helper.validate_not_none(result_name, "result_name")
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self
)
error_code = self._interpreter.analyze_iq_1_waveform( # type: ignore
updated_selector_string, result_name, x0, dx, iq, int(reset)
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
class Pulse(_PulseBase):
"""Defines a root class which is used to identify and control Pulse signal configuration."""
def __init__(self, session, signal_name="", cloning=False):
"""Initializes a Pulse signal configuration."""
super(Pulse, self).__init__(
session=session,
signal_name=signal_name,
cloning=cloning,
) # type: ignore
def __enter__(self):
"""Enters the context of the Pulse signal configuration."""
return self
def __exit__(self, exc_type, exc_value, traceback):
"""Exits the context of the Pulse signal configuration."""
self.dispose() # type: ignore
pass