Skip to content

Commit c605ee2

Browse files
Corrected enum value
1 parent 48bdec3 commit c605ee2

File tree

3 files changed

+16
-24
lines changed

3 files changed

+16
-24
lines changed

docs/nirfsg/class.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5149,27 +5149,27 @@ deembedding_type
51495149

51505150
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.
51515151

5152-
If you set this property to :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.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.
5152+
If you set this property to :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.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.
51535153

5154-
**Default Value**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR`
5154+
**Default Value**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR`
51555155

5156-
**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE`
5156+
**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE`
51575157

5158-
**Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS).
5158+
**Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS).
51595159

51605160
**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860
51615161

51625162
**Defined Values**:
51635163

5164-
+--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+
5165-
| Name | Value | Description |
5166-
+====================================================================+================+========================================================================+
5167-
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
5168-
+--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+
5169-
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
5170-
+--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+
5171-
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
5172-
+--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+
5164+
+---------------------------------------------------+----------------+------------------------------------------------------------------------+
5165+
| Name | Value | Description |
5166+
+===================================================+================+========================================================================+
5167+
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
5168+
+---------------------------------------------------+----------------+------------------------------------------------------------------------+
5169+
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
5170+
+---------------------------------------------------+----------------+------------------------------------------------------------------------+
5171+
| :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
5172+
+---------------------------------------------------+----------------+------------------------------------------------------------------------+
51735173

51745174

51755175
.. tip:: This property can be set/get on specific deembedding_port within your :py:class:`nirfsg.Session` instance.

docs/nirfsg/enums.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ DeembeddingTypeAttrVals
399399

400400
.. py:class:: DeembeddingTypeAttrVals
401401
402-
.. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE
402+
.. py:attribute:: DeembeddingTypeAttrVals.NONE
403403
404404
405405
@@ -409,11 +409,7 @@ DeembeddingTypeAttrVals
409409

410410

411411

412-
.. py:attribute:: DeembeddingTypeAttrVals.NONE
413-
414-
415-
416-
.. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR
412+
.. py:attribute:: DeembeddingTypeAttrVals.SCALAR
417413
418414
419415
@@ -423,7 +419,7 @@ DeembeddingTypeAttrVals
423419

424420

425421

426-
.. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR
422+
.. py:attribute:: DeembeddingTypeAttrVals.VECTOR
427423
428424
429425

src/nirfsg/metadata/enums.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -417,10 +417,6 @@
417417
'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_NONE',
418418
'value': 25000
419419
},
420-
{
421-
'name': 'NIRFSG_VAL_NONE',
422-
'value': 0
423-
},
424420
{
425421
'documentation': {
426422
'description': 'De-embeds the measurement using only the gain term.'

0 commit comments

Comments
 (0)