nirfmxvna 26.3.0__py3-none-any.whl

nirfmxvna/internal/session_pb2.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: session.proto
+"""Generated protocol buffer code."""
+from google.protobuf import (
+    descriptor as _descriptor,
+    descriptor_pool as _descriptor_pool,
+    symbol_database as _symbol_database,
+)
+from google.protobuf.internal import builder as _builder
+
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
+    b'\n\rsession.proto\x12\rnidevice_grpc"\x17\n\x07Session\x12\x0c\n\x04name\x18\x01 \x01(\t*\xbc\x01\n\x1dSessionInitializationBehavior\x12/\n+SESSION_INITIALIZATION_BEHAVIOR_UNSPECIFIED\x10\x00\x12\x32\n.SESSION_INITIALIZATION_BEHAVIOR_INITIALIZE_NEW\x10\x01\x12\x36\n2SESSION_INITIALIZATION_BEHAVIOR_ATTACH_TO_EXISTING\x10\x02\x42\x42\n\x12\x63om.ni.grpc.deviceB\x08NiDeviceP\x01\xaa\x02\x1fNationalInstruments.Grpc.Deviceb\x06proto3'
+)
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "session_pb2", globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+    DESCRIPTOR._options = None
+    DESCRIPTOR._serialized_options = (
+        b"\n\022com.ni.grpc.deviceB\010NiDeviceP\001\252\002\037NationalInstruments.Grpc.Device"
+    )
+    _SESSIONINITIALIZATIONBEHAVIOR._serialized_start = 58
+    _SESSIONINITIALIZATIONBEHAVIOR._serialized_end = 246
+    _SESSION._serialized_start = 32
+    _SESSION._serialized_end = 55
+# @@protoc_insertion_point(module_scope)

nirfmxvna/internal/session_pb2_grpc.py

@@ -0,0 +1,3 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc

nirfmxvna/iq.py

@@ -0,0 +1,31 @@
+"""Represents the IQ measurement."""
+
+import functools
+
+import nirfmxvna.iq_configuration as configuration
+import nirfmxvna.iq_results as results
+
+
+def _raise_if_disposed(f):
+    """From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
+
+    @functools.wraps(f)
+    def aux(*xs, **kws):
+        meas_obj = xs[0]  # parameter 0 is 'self' which is the measurement object
+        if meas_obj._signal_obj.is_disposed:
+            raise Exception("Cannot access a disposed Vna signal configuration")
+        return f(*xs, **kws)
+
+    return aux
+
+
+class IQ(object):
+    """Represents the IQ measurement."""
+
+    def __init__(self, signal_obj):
+        """Represents the IQ measurement."""
+        self._signal_obj = signal_obj
+        self._session_function_lock = signal_obj._session_function_lock
+        self._interpreter = signal_obj._interpreter
+        self.configuration = configuration.IQConfiguration(signal_obj)  # type: ignore
+        self.results = results.IQResults(signal_obj)  # type: ignore

nirfmxvna/iq_configuration.py

@@ -0,0 +1,290 @@
+"""Provides methods to configure the IQ measurement."""
+
+import functools
+
+import nirfmxvna.attributes as attributes
+import nirfmxvna.internal._helper as _helper
+
+
+def _raise_if_disposed(f):
+    """From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
+
+    @functools.wraps(f)
+    def aux(*xs, **kws):
+        meas_obj = xs[0]  # parameter 0 is 'self' which is the measurement object
+        if meas_obj._signal_obj.is_disposed:
+            raise Exception("Cannot access a disposed Vna signal configuration")
+        return f(*xs, **kws)
+
+    return aux
+
+
+class IQConfiguration(object):
+    """Provides methods to configure the IQ measurement."""
+
+    def __init__(self, signal_obj):
+        """Provides methods to configure the IQ measurement."""
+        self._signal_obj = signal_obj
+        self._session_function_lock = signal_obj._session_function_lock
+        self._interpreter = signal_obj._interpreter
+
+    @_raise_if_disposed
+    def get_measurement_enabled(self, selector_string):
+        r"""
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+        Returns:
+            Tuple (attr_val, error_code):
+
+            attr_val (bool):
+
+
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            attr_val, error_code = self._interpreter.get_attribute_i32(
+                updated_selector_string, attributes.AttributeID.IQ_MEASUREMENT_ENABLED.value
+            )
+            attr_val = bool(attr_val)
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return attr_val, error_code
+
+    @_raise_if_disposed
+    def set_measurement_enabled(self, selector_string, value):
+        r"""
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+            value (bool):
+
+
+        Returns:
+            int:
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            error_code = self._interpreter.set_attribute_i32(
+                updated_selector_string,
+                attributes.AttributeID.IQ_MEASUREMENT_ENABLED.value,
+                int(value),
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return error_code
+
+    @_raise_if_disposed
+    def get_acquisition_time(self, selector_string):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+        Returns:
+            Tuple (attr_val, error_code):
+
+            attr_val (float):
+                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.
+
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            attr_val, error_code = self._interpreter.get_attribute_f64(
+                updated_selector_string, attributes.AttributeID.IQ_ACQUISITION_TIME.value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return attr_val, error_code
+
+    @_raise_if_disposed
+    def set_acquisition_time(self, selector_string, value):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+            value (float):
+                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.
+
+        Returns:
+            int:
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            error_code = self._interpreter.set_attribute_f64(
+                updated_selector_string, attributes.AttributeID.IQ_ACQUISITION_TIME.value, value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return error_code
+
+    @_raise_if_disposed
+    def get_receiver_port(self, selector_string):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+        Returns:
+            Tuple (attr_val, error_code):
+
+            attr_val (string):
+                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.
+
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            attr_val, error_code = self._interpreter.get_attribute_string(
+                updated_selector_string, attributes.AttributeID.IQ_RECEIVER_PORT.value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return attr_val, error_code
+
+    @_raise_if_disposed
+    def set_receiver_port(self, selector_string, value):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+            value (string):
+                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.
+
+        Returns:
+            int:
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            _helper.validate_not_none(value, "value")
+            error_code = self._interpreter.set_attribute_string(
+                updated_selector_string, attributes.AttributeID.IQ_RECEIVER_PORT.value, value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return error_code
+
+    @_raise_if_disposed
+    def get_source_port(self, selector_string):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+        Returns:
+            Tuple (attr_val, error_code):
+
+            attr_val (string):
+                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.
+
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            attr_val, error_code = self._interpreter.get_attribute_string(
+                updated_selector_string, attributes.AttributeID.IQ_SOURCE_PORT.value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return attr_val, error_code
+
+    @_raise_if_disposed
+    def set_source_port(self, selector_string, value):
+        r"""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.
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+            value (string):
+                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.
+
+        Returns:
+            int:
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            _helper.validate_not_none(value, "value")
+            error_code = self._interpreter.set_attribute_string(
+                updated_selector_string, attributes.AttributeID.IQ_SOURCE_PORT.value, value
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return error_code

nirfmxvna/iq_results.py

@@ -0,0 +1,108 @@
+"""Provides methods to fetch and read the IQ measurement results."""
+
+import functools
+
+import nirfmxvna.attributes as attributes
+import nirfmxvna.enums as enums
+import nirfmxvna.errors as errors
+import nirfmxvna.internal._helper as _helper
+
+
+def _raise_if_disposed(f):
+    """From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
+
+    @functools.wraps(f)
+    def aux(*xs, **kws):
+        meas_obj = xs[0]  # parameter 0 is 'self' which is the measurement object
+        if meas_obj._signal_obj.is_disposed:
+            raise Exception("Cannot access a disposed Vna signal configuration")
+        return f(*xs, **kws)
+
+    return aux
+
+
+class IQResults(object):
+    """Provides methods to fetch and read the IQ measurement results."""
+
+    def __init__(self, signal_obj):
+        """Provides methods to fetch and read the IQ measurement results."""
+        self._signal_obj = signal_obj
+        self._session_function_lock = signal_obj._session_function_lock
+        self._interpreter = signal_obj._interpreter
+
+    @_raise_if_disposed
+    def get_correction_state(self, selector_string):
+        r"""Gets the error correction state of the VNA IQ measurement.
+
+        Use "iq<*n*>" as the selector string to read this attribute.
+
+        +-----------------------+---------------------------------------------------------------------------------------------------------------------+
+        | Name (Value)          | Description                                                                                                         |
+        +=======================+=====================================================================================================================+
+        | None (0)              | Error correction is not applied.                                                                                    |
+        +-----------------------+---------------------------------------------------------------------------------------------------------------------+
+        | Corrected (1)         | Error correction is applied without interpolation using the error terms from the calset.                            |
+        +-----------------------+---------------------------------------------------------------------------------------------------------------------+
+        | Interpolated (2)      | Error correction is applied with error terms for at least one sweep point interpolated from the calset error terms. |
+        +-----------------------+---------------------------------------------------------------------------------------------------------------------+
+        | Settings Modified (3) | Settings during the measurment differ from those used during calibration.                                           |
+        +-----------------------+---------------------------------------------------------------------------------------------------------------------+
+
+        Args:
+            selector_string (string):
+                Pass an empty string.
+
+        Returns:
+            Tuple (attr_val, error_code):
+
+            attr_val (enums.IQCorrectionState):
+                Returns the error correction state of the VNA IQ measurement.
+
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            attr_val, error_code = self._interpreter.get_attribute_i32(
+                updated_selector_string, attributes.AttributeID.IQ_RESULTS_CORRECTION_STATE.value
+            )
+            attr_val = enums.IQCorrectionState(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 fetch_data(self, selector_string, timeout, data):
+        r"""
+
+        Args:
+            selector_string (string):
+            timeout (float):
+            data (numpy.complex64):
+        Returns:
+            Tuple (x0, dx, error_code):
+
+            x0 (float):
+            dx (float):
+            error_code (int):
+                Returns the status code of this method. The status code either indicates success or describes a warning condition.
+        """
+        try:
+            self._session_function_lock.enter_read_lock()
+            _helper.validate_not_none(selector_string, "selector_string")
+            updated_selector_string = _helper.validate_and_update_selector_string(
+                selector_string, self._signal_obj
+            )
+            x0, dx, error_code = self._interpreter.iq_fetch_data(
+                updated_selector_string, timeout, data
+            )
+        finally:
+            self._session_function_lock.exit_read_lock()
+
+        return x0, dx, error_code

nirfmxvna/marker.py

@@ -0,0 +1,31 @@
+"""Represents the Marker measurement."""
+
+import functools
+
+import nirfmxvna.marker_configuration as configuration
+import nirfmxvna.marker_results as results
+
+
+def _raise_if_disposed(f):
+    """From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
+
+    @functools.wraps(f)
+    def aux(*xs, **kws):
+        meas_obj = xs[0]  # parameter 0 is 'self' which is the measurement object
+        if meas_obj._signal_obj.is_disposed:
+            raise Exception("Cannot access a disposed Vna signal configuration")
+        return f(*xs, **kws)
+
+    return aux
+
+
+class Marker(object):
+    """Represents the Marker measurement."""
+
+    def __init__(self, signal_obj):
+        """Represents the Marker measurement."""
+        self._signal_obj = signal_obj
+        self._session_function_lock = signal_obj._session_function_lock
+        self._interpreter = signal_obj._interpreter
+        self.configuration = configuration.MarkerConfiguration(signal_obj)  # type: ignore
+        self.results = results.MarkerResults(signal_obj)  # type: ignore