From 074b056593aff4869da24950cf3f1b668cfba442 Mon Sep 17 00:00:00 2001 From: Mark Silva Date: Mon, 21 May 2018 11:04:29 -0500 Subject: [PATCH 1/3] Remove OSP attributes from nifgen --- src/nifgen/metadata/attributes_addon.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/nifgen/metadata/attributes_addon.py b/src/nifgen/metadata/attributes_addon.py index 3510112a7..c8a29ed9d 100644 --- a/src/nifgen/metadata/attributes_addon.py +++ b/src/nifgen/metadata/attributes_addon.py @@ -50,6 +50,31 @@ 1050103: { "codegen_method": "no" }, # ERROR_ELABORATION - IVI Attribute - #824 1050003: { "codegen_method": "no" }, # QUERY_INSTR_STATUS - IVI Attribute - #824 1050004: { "codegen_method": "no" }, # CACHE - IVI Attribute - #824 + 1150256: { "codegen_method": "no" }, # OSP_FIR_FILTER_INTERPOLATION - OSP Attribute - #864 + 1150262: { "codegen_method": "no" }, # OSP_FIR_FILTER_GAUSSIAN_BT - OSP Attribute - #864 + 1150261: { "codegen_method": "no" }, # OSP_FIR_FILTER_FLAT_PASSBAND - OSP Attribute - #864 + 1150255: { "codegen_method": "no" }, # OSP_FIR_FILTER_ENABLED - OSP Attribute - #864 + 1150246: { "codegen_method": "no" }, # OSP_ENABLED - OSP Attribute - #864 + 1150247: { "codegen_method": "no" }, # OSP_DATA_PROCESSING_MODE - OSP Attribute - #864 + 1150389: { "codegen_method": "no" }, # OSP_COMPENSATE_FOR_FILTER_GROUP_DELAY - OSP Attribute - #864 + 1150258: { "codegen_method": "no" }, # OSP_CIC_FILTER_INTERPOLATION - OSP Attribute - #864 + 1150263: { "codegen_method": "no" }, # OSP_CIC_FILTER_GAIN - OSP Attribute - #864 + 1150257: { "codegen_method": "no" }, # OSP_CIC_FILTER_ENABLED - OSP Attribute - #864 + 1150252: { "codegen_method": "no" }, # OSP_CARRIER_PHASE_Q - OSP Attribute - #864 + 1150251: { "codegen_method": "no" }, # OSP_CARRIER_PHASE_I - OSP Attribute - #864 + 1150250: { "codegen_method": "no" }, # OSP_CARRIER_FREQUENCY - OSP Attribute - #864 + 1150249: { "codegen_method": "no" }, # OSP_CARRIER_ENABLED - OSP Attribute - #864 + 1150267: { "codegen_method": "no" }, # OSP_PRE_FILTER_OFFSET_Q - OSP Attribute - #864 + 1150266: { "codegen_method": "no" }, # OSP_PRE_FILTER_OFFSET_I - OSP Attribute - #864 + 1150265: { "codegen_method": "no" }, # OSP_PRE_FILTER_GAIN_Q - OSP Attribute - #864 + 1150264: { "codegen_method": "no" }, # OSP_PRE_FILTER_GAIN_I - OSP Attribute - #864 + 1150269: { "codegen_method": "no" }, # OSP_OVERFLOW_STATUS - OSP Attribute - #864 + 1150268: { "codegen_method": "no" }, # OSP_OVERFLOW_ERROR_REPORTING - OSP Attribute - #864 + 1150370: { "codegen_method": "no" }, # OSP_MODE - OSP Attribute - #864 + 1150371: { "codegen_method": "no" }, # OSP_FREQUENCY_SHIFT - OSP Attribute - #864 + 1150253: { "codegen_method": "no" }, # OSP_FIR_FILTER_TYPE - OSP Attribute - #864 + 1150259: { "codegen_method": "no" }, # OSP_FIR_FILTER_ROOT_RAISED_COSINE_ALPHA - OSP Attribute - #864 + 1150260: { "codegen_method": "no" }, # OSP_FIR_FILTER_RAISED_COSINE_ALPHA - OSP Attribute - #864 } attributes_converters = { From 92dc435cc3409e14bb99197e0b89b73f03c97dbd Mon Sep 17 00:00:00 2001 From: Mark Silva Date: Mon, 21 May 2018 11:04:37 -0500 Subject: [PATCH 2/3] Update changelog --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56f3f8e41..d2d8d40d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -65,6 +65,31 @@ All notable changes to this project will be documented in this file. * `session.configure_digital_level_script_trigger('ScriptTrigger0', source, ...)` becomes `session.script_triggers[0].configure_digital_level_script_trigger(source, ...)` * #### Removed * `export_signal()` - [#828](https://github.com/ni/nimi-python/issues/828) + * `osp_fir_filter_interpolation` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_gaussian_bt` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_flat_passband` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_enabled` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_enabled` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_data_processing_mode` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_compensate_for_filter_group_delay` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_cic_filter_interpolation` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_cic_filter_gain` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_cic_filter_enabled` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_carrier_phase_q` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_carrier_phase_i` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_carrier_frequency` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_carrier_enabled` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_pre_filter_offset_q` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_pre_filter_offset_i` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_pre_filter_gain_q` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_pre_filter_gain_i` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_overflow_status` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_overflow_error_reporting` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_mode` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_frequency_shift` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_type` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_root_raised_cosine_alpha` - [#864](https://github.com/ni/nimi-python/issues/864) + * `osp_fir_filter_raised_cosine_alpha` - [#864](https://github.com/ni/nimi-python/issues/864) * ### NI-SCOPE * #### Added * #### Changed From 7db1fe423a99a06ed7ff16a6f596f49d4481de97 Mon Sep 17 00:00:00 2001 From: Mark Silva Date: Mon, 21 May 2018 11:04:45 -0500 Subject: [PATCH 3/3] Update generated files --- docs/nifgen/attributes.rst | 604 ------------------------------------ docs/nifgen/enums.rst | 122 -------- docs/nifgen/session.rst | 50 --- generated/nifgen/enums.py | 56 ---- generated/nifgen/session.py | 129 -------- 5 files changed, 961 deletions(-) diff --git a/docs/nifgen/attributes.rst b/docs/nifgen/attributes.rst index b309e5a9f..7c5820e0f 100644 --- a/docs/nifgen/attributes.rst +++ b/docs/nifgen/attributes.rst @@ -2902,610 +2902,6 @@ nifgen.Session properties - LabVIEW Property: **Clocks:Advanced:Oscillator Phase DAC Value** - C Attribute: **NIFGEN_ATTR_OSCILLATOR_PHASE_DAC_VALUE** -.. py:attribute:: osp_carrier_enabled - - Enables or disables generation of the carrier. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | bool | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Carrier Enabled** - - C Attribute: **NIFGEN_ATTR_OSP_CARRIER_ENABLED** - -.. py:attribute:: osp_carrier_frequency - - The frequency of the generated carrier. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Carrier Frequency** - - C Attribute: **NIFGEN_ATTR_OSP_CARRIER_FREQUENCY** - -.. py:attribute:: osp_carrier_phase_i - - I Carrier Phase in degrees at the first point of the generation. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Carrier Phase:Carrier Phase I** - - C Attribute: **NIFGEN_ATTR_OSP_CARRIER_PHASE_I** - -.. py:attribute:: osp_carrier_phase_q - - Q Carrier Phase in degrees at the first point of the generation. This property is only used when the :py:data:`nifgen.Session.osp_data_processing_mode` property is set to :py:data:`~nifgen.DataProcessingMode.COMPLEX`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Carrier Phase:Carrier Phase Q** - - C Attribute: **NIFGEN_ATTR_OSP_CARRIER_PHASE_Q** - -.. py:attribute:: osp_cic_filter_enabled - - Enables or disables the CIC filter. - The :py:data:`nifgen.Session.osp_cic_filter_enabled` and :py:data:`nifgen.Session.osp_fir_filter_enabled` properties must have the same enable/disable setting. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | bool | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Filter Enabled** - - C Attribute: **NIFGEN_ATTR_OSP_CIC_FILTER_ENABLED** - -.. py:attribute:: osp_cic_filter_gain - - Gain applied at the final stage of the CIC filter. Commonly used to compensate for attenuation in the FIR filter. For FIR filter types other than Custom, NI-FGEN calculates the CIC gain in order to achieve unity gain between the FIR and CIC filters. Setting this property overrides the value set by NI-FGEN. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Filter Gain** - - C Attribute: **NIFGEN_ATTR_OSP_CIC_FILTER_GAIN** - -.. py:attribute:: osp_cic_filter_interpolation - - Interpolation factor for the CIC filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the :py:data:`nifgen.Session.osp_iq_rate` property. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Interpolation Factor** - - C Attribute: **NIFGEN_ATTR_OSP_CIC_FILTER_INTERPOLATION** - -.. py:attribute:: osp_compensate_for_filter_group_delay - - Compensate for OSP Filter Group Delay. If this is enabled, the Event Outputs will be aligned with the Analog Output. The Analog output will also be aligned between synchronized devices (using NI-TClk). - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | bool | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:Compensate for Filter Group Delay** - - C Attribute: **NIFGEN_ATTR_OSP_COMPENSATE_FOR_FILTER_GROUP_DELAY** - -.. py:attribute:: osp_data_processing_mode - - The way in which data is processed by the OSP block. - - The following table lists the characteristics of this property. - - +----------------+--------------------------+ - | Characteristic | Value | - +================+==========================+ - | Datatype | enums.DataProcessingMode | - +----------------+--------------------------+ - | Permissions | read-write | - +----------------+--------------------------+ - | Channel Based | False | - +----------------+--------------------------+ - | Resettable | Yes | - +----------------+--------------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Data Processing Mode** - - C Attribute: **NIFGEN_ATTR_OSP_DATA_PROCESSING_MODE** - -.. py:attribute:: osp_enabled - - Enables or disables the OSP block of the signal generator. When the OSP block is disabled, all OSP-related properties are disabled and have no effect on the generated signal. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | bool | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | No | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:OSP Enabled** - - C Attribute: **NIFGEN_ATTR_OSP_ENABLED** - -.. py:attribute:: osp_fir_filter_enabled - - Enables or disables the FIR filter. - The :py:data:`nifgen.Session.osp_cic_filter_enabled` and :py:data:`nifgen.Session.osp_fir_filter_enabled` properties must have the same enable/disable setting. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | bool | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:FIR Filter Enabled** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_ENABLED** - -.. py:attribute:: osp_fir_filter_flat_passband - - Passband value to use when calculating the FIR filter coefficients. The FIR filter is designed to be flat to passband × IQ rate. This property is used only when the :py:data:`nifgen.Session.osp_fir_filter_type` property is set to :py:data:`~nifgen.FilterType.FLAT`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Flat:Passband** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_FLAT_PASSBAND** - -.. py:attribute:: osp_fir_filter_gaussian_bt - - BT value to use when calculating the pulse-shaping FIR filter coefficients. Only used when the :py:data:`nifgen.Session.osp_fir_filter_type` property is set to :py:data:`~nifgen.FilterType.GAUSSIAN`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Gaussian:BT** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_GAUSSIAN_BT** - -.. py:attribute:: osp_fir_filter_interpolation - - Interpolation factor for the FIR filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the :py:data:`nifgen.Session.osp_iq_rate` property. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:FIR Interpolation Factor** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_INTERPOLATION** - -.. py:attribute:: osp_fir_filter_raised_cosine_alpha - - Alpha value to use when calculating the pulse shaping FIR filter coefficients. Only used when the :py:data:`nifgen.Session.osp_fir_filter_type` property is set to :py:data:`~nifgen.FilterType.RAISED_COSINE`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Raised Cosine:Alpha** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_RAISED_COSINE_ALPHA** - -.. py:attribute:: osp_fir_filter_root_raised_cosine_alpha - - Alpha value to use when calculating the pulse-shaping FIR filter coefficients. This property is used only when the :py:data:`nifgen.Session.osp_fir_filter_type` property is set to :py:data:`~nifgen.FilterType.ROOT_RAISED_COSINE`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Root Raised Cosine:Alpha** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_ROOT_RAISED_COSINE_ALPHA** - -.. py:attribute:: osp_fir_filter_type - - Pulse-shaping filter type for the FIR filter. - - The following table lists the characteristics of this property. - - +----------------+------------------+ - | Characteristic | Value | - +================+==================+ - | Datatype | enums.FilterType | - +----------------+------------------+ - | Permissions | read-write | - +----------------+------------------+ - | Channel Based | False | - +----------------+------------------+ - | Resettable | Yes | - +----------------+------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Filter Type** - - C Attribute: **NIFGEN_ATTR_OSP_FIR_FILTER_TYPE** - -.. py:attribute:: osp_frequency_shift - - Specifies the amount of frequency shift applied to the baseband signal. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Frequency Shift** - - C Attribute: **NIFGEN_ATTR_OSP_FREQUENCY_SHIFT** - -.. py:attribute:: osp_mode - - Specifies the generation mode of the OSP, which determines the type of data contained in the output signal. - - The following table lists the characteristics of this property. - - +----------------+---------------+ - | Characteristic | Value | - +================+===============+ - | Datatype | enums.OSPMode | - +----------------+---------------+ - | Permissions | read-write | - +----------------+---------------+ - | Channel Based | False | - +----------------+---------------+ - | Resettable | Yes | - +----------------+---------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:OSP Mode** - - C Attribute: **NIFGEN_ATTR_OSP_MODE** - -.. py:attribute:: osp_overflow_error_reporting - - Configures error reporting when the OSP block detects an overflow in any of its stages. Overflows lead to clipping of the waveform. - You can use the :py:data:`nifgen.Session.osp_overflow_status` property to query for overflow conditions whether or not the :py:data:`nifgen.Session.osp_overflow_error_reporting` property is enabled. The device will continue to generate after an overflow whether or not the :py:data:`nifgen.Session.osp_overflow_error_reporting` property is enabled. - - The following table lists the characteristics of this property. - - +----------------+---------------------------------+ - | Characteristic | Value | - +================+=================================+ - | Datatype | enums.OSPOverflowErrorReporting | - +----------------+---------------------------------+ - | Permissions | read-write | - +----------------+---------------------------------+ - | Channel Based | False | - +----------------+---------------------------------+ - | Resettable | Yes | - +----------------+---------------------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:OSP Overflow Error Reporting** - - C Attribute: **NIFGEN_ATTR_OSP_OVERFLOW_ERROR_REPORTING** - -.. py:attribute:: osp_overflow_status - - Returns a bit field of the overflow status in any stage of the OSP block. This property is functional regardless of the value for the :py:data:`nifgen.Session.osp_overflow_error_reporting` property. - Write 0 to this property to clear the current :py:data:`nifgen.Session.osp_overflow_error_reporting` value. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | int | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:Advanced:OSP Overflow Status** - - C Attribute: **NIFGEN_ATTR_OSP_OVERFLOW_STATUS** - -.. py:attribute:: osp_pre_filter_gain_i - - Digital gain to apply to the I data stream before any filtering by the OSP block. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Gain:Pre-filter Gain I** - - C Attribute: **NIFGEN_ATTR_OSP_PRE_FILTER_GAIN_I** - -.. py:attribute:: osp_pre_filter_gain_q - - Digital gain to apply to the Q data stream before any filtering by the OSP block. This property is only used when the :py:data:`nifgen.Session.osp_data_processing_mode` property is set to :py:data:`~nifgen.DataProcessingMode.COMPLEX`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Gain:Pre-filter Gain Q** - - C Attribute: **NIFGEN_ATTR_OSP_PRE_FILTER_GAIN_Q** - -.. py:attribute:: osp_pre_filter_offset_i - - Digital offset to apply to the I data stream. This offset is applied after the Pre-Filter Gain and before any filtering. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Offset:Pre-filter Offset I** - - C Attribute: **NIFGEN_ATTR_OSP_PRE_FILTER_OFFSET_I** - -.. py:attribute:: osp_pre_filter_offset_q - - Digital offset to apply to the Q data stream. This offset is applied after the Pre-Filter Gain and before any filtering. This property is used only when the :py:data:`nifgen.Session.osp_data_processing_mode` property is set to :py:data:`~nifgen.DataProcessingMode.COMPLEX`. - - The following table lists the characteristics of this property. - - +----------------+------------+ - | Characteristic | Value | - +================+============+ - | Datatype | float | - +----------------+------------+ - | Permissions | read-write | - +----------------+------------+ - | Channel Based | False | - +----------------+------------+ - | Resettable | Yes | - +----------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Offset:Pre-filter Offset Q** - - C Attribute: **NIFGEN_ATTR_OSP_PRE_FILTER_OFFSET_Q** - .. py:attribute:: output_enabled This channel-based property specifies whether the signal that the signal generator produces appears at the output connector. diff --git a/docs/nifgen/enums.rst b/docs/nifgen/enums.rst index c6bc839fb..90f26125e 100644 --- a/docs/nifgen/enums.rst +++ b/docs/nifgen/enums.rst @@ -190,29 +190,6 @@ Enums used in NI-FGEN -.. py:data:: DataProcessingMode - - .. py:attribute:: DataProcessingMode.REAL - - - - The waveform data points are real numbers (I data). - - - - - - .. py:attribute:: DataProcessingMode.COMPLEX - - - - The waveform data points are complex numbers (I/Q data). - - - - - - .. py:data:: DoneEventActiveLevel .. py:attribute:: DoneEventActiveLevel.HIGH @@ -328,59 +305,6 @@ Enums used in NI-FGEN -.. py:data:: FilterType - - .. py:attribute:: FilterType.FLAT - - - - Applies a flat filter to the data with the passband value specified in the :py:data:`nifgen.Session.osp_fir_filter_flat_passband` property. - - - - - - .. py:attribute:: FilterType.RAISED_COSINE - - - - Applies a raised cosine filter to the data with the alpha value specified in the :py:data:`nifgen.Session.osp_fir_filter_raised_cosine_alpha` property. - - - - - - .. py:attribute:: FilterType.ROOT_RAISED_COSINE - - - - Applies a root raised cosine filter to the data with the alpha value specified in the :py:data:`nifgen.Session.osp_fir_filter_root_raised_cosine_alpha` property. - - - - - - .. py:attribute:: FilterType.GAUSSIAN - - - - Applies a Gaussian filter to the data with the BT value specified in the :py:data:`nifgen.Session.osp_fir_filter_gaussian_bt` property. - - - - - - .. py:attribute:: FilterType.CUSTOM - - - - Applies a custom filter to the data. If :py:data:`~nifgen.FilterType.CUSTOM` is selected, you must provide a set of FIR filter coefficients with the :py:meth:`nifgen.Session.configure_custom_fir_filter_coefficients` method. - - - - - - .. py:data:: HardwareState .. py:attribute:: HardwareState.IDLE @@ -553,52 +477,6 @@ Enums used in NI-FGEN -.. py:data:: OSPMode - - .. py:attribute:: OSPMode.IF - - - - The OSP block generates intermediate frequency (IF) data. - - - - - - .. py:attribute:: OSPMode.BASEBAND - - - - The OSP block generates baseband data. - - - - - - -.. py:data:: OSPOverflowErrorReporting - - .. py:attribute:: OSPOverflowErrorReporting.ERROR - - - - NI-FGEN returns errors whenever an overflow has occurred in the OSP block. - - - - - - .. py:attribute:: OSPOverflowErrorReporting.DISABLED - - - - NI-FGEN does not return errors when an overflow occurs in the OSP block. - - - - - - .. py:data:: OutputMode .. py:attribute:: OutputMode.FUNC diff --git a/docs/nifgen/session.rst b/docs/nifgen/session.rst index ef2115adc..c13a15213 100644 --- a/docs/nifgen/session.rst +++ b/docs/nifgen/session.rst @@ -244,56 +244,6 @@ nifgen.Session +-------------------------------------------------------------+-------------------------------------------------+ | :py:attr:`oscillator_phase_dac_value` | int | +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_carrier_enabled` | bool | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_carrier_frequency` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_carrier_phase_i` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_carrier_phase_q` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_cic_filter_enabled` | bool | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_cic_filter_gain` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_cic_filter_interpolation` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_compensate_for_filter_group_delay` | bool | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_data_processing_mode` | :py:data:`DataProcessingMode` | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_enabled` | bool | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_enabled` | bool | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_flat_passband` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_gaussian_bt` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_interpolation` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_raised_cosine_alpha` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_root_raised_cosine_alpha` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_fir_filter_type` | :py:data:`FilterType` | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_frequency_shift` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_mode` | :py:data:`OSPMode` | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_overflow_error_reporting` | :py:data:`OSPOverflowErrorReporting` | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_overflow_status` | int | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_pre_filter_gain_i` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_pre_filter_gain_q` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_pre_filter_offset_i` | float | - +-------------------------------------------------------------+-------------------------------------------------+ - | :py:attr:`osp_pre_filter_offset_q` | float | - +-------------------------------------------------------------+-------------------------------------------------+ | :py:attr:`output_enabled` | bool | +-------------------------------------------------------------+-------------------------------------------------+ | :py:attr:`output_impedance` | float | diff --git a/generated/nifgen/enums.py b/generated/nifgen/enums.py index 10c2f6bb9..50f9d15dd 100644 --- a/generated/nifgen/enums.py +++ b/generated/nifgen/enums.py @@ -84,17 +84,6 @@ class DataMarkerEventLevelPolarity(Enum): ''' -class DataProcessingMode(Enum): - REAL = 0 - ''' - The waveform data points are real numbers (I data). - ''' - COMPLEX = 1 - ''' - The waveform data points are complex numbers (I/Q data). - ''' - - class DoneEventActiveLevel(Enum): HIGH = 101 ''' @@ -150,29 +139,6 @@ class DoneEventPulseWidthUnits(Enum): ''' -class FilterType(Enum): - FLAT = 0 - ''' - Applies a flat filter to the data with the passband value specified in the osp_fir_filter_flat_passband property. - ''' - RAISED_COSINE = 1 - ''' - Applies a raised cosine filter to the data with the alpha value specified in the osp_fir_filter_raised_cosine_alpha property. - ''' - ROOT_RAISED_COSINE = 2 - ''' - Applies a root raised cosine filter to the data with the alpha value specified in the osp_fir_filter_root_raised_cosine_alpha property. - ''' - GAUSSIAN = 3 - ''' - Applies a Gaussian filter to the data with the BT value specified in the osp_fir_filter_gaussian_bt property. - ''' - CUSTOM = 4 - ''' - Applies a custom filter to the data. If FilterType.CUSTOM is selected, you must provide a set of FIR filter coefficients with the configure_custom_fir_filter_coefficients method. - ''' - - class HardwareState(Enum): IDLE = 0 WAITING_FOR_START_TRIGGER = 1 @@ -252,28 +218,6 @@ class MarkerEventToggleInitialState(Enum): ''' -class OSPMode(Enum): - IF = 0 - ''' - The OSP block generates intermediate frequency (IF) data. - ''' - BASEBAND = 1 - ''' - The OSP block generates baseband data. - ''' - - -class OSPOverflowErrorReporting(Enum): - ERROR = 0 - ''' - NI-FGEN returns errors whenever an overflow has occurred in the OSP block. - ''' - DISABLED = 2 - ''' - NI-FGEN does not return errors when an overflow occurs in the OSP block. - ''' - - class OutputMode(Enum): FUNC = 0 ''' diff --git a/generated/nifgen/session.py b/generated/nifgen/session.py index ed87efcfa..be5265606 100644 --- a/generated/nifgen/session.py +++ b/generated/nifgen/session.py @@ -764,135 +764,6 @@ class _SessionBase(object): The value of the oscillator phase DAC. ''' - osp_carrier_enabled = _attributes.AttributeViBoolean(1150249) - '''Type: bool - - Enables or disables generation of the carrier. - ''' - osp_carrier_frequency = _attributes.AttributeViReal64(1150250) - '''Type: float - - The frequency of the generated carrier. - ''' - osp_carrier_phase_i = _attributes.AttributeViReal64(1150251) - '''Type: float - - I Carrier Phase in degrees at the first point of the generation. - ''' - osp_carrier_phase_q = _attributes.AttributeViReal64(1150252) - '''Type: float - - Q Carrier Phase in degrees at the first point of the generation. This property is only used when the osp_data_processing_mode property is set to DataProcessingMode.COMPLEX. - ''' - osp_cic_filter_enabled = _attributes.AttributeViBoolean(1150257) - '''Type: bool - - Enables or disables the CIC filter. - The osp_cic_filter_enabled and osp_fir_filter_enabled properties must have the same enable/disable setting. - ''' - osp_cic_filter_gain = _attributes.AttributeViReal64(1150263) - '''Type: float - - Gain applied at the final stage of the CIC filter. Commonly used to compensate for attenuation in the FIR filter. For FIR filter types other than Custom, NI-FGEN calculates the CIC gain in order to achieve unity gain between the FIR and CIC filters. Setting this property overrides the value set by NI-FGEN. - ''' - osp_cic_filter_interpolation = _attributes.AttributeViReal64(1150258) - '''Type: float - - Interpolation factor for the CIC filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the osp_iq_rate property. - ''' - osp_compensate_for_filter_group_delay = _attributes.AttributeViBoolean(1150389) - '''Type: bool - - Compensate for OSP Filter Group Delay. If this is enabled, the Event Outputs will be aligned with the Analog Output. The Analog output will also be aligned between synchronized devices (using NI-TClk). - ''' - osp_data_processing_mode = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DataProcessingMode, 1150247) - '''Type: enums.DataProcessingMode - - The way in which data is processed by the OSP block. - ''' - osp_enabled = _attributes.AttributeViBoolean(1150246) - '''Type: bool - - Enables or disables the OSP block of the signal generator. When the OSP block is disabled, all OSP-related properties are disabled and have no effect on the generated signal. - ''' - osp_fir_filter_enabled = _attributes.AttributeViBoolean(1150255) - '''Type: bool - - Enables or disables the FIR filter. - The osp_cic_filter_enabled and osp_fir_filter_enabled properties must have the same enable/disable setting. - ''' - osp_fir_filter_flat_passband = _attributes.AttributeViReal64(1150261) - '''Type: float - - Passband value to use when calculating the FIR filter coefficients. The FIR filter is designed to be flat to passband × IQ rate. This property is used only when the osp_fir_filter_type property is set to FilterType.FLAT. - ''' - osp_fir_filter_gaussian_bt = _attributes.AttributeViReal64(1150262) - '''Type: float - - BT value to use when calculating the pulse-shaping FIR filter coefficients. Only used when the osp_fir_filter_type property is set to FilterType.GAUSSIAN. - ''' - osp_fir_filter_interpolation = _attributes.AttributeViReal64(1150256) - '''Type: float - - Interpolation factor for the FIR filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the osp_iq_rate property. - ''' - osp_fir_filter_raised_cosine_alpha = _attributes.AttributeViReal64(1150260) - '''Type: float - - Alpha value to use when calculating the pulse shaping FIR filter coefficients. Only used when the osp_fir_filter_type property is set to FilterType.RAISED_COSINE. - ''' - osp_fir_filter_root_raised_cosine_alpha = _attributes.AttributeViReal64(1150259) - '''Type: float - - Alpha value to use when calculating the pulse-shaping FIR filter coefficients. This property is used only when the osp_fir_filter_type property is set to FilterType.ROOT_RAISED_COSINE. - ''' - osp_fir_filter_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.FilterType, 1150253) - '''Type: enums.FilterType - - Pulse-shaping filter type for the FIR filter. - ''' - osp_frequency_shift = _attributes.AttributeViReal64(1150371) - '''Type: float - - Specifies the amount of frequency shift applied to the baseband signal. - ''' - osp_mode = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.OSPMode, 1150370) - '''Type: enums.OSPMode - - Specifies the generation mode of the OSP, which determines the type of data contained in the output signal. - ''' - osp_overflow_error_reporting = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.OSPOverflowErrorReporting, 1150268) - '''Type: enums.OSPOverflowErrorReporting - - Configures error reporting when the OSP block detects an overflow in any of its stages. Overflows lead to clipping of the waveform. - You can use the osp_overflow_status property to query for overflow conditions whether or not the osp_overflow_error_reporting property is enabled. The device will continue to generate after an overflow whether or not the osp_overflow_error_reporting property is enabled. - ''' - osp_overflow_status = _attributes.AttributeViInt32(1150269) - '''Type: int - - Returns a bit field of the overflow status in any stage of the OSP block. This property is functional regardless of the value for the osp_overflow_error_reporting property. - Write 0 to this property to clear the current osp_overflow_error_reporting value. - ''' - osp_pre_filter_gain_i = _attributes.AttributeViReal64(1150264) - '''Type: float - - Digital gain to apply to the I data stream before any filtering by the OSP block. - ''' - osp_pre_filter_gain_q = _attributes.AttributeViReal64(1150265) - '''Type: float - - Digital gain to apply to the Q data stream before any filtering by the OSP block. This property is only used when the osp_data_processing_mode property is set to DataProcessingMode.COMPLEX. - ''' - osp_pre_filter_offset_i = _attributes.AttributeViReal64(1150266) - '''Type: float - - Digital offset to apply to the I data stream. This offset is applied after the Pre-Filter Gain and before any filtering. - ''' - osp_pre_filter_offset_q = _attributes.AttributeViReal64(1150267) - '''Type: float - - Digital offset to apply to the Q data stream. This offset is applied after the Pre-Filter Gain and before any filtering. This property is used only when the osp_data_processing_mode property is set to DataProcessingMode.COMPLEX. - ''' output_enabled = _attributes.AttributeViBoolean(1250003) '''Type: bool