diff --git a/CHANGELOG.md b/CHANGELOG.md index d0101f9675..0540e8d212 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1702,6 +1702,7 @@ #### [nirfsg] Unreleased - Added + - `AMPLITUDE_FLATNESS` and `AMPLITUDE_AND_PHASE_FLATNESS` added to enum `DeembeddingType` - Changed - Removed diff --git a/docs/nirfsg/class.rst b/docs/nirfsg/class.rst index d41c0cf8a6..7b8806965f 100644 --- a/docs/nirfsg/class.rst +++ b/docs/nirfsg/class.rst @@ -4179,27 +4179,33 @@ deembedding_type To use this property, you must use the channelName parameter of the :py:meth:`nirfsg.Session._set_attribute_vi_int32` method to specify the name of the port to configure for de-embedding. - If you set this property to :py:data:`~nirfsg.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.VECTOR`, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. + If you set this property to any value besides :py:data:`~nirfsg.DeembeddingType.NONE`, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. **Default Value**: :py:data:`~nirfsg.DeembeddingType.SCALAR` - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.NONE` + **Valid Values for PXIe-5830/5832/5840/5841** : :py:data:`~nirfsg.DeembeddingType.NONE` or :py:data:`~nirfsg.DeembeddingType.SCALAR` - **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingType.SCALAR`, :py:data:`~nirfsg.DeembeddingType.VECTOR`, or :py:data:`~nirfsg.DeembeddingType.NONE`. :py:data:`~nirfsg.DeembeddingType.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5842/5860** : :py:data:`~nirfsg.DeembeddingType.NONE` or :py:data:`~nirfsg.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_FLATNESS` or :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS` + + **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingType.NONE`, :py:data:`~nirfsg.DeembeddingType.SCALAR`, or :py:data:`~nirfsg.DeembeddingType.VECTOR`. :py:data:`~nirfsg.DeembeddingType.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +-------------------------------------------+----------------+------------------------------------------------------------------------+ - | Name | Value | Description | - +===========================================+================+========================================================================+ - | :py:data:`~nirfsg.DeembeddingType.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. | - +-------------------------------------------+----------------+------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DeembeddingType.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | - +-------------------------------------------+----------------+------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DeembeddingType.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | - +-------------------------------------------+----------------+------------------------------------------------------------------------+ + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | Name | Value | Description | + +=================================================================+================+===================================================================================+ + | :py:data:`~nirfsg.DeembeddingType.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. | + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingType.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingType.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_FLATNESS` | 25003 (0x61ab) | De-embeds the measurement using wideband amplitude flatness correction. | + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS` | 25004 (0x61ac) | De-embeds the measurement using wideband amplitude and phase flatness correction. | + +-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific ports within your :py:class:`nirfsg.Session` instance. diff --git a/docs/nirfsg/enums.rst b/docs/nirfsg/enums.rst index 8ed758c60c..44b022fdea 100644 --- a/docs/nirfsg/enums.rst +++ b/docs/nirfsg/enums.rst @@ -346,6 +346,26 @@ DeembeddingType + .. py:attribute:: DeembeddingType.AMPLITUDE_FLATNESS + + + + De-embeds the measurement using wideband amplitude flatness correction. + + + + + + .. py:attribute:: DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS + + + + De-embeds the measurement using wideband amplitude and phase flatness correction. + + + + + DigitalEqualizationEnabled -------------------------- diff --git a/generated/nirfsg/nirfsg/enums.py b/generated/nirfsg/nirfsg/enums.py index bfa5d6c6b7..0b4b514e13 100644 --- a/generated/nirfsg/nirfsg/enums.py +++ b/generated/nirfsg/nirfsg/enums.py @@ -151,6 +151,14 @@ class DeembeddingType(Enum): r''' De-embeds the measurement using the gain term and the reflection term. ''' + AMPLITUDE_FLATNESS = 25003 + r''' + De-embeds the measurement using wideband amplitude flatness correction. + ''' + AMPLITUDE_AND_PHASE_FLATNESS = 25004 + r''' + De-embeds the measurement using wideband amplitude and phase flatness correction. + ''' class DigitalEqualizationEnabled(Enum): diff --git a/generated/nirfsg/nirfsg/session.py b/generated/nirfsg/nirfsg/session.py index 0e131adc63..83ec53bd2c 100644 --- a/generated/nirfsg/nirfsg/session.py +++ b/generated/nirfsg/nirfsg/session.py @@ -822,27 +822,33 @@ class _SessionBase(object): To use this property, you must use the channelName parameter of the _set_attribute_vi_int32 method to specify the name of the port to configure for de-embedding. - If you set this property to DeembeddingType.SCALAR or DeembeddingType.VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. + If you set this property to any value besides DeembeddingType.NONE, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. **Default Value**: DeembeddingType.SCALAR - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingType.SCALAR or DeembeddingType.NONE + **Valid Values for PXIe-5830/5832/5840/5841** : DeembeddingType.NONE or DeembeddingType.SCALAR - **Valid Values for PXIe-5831** DeembeddingType.SCALAR, DeembeddingType.VECTOR, or DeembeddingType.NONE. DeembeddingType.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5842/5860** : DeembeddingType.NONE or DeembeddingType.SCALAR or DeembeddingType.AMPLITUDE_FLATNESS or DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS + + **Valid Values for PXIe-5831** DeembeddingType.NONE, DeembeddingType.SCALAR, or DeembeddingType.VECTOR. DeembeddingType.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +------------------------+----------------+------------------------------------------------------------------------+ - | Name | Value | Description | - +========================+================+========================================================================+ - | DeembeddingType.NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. | - +------------------------+----------------+------------------------------------------------------------------------+ - | DeembeddingType.SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | - +------------------------+----------------+------------------------------------------------------------------------+ - | DeembeddingType.VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | - +------------------------+----------------+------------------------------------------------------------------------+ + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | Name | Value | Description | + +==============================================+================+===================================================================================+ + | DeembeddingType.NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. | + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | DeembeddingType.SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | DeembeddingType.VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | DeembeddingType.AMPLITUDE_FLATNESS | 25003 (0x61ab) | De-embeds the measurement using wideband amplitude flatness correction. | + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ + | DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS | 25004 (0x61ac) | De-embeds the measurement using wideband amplitude and phase flatness correction. | + +----------------------------------------------+----------------+-----------------------------------------------------------------------------------+ Tip: This property can be set/get on specific ports within your :py:class:`nirfsg.Session` instance. diff --git a/src/nirfsg/metadata/attributes.py b/src/nirfsg/metadata/attributes.py index 102b759d56..e3ee61f1e4 100644 --- a/src/nirfsg/metadata/attributes.py +++ b/src/nirfsg/metadata/attributes.py @@ -3360,7 +3360,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the type of de-embedding to apply to measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.\n\n**Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE\n\n**Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'description': 'Specifies the type of de-embedding to apply to measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to any value besides NIRFSG_VAL_DEEMBEDDING_TYPE_NONE, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.\n\n**Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841** : NIRFSG_VAL_DEEMBEDDING_TYPE_NONE or NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_NONE or NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS or NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS\n\n**Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_NONE, NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, or NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DEEMBEDDING_TYPE_NONE', @@ -3376,6 +3376,16 @@ 'NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR', '25002 (0x61aa)', 'De-embeds the measurement using the gain term and the reflection term.' + ], + [ + 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS', + '25003 (0x61ab)', + 'De-embeds the measurement using wideband amplitude flatness correction.' + ], + [ + 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS', + '25004 (0x61ac)', + 'De-embeds the measurement using wideband amplitude and phase flatness correction.' ] ], 'table_header': [ diff --git a/src/nirfsg/metadata/enums.py b/src/nirfsg/metadata/enums.py index b1c411b502..47f403d62b 100644 --- a/src/nirfsg/metadata/enums.py +++ b/src/nirfsg/metadata/enums.py @@ -245,6 +245,20 @@ }, 'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR', 'value': 25002 + }, + { + 'documentation': { + 'description': 'De-embeds the measurement using wideband amplitude flatness correction.' + }, + 'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS', + 'value': 25003 + }, + { + 'documentation': { + 'description': 'De-embeds the measurement using wideband amplitude and phase flatness correction.' + }, + 'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS', + 'value': 25004 } ] },