Skip to content

Commit 017a78b

Browse files
Vaishnavigupta1312Vaishnavigupta1312
committed
Related enums to functionas and renamed some enums
1 parent 3f90d2c commit 017a78b

File tree

6 files changed

+464
-464
lines changed

6 files changed

+464
-464
lines changed

‎docs/nirfsg/class.rst‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,30 +1281,30 @@ export_signal
12811281

12821282
Specifies the type of signal to route. **Defined Values** :
12831283

1284-
+-------------------------------------------------------------+---------+--------------------------------------------+
1285-
| Name | Value | Description |
1286-
+=============================================================+=========+============================================+
1287-
| :py:data:`~nirfsg.LoFilter.START_TRIGGER` | 0 (0x0) | Exports a Start Trigger. |
1288-
+-------------------------------------------------------------+---------+--------------------------------------------+
1289-
| :py:data:`~nirfsg.LoFilter.SCRIPT_TRIGGER` | 1 (0x1) | Exports a Script Trigger. |
1290-
+-------------------------------------------------------------+---------+--------------------------------------------+
1291-
| :py:data:`~nirfsg.LoFilter.MARKER_EVENT` | 2 (0x2) | Exports a Marker Event. |
1292-
+-------------------------------------------------------------+---------+--------------------------------------------+
1293-
| :py:data:`~nirfsg.LoFilter.REF_CLOCK` | 3 (0x3) | Exports the Reference Clock. |
1294-
+-------------------------------------------------------------+---------+--------------------------------------------+
1295-
| :py:data:`~nirfsg.LoFilter.STARTED_EVENT` | 4 (0x4) | Exports a Started Event. |
1296-
+-------------------------------------------------------------+---------+--------------------------------------------+
1297-
| :py:data:`~nirfsg.LoFilter.DONE_EVENT` | 5 (0x5) | Exports a Done Event. |
1298-
+-------------------------------------------------------------+---------+--------------------------------------------+
1299-
| :py:data:`~nirfsg.LoFilter.CONFIGURATION_LIST_STEP_TRIGGER` | 6 (0x6) | Exports a Configuration List Step Trigger. |
1300-
+-------------------------------------------------------------+---------+--------------------------------------------+
1301-
| :py:data:`~nirfsg.LoFilter.CONFIGURATION_SETTLED_EVENT` | 7 (0x7) | Exports a Configuration Settled Event. |
1302-
+-------------------------------------------------------------+---------+--------------------------------------------+
1284+
+-----------------------------------------------------------+---------+--------------------------------------------+
1285+
| Name | Value | Description |
1286+
+===========================================================+=========+============================================+
1287+
| :py:data:`~nirfsg.Signal.START_TRIGGER` | 0 (0x0) | Exports a Start Trigger. |
1288+
+-----------------------------------------------------------+---------+--------------------------------------------+
1289+
| :py:data:`~nirfsg.Signal.SCRIPT_TRIGGER` | 1 (0x1) | Exports a Script Trigger. |
1290+
+-----------------------------------------------------------+---------+--------------------------------------------+
1291+
| :py:data:`~nirfsg.Signal.MARKER_EVENT` | 2 (0x2) | Exports a Marker Event. |
1292+
+-----------------------------------------------------------+---------+--------------------------------------------+
1293+
| :py:data:`~nirfsg.Signal.REF_CLOCK` | 3 (0x3) | Exports the Reference Clock. |
1294+
+-----------------------------------------------------------+---------+--------------------------------------------+
1295+
| :py:data:`~nirfsg.Signal.STARTED_EVENT` | 4 (0x4) | Exports a Started Event. |
1296+
+-----------------------------------------------------------+---------+--------------------------------------------+
1297+
| :py:data:`~nirfsg.Signal.DONE_EVENT` | 5 (0x5) | Exports a Done Event. |
1298+
+-----------------------------------------------------------+---------+--------------------------------------------+
1299+
| :py:data:`~nirfsg.Signal.CONFIGURATION_LIST_STEP_TRIGGER` | 6 (0x6) | Exports a Configuration List Step Trigger. |
1300+
+-----------------------------------------------------------+---------+--------------------------------------------+
1301+
| :py:data:`~nirfsg.Signal.CONFIGURATION_SETTLED_EVENT` | 7 (0x7) | Exports a Configuration Settled Event. |
1302+
+-----------------------------------------------------------+---------+--------------------------------------------+
13031303

13041304
.. 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.
13051305

13061306

1307-
:type signal: :py:data:`nirfsg.LoFilter`
1307+
:type signal: :py:data:`nirfsg.Signal`
13081308
:param signal_identifier:
13091309

13101310

@@ -1921,26 +1921,26 @@ self_calibrate_range
19211921

19221922
Specifies which calibration steps to skip during the self-calibration process. The default value is an empty array, which indicates that no calibration steps are omitted. **Defined Values** :
19231923

1924-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1925-
| Name | Value | Description |
1926-
+=============================================================+===========+=====================================================================================================================+
1927-
| :py:data:`~nirfsg.SelfCalibrateRange.OMIT_NONE` | 0 (0x0) | No calibration steps are omitted. |
1928-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1929-
| :py:data:`~nirfsg.SelfCalibrateRange.LO_SELF_CAL` | 1 (0x1) | Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted. |
1930-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1931-
| :py:data:`~nirfsg.SelfCalibrateRange.POWER_LEVEL_ACCURACY` | 2 (0x2) | Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted. |
1932-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1933-
| :py:data:`~nirfsg.SelfCalibrateRange.RESIDUAL_LO_POWER` | 4 (0x4) | Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. |
1934-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1935-
| :py:data:`~nirfsg.SelfCalibrateRange.IMAGE_SUPPRESSION` | 8 (0x8) | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted. |
1936-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1937-
| :py:data:`~nirfsg.SelfCalibrateRange.SYNTHESIZER_ALIGNMENT` | 16 (0x10) | Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. |
1938-
+-------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1924+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1925+
| Name | Value | Description |
1926+
+========================================================================+===========+=====================================================================================================================+
1927+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.OMIT_NONE` | 0 (0x0) | No calibration steps are omitted. |
1928+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1929+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.LO_SELF_CAL` | 1 (0x1) | Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted. |
1930+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1931+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.POWER_LEVEL_ACCURACY` | 2 (0x2) | Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted. |
1932+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1933+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.RESIDUAL_LO_POWER` | 4 (0x4) | Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. |
1934+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1935+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.IMAGE_SUPPRESSION` | 8 (0x8) | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted. |
1936+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
1937+
| :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.SYNTHESIZER_ALIGNMENT` | 16 (0x10) | Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. |
1938+
+------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+
19391939

19401940
.. 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.
19411941

19421942

1943-
:type steps_to_omit: :py:data:`nirfsg.SelfCalibrateRange`
1943+
:type steps_to_omit: :py:data:`nirfsg.SelfCalibrateRangeStepsToOmit`
19441944
:param min_frequency:
19451945

19461946

@@ -2029,18 +2029,18 @@ send_software_edge_trigger
20292029

20302030
Specifies the trigger to send. **Defined Values** :
20312031

2032-
+-----------------------------------+---------+-------------------------------+
2033-
| Name | Value | Description |
2034-
+===================================+=========+===============================+
2035-
| :py:data:`~nirfsg.Trigger.START` | 0 (0x0) | Specifies the Start Trigger. |
2036-
+-----------------------------------+---------+-------------------------------+
2037-
| :py:data:`~nirfsg.Trigger.SCRIPT` | 1 (0x1) | Specifies the Script Trigger. |
2038-
+-----------------------------------+---------+-------------------------------+
2032+
+-----------------------------------------------+---------+-------------------------------+
2033+
| Name | Value | Description |
2034+
+===============================================+=========+===============================+
2035+
| :py:data:`~nirfsg.SoftwareTriggerType.START` | 0 (0x0) | Specifies the Start Trigger. |
2036+
+-----------------------------------------------+---------+-------------------------------+
2037+
| :py:data:`~nirfsg.SoftwareTriggerType.SCRIPT` | 1 (0x1) | Specifies the Script Trigger. |
2038+
+-----------------------------------------------+---------+-------------------------------+
20392039

20402040
.. 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.
20412041

20422042

2043-
:type trigger: :py:data:`nirfsg.Trigger`
2043+
:type trigger: :py:data:`nirfsg.SoftwareTriggerType`
20442044
:param trigger_identifier:
20452045

20462046

0 commit comments

Comments
 (0)