Skip to content

Commit cff22c9

Browse files
mohit-emersonmohit-emerson
authored
Add new deembedding type in NI-RFSA (#2199)
1 parent b7a6c22 commit cff22c9

6 files changed

Lines changed: 50 additions & 26 deletions

File tree

‎docs/nirfsa/class.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3330,25 +3330,25 @@ deembedding_type
33303330

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

3333-
**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`
3333+
**Valid Values for PXIe-5842/5860** : :py:data:`~nirfsa.DeembeddingType.NONE` or :py:data:`~nirfsa.DeembeddingType.SCALAR` or :py:data:`~nirfsa.DeembeddingType.AMPLITUDE_FLATNESS`
33343334

33353335
**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).
33363336

33373337
**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860
33383338

33393339
**Defined Values**:
33403340

3341-
+-------------------------------------------+------------------------------------------------------------------------+
3342-
| Name | Description |
3343-
+===========================================+========================================================================+
3344-
| :py:data:`~nirfsa.DeembeddingType.NONE` | De-embedding is not applied to the measurement. |
3345-
+-------------------------------------------+------------------------------------------------------------------------+
3346-
| :py:data:`~nirfsa.DeembeddingType.SCALAR` | De-embeds the measurement using only the gain term. |
3347-
+-------------------------------------------+------------------------------------------------------------------------+
3348-
| :py:data:`~nirfsa.DeembeddingType.VECTOR` | De-embeds the measurement using the gain term and the reflection term. |
3349-
+-------------------------------------------+------------------------------------------------------------------------+
3350-
3351-
.. 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.
3341+
+-------------------------------------------------------+-------------------------------------------------------------------------+
3342+
| Name | Description |
3343+
+=======================================================+=========================================================================+
3344+
| :py:data:`~nirfsa.DeembeddingType.NONE` | De-embedding is not applied to the measurement. |
3345+
+-------------------------------------------------------+-------------------------------------------------------------------------+
3346+
| :py:data:`~nirfsa.DeembeddingType.SCALAR` | De-embeds the measurement using only the gain term. |
3347+
+-------------------------------------------------------+-------------------------------------------------------------------------+
3348+
| :py:data:`~nirfsa.DeembeddingType.VECTOR` | De-embeds the measurement using the gain term and the reflection term. |
3349+
+-------------------------------------------------------+-------------------------------------------------------------------------+
3350+
| :py:data:`~nirfsa.DeembeddingType.AMPLITUDE_FLATNESS` | De-embeds the measurement using wideband amplitude flatness correction. |
3351+
+-------------------------------------------------------+-------------------------------------------------------------------------+
33523352

33533353

33543354
.. tip:: This property can be set/get on specific ports within your :py:class:`nirfsa.Session` instance.

‎docs/nirfsa/enums.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,16 @@ DeembeddingType
391391

392392

393393

394+
.. py:attribute:: DeembeddingType.AMPLITUDE_FLATNESS
395+
396+
397+
398+
De-embeds the measurement using wideband amplitude flatness correction.
399+
400+
401+
402+
403+
394404
DeviceResponseType
395405
------------------
396406

‎generated/nirfsa/nirfsa/enums.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ class DeembeddingType(Enum):
168168
r'''
169169
De-embeds the measurement using the gain term and the reflection term.
170170
'''
171+
AMPLITUDE_FLATNESS = 3903
172+
r'''
173+
De-embeds the measurement using wideband amplitude flatness correction.
174+
'''
171175

172176

173177
class DeviceResponseType(Enum):

‎generated/nirfsa/nirfsa/session.py‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -482,26 +482,25 @@ class _SessionBase(object):
482482

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

485-
**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
485+
**Valid Values for PXIe-5842/5860** : DeembeddingType.NONE or DeembeddingType.SCALAR or DeembeddingType.AMPLITUDE_FLATNESS
486486

487487
**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).
488488

489489
**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860
490490

491491
**Defined Values**:
492492

493-
+------------------------+------------------------------------------------------------------------+
494-
| Name | Description |
495-
+========================+========================================================================+
496-
| DeembeddingType.NONE | De-embedding is not applied to the measurement. |
497-
+------------------------+------------------------------------------------------------------------+
498-
| DeembeddingType.SCALAR | De-embeds the measurement using only the gain term. |
499-
+------------------------+------------------------------------------------------------------------+
500-
| DeembeddingType.VECTOR | De-embeds the measurement using the gain term and the reflection term. |
501-
+------------------------+------------------------------------------------------------------------+
502-
503-
Note:
504-
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.
493+
+------------------------------------+-------------------------------------------------------------------------+
494+
| Name | Description |
495+
+====================================+=========================================================================+
496+
| DeembeddingType.NONE | De-embedding is not applied to the measurement. |
497+
+------------------------------------+-------------------------------------------------------------------------+
498+
| DeembeddingType.SCALAR | De-embeds the measurement using only the gain term. |
499+
+------------------------------------+-------------------------------------------------------------------------+
500+
| DeembeddingType.VECTOR | De-embeds the measurement using the gain term and the reflection term. |
501+
+------------------------------------+-------------------------------------------------------------------------+
502+
| DeembeddingType.AMPLITUDE_FLATNESS | De-embeds the measurement using wideband amplitude flatness correction. |
503+
+------------------------------------+-------------------------------------------------------------------------+
505504

506505
Tip:
507506
This property can be set/get on specific ports within your :py:class:`nirfsa.Session` instance.

‎src/nirfsa/metadata/attributes.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3986,7 +3986,7 @@
39863986
'access': 'read-write',
39873987
'codegen_method': 'public',
39883988
'documentation': {
3989-
'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**:',
3989+
'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**:',
39903990
'table_body': [
39913991
[
39923992
'NIRFSA_VAL_DEEMBEDDING_TYPE_NONE',
@@ -3999,6 +3999,10 @@
39993999
[
40004000
'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR',
40014001
'De-embeds the measurement using the gain term and the reflection term.'
4002+
],
4003+
[
4004+
'NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
4005+
'De-embeds the measurement using wideband amplitude flatness correction.'
40024006
]
40034007
],
40044008
'table_header': [

‎src/nirfsa/metadata/enums.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,13 @@
284284
},
285285
'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR',
286286
'value': 3902
287+
},
288+
{
289+
'documentation': {
290+
'description': 'De-embeds the measurement using wideband amplitude flatness correction.'
291+
},
292+
'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
293+
'value': 3903
287294
}
288295
]
289296
},

0 commit comments

Comments
 (0)