Skip to content

Add new deembedding type in NI-RFSA #2199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnktshr21 merged 2 commits into from
Aug 20, 2026
Merged

Add new deembedding type in NI-RFSA #2199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df71c6c
added NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS
mohit-emerson Aug 20, 2026
1809f9a
codegen
mohit-emerson Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/nirfsa/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3330,25 +3330,25 @@ deembedding_type

**Valid Values for PXIe-5830/5832/5840/5841** : :py:data:`~nirfsa.DeembeddingType.NONE` or :py:data:`~nirfsa.DeembeddingType.SCALAR`

**Valid Values for PXIe-5842/5860** : :py:data:`~nirfsa.DeembeddingType.NONE` or :py:data:`~nirfsa.DeembeddingType.SCALAR` or :py:data:`~nirfsa.NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS` or :py:data:`~nirfsa.NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS`
**Valid Values for PXIe-5842/5860** : :py:data:`~nirfsa.DeembeddingType.NONE` or :py:data:`~nirfsa.DeembeddingType.SCALAR` or :py:data:`~nirfsa.DeembeddingType.AMPLITUDE_FLATNESS`

**Valid Values for PXIe-5831:** :py:data:`~nirfsa.DeembeddingType.NONE`, :py:data:`~nirfsa.DeembeddingType.SCALAR`, or :py:data:`~nirfsa.DeembeddingType.VECTOR`. :py:data:`~nirfsa.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 | Description |
+===========================================+========================================================================+
| :py:data:`~nirfsa.DeembeddingType.NONE` | De-embedding is not applied to the measurement. |
+-------------------------------------------+------------------------------------------------------------------------+
| :py:data:`~nirfsa.DeembeddingType.SCALAR` | De-embeds the measurement using only the gain term. |
+-------------------------------------------+------------------------------------------------------------------------+
| :py:data:`~nirfsa.DeembeddingType.VECTOR` | De-embeds the measurement using the gain term and the reflection term. |
+-------------------------------------------+------------------------------------------------------------------------+

.. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
+-------------------------------------------------------+-------------------------------------------------------------------------+
| Name | Description |
+=======================================================+=========================================================================+
| :py:data:`~nirfsa.DeembeddingType.NONE` | De-embedding is not applied to the measurement. |
+-------------------------------------------------------+-------------------------------------------------------------------------+
| :py:data:`~nirfsa.DeembeddingType.SCALAR` | De-embeds the measurement using only the gain term. |
+-------------------------------------------------------+-------------------------------------------------------------------------+
| :py:data:`~nirfsa.DeembeddingType.VECTOR` | De-embeds the measurement using the gain term and the reflection term. |
+-------------------------------------------------------+-------------------------------------------------------------------------+
| :py:data:`~nirfsa.DeembeddingType.AMPLITUDE_FLATNESS` | De-embeds the measurement using wideband amplitude flatness correction. |
+-------------------------------------------------------+-------------------------------------------------------------------------+


.. tip:: This property can be set/get on specific ports within your :py:class:`nirfsa.Session` instance.
Expand Down
10 changes: 10 additions & 0 deletions docs/nirfsa/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,16 @@ DeembeddingType



.. py:attribute:: DeembeddingType.AMPLITUDE_FLATNESS



De-embeds the measurement using wideband amplitude flatness correction.





DeviceResponseType
------------------

Expand Down
4 changes: 4 additions & 0 deletions generated/nirfsa/nirfsa/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ class DeembeddingType(Enum):
r'''
De-embeds the measurement using the gain term and the reflection term.
'''
AMPLITUDE_FLATNESS = 3903
r'''
De-embeds the measurement using wideband amplitude flatness correction.
'''


class DeviceResponseType(Enum):
Expand Down
25 changes: 12 additions & 13 deletions generated/nirfsa/nirfsa/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,26 +482,25 @@ class _SessionBase(object):

**Valid Values for PXIe-5830/5832/5840/5841** : DeembeddingType.NONE or DeembeddingType.SCALAR

**Valid Values for PXIe-5842/5860** : DeembeddingType.NONE or DeembeddingType.SCALAR or NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS or NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS
**Valid Values for PXIe-5842/5860** : DeembeddingType.NONE or DeembeddingType.SCALAR or DeembeddingType.AMPLITUDE_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 | Description |
+========================+========================================================================+
| DeembeddingType.NONE | De-embedding is not applied to the measurement. |
+------------------------+------------------------------------------------------------------------+
| DeembeddingType.SCALAR | De-embeds the measurement using only the gain term. |
+------------------------+------------------------------------------------------------------------+
| DeembeddingType.VECTOR | De-embeds the measurement using the gain term and the reflection term. |
+------------------------+------------------------------------------------------------------------+

Note:
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
+------------------------------------+-------------------------------------------------------------------------+
| Name | Description |
+====================================+=========================================================================+
| DeembeddingType.NONE | De-embedding is not applied to the measurement. |
+------------------------------------+-------------------------------------------------------------------------+
| DeembeddingType.SCALAR | De-embeds the measurement using only the gain term. |
+------------------------------------+-------------------------------------------------------------------------+
| DeembeddingType.VECTOR | De-embeds the measurement using the gain term and the reflection term. |
+------------------------------------+-------------------------------------------------------------------------+
| DeembeddingType.AMPLITUDE_FLATNESS | De-embeds the measurement using wideband amplitude flatness correction. |
+------------------------------------+-------------------------------------------------------------------------+

Tip:
This property can be set/get on specific ports within your :py:class:`nirfsa.Session` instance.
Expand Down
6 changes: 5 additions & 1 deletion src/nirfsa/metadata/attributes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3986,7 +3986,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 nirfsa_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to any value besides NIRFSA_VAL_DEEMBEDDING_TYPE_NONE, NI-RFSA 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**: NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841** : NIRFSA_VAL_DEEMBEDDING_TYPE_NONE or NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5842/5860** : NIRFSA_VAL_DEEMBEDDING_TYPE_NONE or NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS or NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS\n\n**Valid Values for PXIe-5831:** NIRFSA_VAL_DEEMBEDDING_TYPE_NONE, NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR, or NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR. NIRFSA_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 nirfsa_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to any value besides NIRFSA_VAL_DEEMBEDDING_TYPE_NONE, NI-RFSA 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**: NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841** : NIRFSA_VAL_DEEMBEDDING_TYPE_NONE or NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5842/5860** : NIRFSA_VAL_DEEMBEDDING_TYPE_NONE or NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS\n\n**Valid Values for PXIe-5831:** NIRFSA_VAL_DEEMBEDDING_TYPE_NONE, NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR, or NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR. NIRFSA_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': [
[
'NIRFSA_VAL_DEEMBEDDING_TYPE_NONE',
Expand All @@ -3999,6 +3999,10 @@
[
'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR',
'De-embeds the measurement using the gain term and the reflection term.'
],
[
'NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
'De-embeds the measurement using wideband amplitude flatness correction.'
]
],
'table_header': [
Expand Down
7 changes: 7 additions & 0 deletions src/nirfsa/metadata/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,13 @@
},
'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR',
'value': 3902
},
{
'documentation': {
'description': 'De-embeds the measurement using wideband amplitude flatness correction.'
},
'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
'value': 3903
}
]
},
Expand Down
Loading