diff --git a/CHANGELOG.md b/CHANGELOG.md index ab83e8a91..b90db96c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1731,6 +1731,7 @@ #### [nirfsa] Unreleased - Added + - All methods and attributes which are part of first release - Changed - Removed diff --git a/src/nirfsa/custom_types/coefficient_info_type.py b/src/nirfsa/custom_types/coefficient_info_type.py new file mode 100644 index 000000000..2f4111c30 --- /dev/null +++ b/src/nirfsa/custom_types/coefficient_info_type.py @@ -0,0 +1,60 @@ +import ctypes +import nirfsa._visatype + + +# This class is an internal ctypes implementation detail that corresponds to +# niRFSA_coefficientInfo in the C API +class struct_niRFSA_coefficientInfo(ctypes.Structure): # noqa N801 + _pack_ = 8 + _fields_ = [ + ('offset', nirfsa._visatype.ViReal64), + ('gain', nirfsa._visatype.ViReal64), + ('reserved1', nirfsa._visatype.ViReal64), + ('reserved2', nirfsa._visatype.ViReal64), + ] + + def __init__(self, data=None, offset=0.0, gain=0.0, + reserved1=0.0, reserved2=0.0): + super(ctypes.Structure, self).__init__() + if data is not None: + self.offset = data.offset + self.gain = data.gain + self.reserved1 = data.reserved1 + self.reserved2 = data.reserved2 + else: + self.offset = offset + self.gain = gain + self.reserved1 = reserved1 + self.reserved2 = reserved2 + + +class CoefficientInfo: + """Python-friendly wrapper for niRFSA coefficient info.""" + + def __init__(self, data=None, offset=0.0, gain=0.0): + if data is not None: + self.offset = data.offset + self.gain = data.gain + else: + self.offset = offset + self.gain = gain + + def _create_copy(self, target_class): + try: + return target_class( + offset=self.offset, + gain=self.gain, + ) + except TypeError: + return target_class(data=self) + + def __repr__(self): + return "{}.{}(offset={}, gain={})".format( + self.__class__.__module__, + self.__class__.__qualname__, + self.offset, + self.gain, + ) + + def __str__(self): + return self.__repr__() diff --git a/src/nirfsa/custom_types/spectrum_info_type.py b/src/nirfsa/custom_types/spectrum_info_type.py new file mode 100644 index 000000000..33c736abf --- /dev/null +++ b/src/nirfsa/custom_types/spectrum_info_type.py @@ -0,0 +1,112 @@ +import ctypes +import nirfsa._visatype + + +# This class is an internal ctypes implementation detail that corresponds to +# niRFSA_spectrumInfo in the C API +class struct_niRFSA_spectrumInfo(ctypes.Structure): # noqa N801 + _pack_ = 8 + _fields_ = [ + ('initial_frequency', nirfsa._visatype.ViReal64), + ('frequency_increment', nirfsa._visatype.ViReal64), + ('number_of_spectral_lines', nirfsa._visatype.ViInt32), + ('reserved1', nirfsa._visatype.ViReal64), + ('reserved2', nirfsa._visatype.ViReal64), + ('reserved3', nirfsa._visatype.ViReal64), + ('reserved4', nirfsa._visatype.ViReal64), + ('reserved5', nirfsa._visatype.ViReal64), + ] + + def __init__(self, data=None, initial_frequency=0.0, frequency_increment=0.0, + number_of_spectral_lines=0, reserved1=0.0, reserved2=0.0, + reserved3=0.0, reserved4=0.0, reserved5=0.0): + super(ctypes.Structure, self).__init__() + if data is not None: + self.initial_frequency = data.initial_frequency + self.frequency_increment = data.frequency_increment + self.number_of_spectral_lines = data.number_of_spectral_lines + self.reserved1 = data.reserved1 + self.reserved2 = data.reserved2 + self.reserved3 = data.reserved3 + self.reserved4 = data.reserved4 + self.reserved5 = data.reserved5 + else: + self.initial_frequency = initial_frequency + self.frequency_increment = frequency_increment + self.number_of_spectral_lines = number_of_spectral_lines + self.reserved1 = reserved1 + self.reserved2 = reserved2 + self.reserved3 = reserved3 + self.reserved4 = reserved4 + self.reserved5 = reserved5 + + +class SpectrumInfo: + """Python-friendly wrapper for niRFSA spectrum info.""" + + def __init__(self, data=None, initial_frequency=0.0, frequency_increment=0.0, + number_of_spectral_lines=0, reserved1=0.0, reserved2=0.0, + reserved3=0.0, reserved4=0.0, reserved5=0.0): + if data is not None: + self.initial_frequency = data.initial_frequency + self.frequency_increment = data.frequency_increment + self.number_of_spectral_lines = data.number_of_spectral_lines + self.reserved1 = data.reserved1 + self.reserved2 = data.reserved2 + self.reserved3 = data.reserved3 + self.reserved4 = data.reserved4 + self.reserved5 = data.reserved5 + else: + self.initial_frequency = initial_frequency + self.frequency_increment = frequency_increment + self.number_of_spectral_lines = number_of_spectral_lines + self.reserved1 = reserved1 + self.reserved2 = reserved2 + self.reserved3 = reserved3 + self.reserved4 = reserved4 + self.reserved5 = reserved5 + + def _create_copy(self, target_class): + try: + return target_class( + initial_frequency=self.initial_frequency, + frequency_increment=self.frequency_increment, + number_of_spectral_lines=self.number_of_spectral_lines, + reserved1=self.reserved1, + reserved2=self.reserved2, + reserved3=self.reserved3, + reserved4=self.reserved4, + reserved5=self.reserved5, + ) + except TypeError: + return target_class(data=self) + + def __repr__(self): + return "{}.{}(initial_frequency={}, frequency_increment={}, number_of_spectral_lines={}, reserved1={}, reserved2={}, reserved3={}, reserved4={}, reserved5={})".format( + self.__class__.__module__, + self.__class__.__qualname__, + self.initial_frequency, + self.frequency_increment, + self.number_of_spectral_lines, + self.reserved1, + self.reserved2, + self.reserved3, + self.reserved4, + self.reserved5, + ) + + def __str__(self): + return self.__repr__() + + +def _populate_samples_info(spectrum_info, sample_data): + '''Chunk up flat array of sample_data and copy each chunk into individual SpectrumInfo instance + + Args: + spectrum_info (SpectrumInfo): SpectrumInfo class instance + + sample_data (Iterable of float): Spectrum sample data + ''' + start = 0 + end = start + spectrum_info.number_of_spectral_lines + spectrum_info.samples = sample_data[start:end] diff --git a/src/nirfsa/custom_types/waveform_info.py b/src/nirfsa/custom_types/waveform_info.py new file mode 100644 index 000000000..b30a5bc8f --- /dev/null +++ b/src/nirfsa/custom_types/waveform_info.py @@ -0,0 +1,116 @@ +import ctypes +import nirfsa._visatype + + +# This class is an internal ctypes implementation detail that corresponds to +# niRFSA_wfmInfo in the C API +class struct_niRFSA_wfmInfo(ctypes.Structure): # noqa N801 + _pack_ = 8 + _fields_ = [ + ('absolute_initial_x', nirfsa._visatype.ViReal64), + ('relative_initial_x', nirfsa._visatype.ViReal64), + ('x_increment', nirfsa._visatype.ViReal64), + ('actual_samples', nirfsa._visatype.ViInt64), + ('offset', nirfsa._visatype.ViReal64), + ('gain', nirfsa._visatype.ViReal64), + ('reserved1', nirfsa._visatype.ViReal64), + ('reserved2', nirfsa._visatype.ViReal64), + ] + + def __init__(self, data=None, absolute_initial_x=0.0, relative_initial_x=0.0, + x_increment=0.0, actual_samples=0, offset=0.0, gain=0.0, + reserved1=0.0, reserved2=0.0): + super(ctypes.Structure, self).__init__() + if data is not None: + self.absolute_initial_x = data.absolute_initial_x + self.relative_initial_x = data.relative_initial_x + self.x_increment = data.x_increment + self.actual_samples = data.actual_samples + self.offset = data.offset + self.gain = data.gain + self.reserved1 = data.reserved1 + self.reserved2 = data.reserved2 + else: + self.absolute_initial_x = absolute_initial_x + self.relative_initial_x = relative_initial_x + self.x_increment = x_increment + self.actual_samples = actual_samples + self.offset = offset + self.gain = gain + self.reserved1 = reserved1 + self.reserved2 = reserved2 + + +class WaveformInfo: + """Python-friendly wrapper for niRFSA waveform info.""" + + def __init__(self, data=None, absolute_initial_x=0.0, relative_initial_x=0.0, + x_increment=0.0, actual_samples=0, offset=0.0, gain=0.0, + reserved1=0.0, reserved2=0.0): + if data is not None: + self.absolute_initial_x = data.absolute_initial_x + self.relative_initial_x = data.relative_initial_x + self.x_increment = data.x_increment + self.actual_samples = data.actual_samples + self.offset = data.offset + self.gain = data.gain + self.reserved1 = data.reserved1 + self.reserved2 = data.reserved2 + else: + self.absolute_initial_x = absolute_initial_x + self.relative_initial_x = relative_initial_x + self.x_increment = x_increment + self.actual_samples = actual_samples + self.offset = offset + self.gain = gain + self.reserved1 = reserved1 + self.reserved2 = reserved2 + + def _create_copy(self, target_class): + try: + return target_class( + absolute_initial_x=self.absolute_initial_x, + relative_initial_x=self.relative_initial_x, + x_increment=self.x_increment, + actual_samples=self.actual_samples, + offset=self.offset, + gain=self.gain, + reserved1=self.reserved1, + reserved2=self.reserved2, + ) + except TypeError: + return target_class(data=self) + + def __repr__(self): + return "{}.{}(absolute_initial_x={}, relative_initial_x={}, x_increment={}, actual_samples={}, offset={}, gain={}, reserved1={}, reserved2={})".format( + self.__class__.__module__, + self.__class__.__qualname__, + self.absolute_initial_x, + self.relative_initial_x, + self.x_increment, + self.actual_samples, + self.offset, + self.gain, + self.reserved1, + self.reserved2, + ) + + def __str__(self): + return self.__repr__() + + +def _populate_samples_info(waveform_infos, sample_data): + '''Chunk up flat array of sample_data and copy each chunk into individual WaveformInfo instance + + Args: + waveform_infos (Iterable of WaveformInfo): WaveformInfo class instances + + sample_data (Iterable of float): Waveform sample data + ''' + if hasattr(sample_data, 'ndim') and sample_data.ndim == 2: + # 2D case (multi-record fetch): sample_data[i] is a 1D view of row i. + # Slice to exact actual_samples to handle rows wider than actual_samples (e.g. int16). + for i in range(len(waveform_infos)): + actual_samples = waveform_infos[i].actual_samples + waveform_infos[i].samples = sample_data[i, :actual_samples] + diff --git a/src/nirfsa/metadata/__init__.py b/src/nirfsa/metadata/__init__.py new file mode 100644 index 000000000..736945551 --- /dev/null +++ b/src/nirfsa/metadata/__init__.py @@ -0,0 +1,19 @@ +from metadata.config import config +from metadata.functions import functions +from metadata.attributes import attributes +from metadata.enums import enums +import metadata.functions_addon +import metadata.attributes_addon +import metadata.enums_addon +import metadata.config_addon + +import build.helper as helper +import sys + +# Update generated functions data with hand maintained data +config['modules'] = sys.modules +helper.add_all_metadata(functions, attributes, enums, config) + +__version__ = config['module_version'] + + diff --git a/src/nirfsa/metadata/attributes.py b/src/nirfsa/metadata/attributes.py new file mode 100644 index 000000000..3bef869bd --- /dev/null +++ b/src/nirfsa/metadata/attributes.py @@ -0,0 +1,4175 @@ +# -*- coding: utf-8 -*- +# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +attributes = { + 1050007: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'The Driver Setup string returns the initial values for properties that are specific to NI-RFSA.\n\nThe Driver Setup string uses the following format:\n\nDriverSetup= Tag:Value\n\n*Tag* is the name of the Driver Setup string attribute. *Value* is the value set to the attribute. If multiple attributes are set, their assignments are separated with a semicolon.\n\nThis attribute only returns the Driver Setup string that has already been defined. Refer to `Driver Setup Options `_ for more information about configuring the Driver Setup string. Refer to the nirfsa_InitWithOptions function for additional information about using the **option string** parameter.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:User Options:Driver Setup', + 'name': 'DRIVER_SETUP', + 'type': 'ViString' + }, + 1050304: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Indicates the resource name NI-RFSA uses to identify the physical device. \n\nIf you initialize NI-RFSA with a logical name, this attribute contains the resource name that corresponds to the entry in the IVI Configuration Utility.\n\nIf you initialize NI-RFSA with the resource name, this attribute contains that value.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Resource Descriptor', + 'name': 'IO_RESOURCE_DESCRIPTOR', + 'type': 'ViString' + }, + 1050305: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Contains the logical name you specified when opening the current IVI session. \n\nYou may pass a logical name to the nirfsa_Init function or the nirfsa_InitWithOptions function. The IVI Configuration Utility must contain an entry for the logical name. The logical name entry refers to a driver session section in the IVI Configuration file. The driver session section specifies a physical device and initial user options.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Logical Name', + 'name': 'LOGICAL_NAME', + 'type': 'ViString' + }, + 1050327: { + 'access': 'read only', + 'attribute_class': 'AttributeViStringCommaSeparated', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a comma-separated list of supported devices.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models', + 'name': 'SUPPORTED_INSTRUMENT_MODELS', + 'type': 'ViString', + 'type_in_documentation': 'list of str' + }, + 1050401: { + 'access': 'read only', + 'attribute_class': 'AttributeViStringCommaSeparated', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a list of class-extension groups that NI-RFSA implements.\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities', + 'name': 'GROUP_CAPABILITIES', + 'type': 'ViString', + 'type_in_documentation': 'list of str' + }, + 1050510: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a string that contains the firmware revision information for the NI-RFSA downconverter for the composite device you are currently using.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n----\n**Note**\nPXIe-5820/5830/5831/5832/5840/5841/5842/5860 devices will return "No revision information available." To retrieve the firmware revision, use MAX, Hardware Configuration Utility, or NI System Configuration API.\n\n----' + }, + 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Firmware Revision', + 'name': 'INSTRUMENT_FIRMWARE_REVISION', + 'type': 'ViString' + }, + 1050511: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a string that contains the name of the manufacturer for the NI-RFSA device you are currently using.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Manufacturer', + 'name': 'INSTRUMENT_MANUFACTURER', + 'type': 'ViString' + }, + 1050512: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a string that contains the model number or name of the NI-RFSA device that you are currently using.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Model', + 'name': 'INSTRUMENT_MODEL', + 'type': 'ViString' + }, + 1150001: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the session to either acquire I/Q data or to compute a power spectrum over the specified frequency range.\n\n**Default Value**: NIRFSA_VAL_IQ\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureAcquisitionType\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_IQ', + 'Configures NI-RFSA for I/Q acquisitions.' + ], + [ + 'NIRFSA_VAL_SPECTRUM', + 'Configures NI-RFSA for spectrum acquisitions.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'AcquisitionType', + 'lv_property': 'Acquisition Type', + 'name': 'ACQUISITION_TYPE', + 'type': 'ViInt32' + }, + 1150002: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the center frequency in a spectrum acquisition. \n\nThe value is expressed in hertz (Hz). An acquisition consists of a span of data surrounding the center frequency.\n\n----\n**Note**\nUse this attribute to tune the downconverter when using external digitizer mode.\n\n----\n\n**Units**: hertz (Hz)\n\n**Default Values**:\n\n**PXIe-5694**: 193.6 MHz\n\n**PXIe-5820**: 0 Hz\n\n**PXIe-5830/5831/5832**: 6.5 GHz\n\n**All other devices**: 1 GHz\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:Center Frequency', + 'name': 'CENTER_FREQUENCY', + 'type': 'ViReal64' + }, + 1150003: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the frequency range of the computed spectrum in hertz (Hz). \n\nFor example, if you specify a center frequency of 1 GHz and a span of 100 MHz, the spectrum ranges from 950 MHz to 1,050 MHz after zoom processing. This value may be coerced based on hardware settings and RF downconverter specifications.\n\nNI-RFSA performs multispan acquisitions by dividing the total requested span into equally sized subspans based on the device instantaneous bandwidth at the range of frequencies you specify. NI-RFSA combines these subspans to yield a multispan acquisition. You can use the NIRFSA_ATTR_FFT_WIDTH attribute to improve amplitude accuracy and avoid unwanted effects such as filter roll-off and spurs across the span you select.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the hardware instantaneous bandwidth, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n----\n**Note**\nFor the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect measurements. Refer to the NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED attribute for more information about dithering.\n\n----\n\n**PXIe-5663/5663E**: NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the instantaneous bandwidth for frequencies above 120 MHz is different than instantaneous bandwidth for frequencies less than 120 MHz, which are 20 MHz and 10 MHz respectively.\n\n**PXIe-5665 (14 GHz)/5667 (7 GHz)**: If you enable the downconverter preselector filter, the device instantaneous bandwidth is only a typical specification.\n\n**Default Value**: 10 MHz\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureSpectrumFrequencyCenterSpan' + }, + 'lv_property': 'Acquisition:Spectrum:Span', + 'name': 'SPECTRUM_SPAN', + 'type': 'ViReal64' + }, + 1150004: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the reference level, in dBm. \n\nThe reference level represents the maximum expected power of an RF input signal.\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the I/Q ports.\n\n----\n\nRefer to the NIRFSA_ATTR_EXTERNAL_GAIN attribute for more information about how configuring an external gain and a reference level affect attenuation.\n\n**Default Value**: 0\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Improving Your Measurements `_\n\n`Programming Attenuation-Related Properties and Attributes Using NI-RFSA `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureReferenceLevel' + }, + 'lv_property': 'Vertical:Reference Level (dBm)', + 'name': 'REFERENCE_LEVEL', + 'type': 'ViReal64' + }, + 1150005: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the nominal attenuation setting, in dB, for all attenuators before the first mixer in the RF signal chain.\n\nIf you do not set this attribute, NI-RFSA automatically chooses an attenuation setting based on the reference level you configure. The valid values for this attribute depend on the device configuration.\n\n**PXI-5600/5661**: You can change the attenuation value to modify the amount of noise and distortion. Higher attenuation levels increase the noise level while decreasing distortion; lower attenuation levels decrease the noise level while increasing distortion.\n\n**PXIe-5601/5663/5663E**: You can change the attenuation value and the value of the NIRFSA_ATTR_IF_ATTENUATION attribute to modify the amount of noise and distortion. Higher attenuation levels increase the noise level while decreasing distortion; lower attenuation levels decrease the noise level while increasing distortion.\n\n**PXIe-5603/5605/5606/5665/5668**: You can set multiple attributes to modify the attenuation values for the device. Refer to `PXIe-5665 RF Attenuation and Signal Levels `_ for more information about configuring attenuation.\n\n**PXIe-5667**: This attribute specifies the nominal attenuation setting for all attenuators before the first RF mixer in the input signal path. This attribute is read-only when the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute is set to NIRFSA_VAL_DISABLED.\n\n**PXIe-5693**: This attribute is read-only and returns the nominal RF attenuation of the PXIe-5693.\n\n**Units**: dB\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693' + }, + 'lv_property': 'Vertical:Advanced:RF Attenuation (dB)', + 'name': 'ATTENUATION', + 'type': 'ViReal64' + }, + 1150006: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the mixer level, in dBm. \n\nThe mixer level represents the attenuation value to apply to the input RF signal as it reaches the first mixer in the signal chain. If you do not set this attribute, NI-RFSA automatically selects an optimal mixer level value based on the reference level. The valid values for this attribute depend on your device configuration.\n\nIf you set the NIRFSA_ATTR_MIXER_LEVEL and NIRFSA_ATTR_MIXER_LEVEL_OFFSET attributes at the same time, NI-RFSA returns an error.\n\n**PXIe-5601/5663/5663E**: This attribute is read-only.\n\n**PXIe-5667**: This attribute is read-only when the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute is set to NIRFSA_VAL_DISABLED.\n\n**Units**: dBm\n\n**Default Values**:\n\n**PXI-5600/5661**: -30\n\n**PXIe-5603/5605/5665/5667/5668**: -10\n\n**All other devices**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:Mixer Level (dBm)', + 'name': 'MIXER_LEVEL', + 'type': 'ViReal64' + }, + 1150007: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the I/Q rate for the acquisition. \n\nThe value is expressed in samples per second (S/s).\n\nRefer to the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute for more information about device specific instantaneous bandwidth limits. You can also refer to the *NI PXIe-5665 Specifications* for more information about instantaneous bandwidth device specifications.\n\n----\n**Note**\nFor the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. At I/Q rates above 50 MS/s, the dither noise can affect phase coherency performance and leak into the lower frequencies and the upper frequencies of the IF passband. Refer to the NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED attribute for more information about dithering.\n\nFor the PXIe-5663/5663E/5665/5667, when you set the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute to NIRFSA_VAL_ONBOARD_CLOCK, the downconverter instantaneous bandwidth is greater than or equal to the coerced I/Q rate times 0.8. For the PXIe-5665, the actual signal bandwidth is further limited by the combination of the chosen IF filter and anti-aliasing filter.\n\n----\n\n**PXI-5661**: You should not need to configure an I/Q rate higher than 25 megasamples per second (MS/s) because the PXI-5600 RF downconverter bandwidth is 20 MHz. If you configure a higher I/Q rate, you may see aliasing effects at negative frequencies because the IF frequency of the PXI-5600 is 15 MHz.\n\n**PXIe-5663/5663E**: Your maximum allowed instantaneous bandwidth depends on the I/Q carrier frequency you use. Refer to the `PXIe-5601 RF downconverter overview `_ for more information about instantaneous bandwidth.\n\n**PXIe-5665**: Your maximum allowed instantaneous bandwidth depends on the downconverter center frequency if you have enabled the preselector (YIG-tuned filter).\n\n**PXIe-5667**: Your maximum allowed instantaneous bandwidth depends on the selected [RF preselector filter](NIRFSA_ATTR_RF_PRESELECTOR_FILTER.html) and whether the preselector on the [RF downconverter](NIRFSA_ATTR_PRESELECTOR_ENABLED.html) is enabled.\n\n**PXIe-5668**: Your maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use and whether or not you enable the highpass filter or preselector (YIG-tuned filter).\n\n**Units**: S/s\n\n**Default Values:**\n\n**PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality**: 5 GS/s only.\n\n**All Other Devices**: 1 MS/s\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureIqRate' + }, + 'lv_property': 'Acquisition:IQ:IQ Rate (S/s)', + 'name': 'IQ_RATE', + 'type': 'ViReal64' + }, + 1150008: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the device acquires a finite number of samples or acquires continuously.\n\n**Defined Values**:\n\n| Value | Description |\n|:---------|:------------------------------------------------------|\n| VI_TRUE | Acquire a finite number of samples. |\n| VI_FALSE | Acquire continuously until you abort the acquisition. |\n\n**Default Value**: VI_TRUE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureNumberOfSamples' + }, + 'lv_property': 'Acquisition:IQ:Number Of Samples Is Finite', + 'name': 'NUMBER_OF_SAMPLES_IS_FINITE', + 'type': 'ViBoolean' + }, + 1150009: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of samples to acquire. \n\nThis attribute is valid only if the NIRFSA_ATTR_NUMBER_OF_SAMPLES_IS_FINITE attribute is set to VI_TRUE.\n\n**Default Value**: 1,000\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureNumberOfSamples' + }, + 'lv_property': 'Acquisition:IQ:Number Of Samples', + 'name': 'NUMBER_OF_SAMPLES', + 'type': 'ViInt64' + }, + 1150010: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the device stops after acquiring the specified number of records or acquires records continuously.\n\n**Defined Values**:\n\n| Value | Description |\n|:---------|:--------------------------------------------------------------|\n| VI_TRUE | Acquire a finite number of records. |\n| VI_FALSE | Acquire records continuously until you abort the acquisition. |\n\n**Default Value**: VI_TRUE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureNumberOfRecords' + }, + 'lv_property': 'Acquisition:IQ:Number Of Records Is Finite', + 'name': 'NUMBER_OF_RECORDS_IS_FINITE', + 'type': 'ViBoolean' + }, + 1150011: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of records to acquire if the NIRFSA_ATTR_NUMBER_OF_RECORDS_IS_FINITE attribute is set to VI_TRUE.\n\n**Default Value**: 1\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureNumberOfRecords' + }, + 'lv_property': 'Acquisition:IQ:Number Of Records', + 'name': 'NUMBER_OF_RECORDS', + 'type': 'ViInt64' + }, + 1150012: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the units of the power spectrum.\n\n**Default Value**: NIRFSA_VAL_DBM\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DBM', + 'Units are dB with reference to 1 milliwatt.' + ], + [ + 'NIRFSA_VAL_VOLTS_SQUARED', + 'Units are in volts squared.' + ], + [ + 'NIRFSA_VAL_DBMV', + 'Units are dB with reference to 1 millivolt.' + ], + [ + 'NIRFSA_VAL_DBUV', + 'Units are dB with reference to 1 microvolt.' + ], + [ + 'NIRFSA_VAL_VOLTS', + 'Units are in volts.' + ], + [ + 'NIRFSA_VAL_WATTS', + 'Units are in watts.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'PowerSpectrumUnits', + 'lv_property': 'Acquisition:Spectrum:Power Spectrum Units', + 'name': 'POWER_SPECTRUM_UNITS', + 'type': 'ViInt32' + }, + 1150013: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the resolution along the x-axis of the spectrum. \n\nNI-RFSA uses the resolution bandwidth value to determine the acquisition size. If specified, the NIRFSA_ATTR_NUMBER_OF_SPECTRAL_LINES attribute value overrides this value.\n\n**Units**: hertz (Hz)\n\n**Default Value**: 100 kHz\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureResolutionBandwidth' + }, + 'lv_property': 'Acquisition:Spectrum:Resolution Bandwidth (Hz)', + 'name': 'RESOLUTION_BANDWIDTH', + 'type': 'ViReal64' + }, + 1150014: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies how the NIRFSA_ATTR_RESOLUTION_BANDWIDTH attribute is expressed.\n\n**Default Value**: NIRFSA_VAL_RBW_THREE_DECIBELS\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_RBW_THREE_DECIBELS', + 'Defines the resolution bandwidth (RBW) in terms of the 3 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + ], + [ + 'NIRFSA_VAL_RBW_SIX_DECIBELS', + 'Defines the RBW in terms of the 6 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + ], + [ + 'NIRFSA_VAL_RBW_BIN_WIDTH', + 'Defines the RBW in terms of the display resolution, which is the ratio of the sampling frequency to the number of samples that you acquire.' + ], + [ + 'NIRFSA_VAL_RBW_EQUIVALENT_NOISE_BANDWIDTH', + 'Defines the RBW in terms of the equivalent noise bandwidth (ENBW) of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SpectrumResolutionBandwidthType', + 'lv_property': 'Acquisition:Spectrum:Resolution Bandwidth Type', + 'name': 'RESOLUTION_BANDWIDTH_TYPE', + 'type': 'ViInt32' + }, + 1150015: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of acquisitions to average. \n\nThe averaging process returns the final result after the number of averages is complete.\n\n**Default Value**: 10\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:Number Of Averages', + 'name': 'SPECTRUM_NUMBER_OF_AVERAGES', + 'type': 'ViInt32' + }, + 1150016: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the averaging mode for the spectrum acquisition.\n\n**Default Value**: NIRFSA_VAL_NO_AVERAGING\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NO_AVERAGING', + 'Configures NI-RFSA to perform no averaging on acquisitions.' + ], + [ + 'NIRFSA_VAL_RMS_AVERAGING', + 'Configures NI-RFSA for root-mean-square (RMS) averaging. RMS averaging reduces signal fluctuations but not the noise floor. RMS averaging averages the energy, or power, of the signal. This averaging prevents noise floor reduction and gives averaged RMS quantities of single-channel measurements zero phase. RMS averaging for dual-channel measurements preserves important phase information.' + ], + [ + 'NIRFSA_VAL_VECTOR_AVERAGING', + 'Configures NI-RFSA for vector averaging. Vector averaging reduces noise from synchronous signals. Vector averaging computes the average of complex quantities directly, which means that it allows separate averaging for real and imaginary parts. Complex averaging such as vector averaging reduces noise and usually requires a trigger to improve block-to-block phase coherence.' + ], + [ + 'NIRFSA_VAL_PEAK_HOLD_AVERAGING', + 'Configures NI-RFSA for peak-hold averaging. Peak-hold averaging retains the RMS peak levels of the averaged quantities. The peak-hold averaging process performs peak-hold at each frequency bin separately to retain peak RMS levels from one FFT record to the next.' + ], + [ + 'NIRFSA_VAL_MIN_HOLD_AVERAGING', + 'Configures NI-RFSA to perform no averaging on acquisitions.' + ], + [ + 'NIRFSA_VAL_SCALAR_AVERAGING', + 'Configures NI-RFSA to perform no averaging on acquisitions.' + ], + [ + 'NIRFSA_VAL_LOG_AVERAGING', + 'Configures NI-RFSA to perform no averaging on acquisitions.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SpectrumAveragingMode', + 'lv_property': 'Acquisition:Spectrum:Averaging Mode', + 'name': 'SPECTRUM_AVERAGING_MODE', + 'type': 'ViInt32' + }, + 1150017: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the time-domain window type.\n\n**Default Values**:\n\n**PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: NIRFSA_VAL_7_TERM_BLACKMAN_HARRIS\n\n**PXIe-5667**: NIRFSA_VAL_4_TERM_BLACKMAN_HARRIS\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Resolution Bandwidth `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_UNIFORM', + 'No window is applied.' + ], + [ + 'NIRFSA_VAL_HANNING', + 'The Hanning window is useful for analyzing transients longer than the time duration of the window, and also for general-purpose applications.' + ], + [ + 'NIRFSA_VAL_HAMMING', + 'A Hamming window is applied to the waveform using the following equation: y[i] = x[i] * (0.54 - 0.46cos(w)) where w = (2)i/n and n = the waveform size. Note: Hanning and Hamming windows are somewhat similar. However, in the time domain, the Hamming window does not get as close to zero near the edges as does the Hanning window.' + ], + [ + 'NIRFSA_VAL_BLACKMAN_HARRIS', + 'A Blackman-Harris window is applied to the waveform using the following equation: y[i] = x[i] * (0.42323 - 0.49755*cos(w) + 0.07922*cos(2w))' + ], + [ + 'NIRFSA_VAL_EXACT_BLACKMAN', + 'An Exact Blackman window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w))' + ], + [ + 'NIRFSA_VAL_BLACKMAN', + 'A Blackman window is useful for analyzing transient signals, and provides similar windowing to Hanning and Hamming windows but adds one additional cosine term to reduce ripple. A Blackman window is applied to the waveform using the following equation: y[i] = x[i] * (0.42 - 0.50*cos(w) + 0.08*cos(2w))' + ], + [ + 'NIRFSA_VAL_FLAT_TOP', + 'The fifth-order Flat Top window has the best amplitude accuracy of all the window functions. The increased amplitude accuracy (0.02 dB for signals exactly between integral cycles) is at the expense of frequency selectivity. The Flat Top window is most useful in accurately measuring the amplitude of single frequency components with little nearby spectral energy in the signal. A fifth-order Flat Top window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w) + a4*cos(4w))' + ], + [ + 'NIRFSA_VAL_4_TERM_BLACKMAN_HARRIS', + 'A 4-term Blackman-Harris window is a general purpose window; it has side-lobe rejection in the upper 90 dB, with moderately wide side lobe. A 4-term Blackman Harris window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w))' + ], + [ + 'NIRFSA_VAL_7_TERM_BLACKMAN_HARRIS', + 'A 7-term Blackman-Harris window has the highest dynamic range; it is ideal for signal-to-noise ratio applications. A 7-term Blackman Harris window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w) + a4*cos(4w) - a5*cos(5w) + a6*cos(6w))' + ], + [ + 'NIRFSA_VAL_LOW_SIDE_LOBE', + 'The Low Side Lobe window further reduces the size of the main lobe. The following equation defines the Low Side Lobe window. where *N* is the length of window' + ], + [ + 'NIRFSA_VAL_GAUSSIAN', + 'A Gaussian window is applied to the waveform using the following equation: y[i] = x[i] * exp(-0.5*(i - (N-1)/2)^2 / ((N-1)/2)^2) where N is the length of the window' + ], + [ + 'NIRFSA_VAL_KAISER_BESSEL', + 'A Kaiser-Bessel window is applied to the waveform using the following equation: y[i] = x[i] * I0(β*sqrt(1 - (2i/(N-1) - 1)^2))/I0(β) where i is between 0 and N-1, N is the length of the window, β determines the shape of the window, and I0 is the zeroth order Modified Bessel function of the first kind' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SpectrumFftWindowType', + 'lv_property': 'Acquisition:Spectrum:FFT Window Type', + 'name': 'FFT_WINDOW_TYPE', + 'type': 'ViInt32' + }, + 1150018: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of spectral lines expected with the current power spectrum configuration. \n\nIf you do not configure this attribute, NI-RFSA selects an appropriate value based on the NIRFSA_ATTR_RESOLUTION_BANDWIDTH attribute. If you configure this attribute, NI-RFSA coerces the NIRFSA_ATTR_RESOLUTION_BANDWIDTH value based on the number of spectral lines requested and the value of the NIRFSA_ATTR_SPECTRUM_SPAN attribute.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:Number Of Spectral Lines', + 'name': 'NUMBER_OF_SPECTRAL_LINES', + 'type': 'ViInt32' + }, + 1150019: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the Reference Clock source.\n\n----\n**Note**\nFor the PXIe-5694, if your application requires an external LO source, set this attribute to NIRFSA_VAL_NONE.\n\n----\n\n**Default Values**:\n\n**PXIe-5694**: NIRFSA_VAL_REF_IN\n\n**All other devices**: NIRFSA_VAL_ONBOARD_CLOCK\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668.' + ], + [ + 'NIRFSA_VAL_ONBOARD_CLOCK', + '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**PXIe-5830/5831 **For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector.**PXIe-5831/5832 with PXIe-5653 **Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**PXIe-5841 with PXIe-5655 **Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector.**PXIe-5842 **Lock to the PXIe-5655 onboard clock. Cables between modules are required as shown in the User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock.' + ], + [ + 'NIRFSA_VAL_REF_IN', + '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the signal at the external FREQ REF IN connector on the PXI-5600**PXIe-5663/5663E **Connect the external signal to the PXI/PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, this configuration can only be used in external digitizer mode.**PXIe-5665 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5667 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5668 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT on the PXIe-5606 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the **clock rate** parameter according to the frequency of your external clock signal.**PXIe-5694 **Connect the Reference Clock signal to the REF/LO IN connector on the PXIe-5694 front panel.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to the signal at the external REF IN connector.**PXIe-5830/5831 **For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector.**PXIe-5831/5832 with PXIe-5653 **Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.**PXIe-5841 with PXIe-5655 **Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. **PXIe-5842 **Lock to the signal at the REF IN connector on the associated PXIe-5655. Cables between modules are required as shown in the User Manual for the instrument. PXIe-5860 Lock to the signal at the REF IN connector on the PXIe-5860.' + ], + [ + 'NIRFSA_VAL_PXI_CLK', + '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI backplane clock using the PXI-5600. You must connect the PXI 10 MHz connector to the REF IN connector on the PXI-5600 front panel to use this option. **PXIe-5668 **Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT to the LO2 IN connector on the PXIe-5624.**PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **Lock the device to the PXI backplane clock.' + ], + [ + 'NIRFSA_VAL_CLK_IN', + '**PXI-5661 **This configuration does not apply to the PXI-5661.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXI/PXIe-5652.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5668 **Lock the PXIe-5668 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the **clock rate** parameter to 100 MHz.**PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **This configuration does not apply.' + ], + [ + 'NIRFSA_VAL_PXI_CLK_MASTER', + '**PXIe-5831/5832 with PXIe-5653 **NI-RFSA configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5840/5841/5841 with PXIe-5655 /5842/5860**This configuration does not apply.' + ], + [ + 'NIRFSA_VAL_REF_IN_2', + '**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655 **This configuration does not apply.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceClockSource', + 'lv_property': 'Clocking:Ref Clock Source', + 'name': 'REF_CLOCK_SOURCE', + 'type': 'ViString' + }, + 1150020: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. \n\nThis attribute is only valid when the NIRFSA_ATTR_REF_CLOCK_SOURCE attribute is set to NIRFSA_VAL_CLK_IN, NIRFSA_VAL_REF_IN, or NIRFSA_VAL_REF_IN_2.\n\n**Valid Values**:\n\n**PXIe-5644/5645/5646, PXIe-5601/5663/5663E, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841**: 10 MHz\n\n**PXIe-5603/5605/5665/5667/5668**: 5 MHz to 100 MHz, in increments of 1 MHz\n\n**PXIe-5841 with PXIe-5655, PXIe-5842**: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz *y*, where *y* is 4, 8, 16, 24, 25, or 32.\n\n**PXIe-5860**: 10 MHz, 100 MHz\n\n**Default Value**: 10 MHz\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock' + }, + 'lv_property': 'Clocking:Ref Clock Rate', + 'name': 'REF_CLOCK_RATE', + 'type': 'ViReal64' + }, + 1150021: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the source of the Sample Clock timebase, which is the timebase used to control waveform sampling.\n\n**Default Value**: NIRFSA_VAL_ONBOARD_CLOCK\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_ONBOARD_CLOCK', + 'The digitizer uses its onboard clock as the Sample Clock timebase.' + ], + [ + 'NIRFSA_VAL_CLK_IN', + 'The digitizer uses the signal present on the CLK IN connector as the Sample Clock timebase.' + ], + [ + 'NIRFSA_VAL_LO_REF_CLK', + 'The digitizer uses the signal generated on the 100 MHz REF OUT terminal on the PXIe-5653 as the Sample Clock timebase. This value is supported only for the PXIe-5665.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The digitizer uses the signal present at the PXI star trigger line as the Sample Clock timebase. This value is not supported for the PXIe-5668.' + ], + [ + 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT', + 'The digitizer uses the signal present on the LO2 OUT connector on the downconverter as the Sample Clock timebase. This value is supported only for the PXIe-5668.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DigitizerSampleClockTimebaseSource', + 'lv_property': 'Clocking:Digitizer Sample Clock Timebase Source', + 'name': 'DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE', + 'type': 'ViString' + }, + 1150022: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the frequency, in hertz (Hz), of the external clock used as the timebase source if you set the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute to an external source, such as NIRFSA_VAL_CLK_IN, NIRFSA_VAL_LO_REF_CLK, or NIRFSA_VAL_DOWNCONVERTER_LO2_OUT\n\n**PXI-5661**If this attribute is set to a value less than 60 MHz, signals at frequencies just above the 20 MHz passband of the downconverter may be aliased back into the passband. This aliasing occurs because the IF frequency of the downconverter is 15 MHz, and the upper end of the passband is 25 MHz. At sampling rates below 60 MHz, the Nyquist frequency is close to the end of the passband and creates aliases that are not filtered effectively by the downconverter.\n\n**Units**: hertz (Hz)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Valid and Default Values**:', + 'table_body': [ + [ + 'PXI-5661', + 'Any frequency 226552.5 MHz', + '100 MHz' + ], + [ + 'PXIe-5663/5663E/5665/5667', + '150 MHz', + '150 MHz' + ], + [ + 'PXIe-5668', + '2 GHz', + '2 GHz' + ] + ], + 'table_header': [ + 'Device', + 'Valid Values', + 'Default Value' + ] + }, + 'lv_property': 'Clocking:Digitizer Sample Clock Timebase Rate', + 'name': 'DIGITIZER_SAMPLE_CLOCK_TIMEBASE_RATE', + 'type': 'ViReal64' + }, + 1150024: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether you want the Start Trigger to be a digital edge or software trigger.\n\n----\n**Note**\nSet this attribute to NIRFSA_VAL_NONE if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM or if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the [cviniRFSA_ConfigureAcquisitionType](cviniRFSA_ConfigureAcquisitionType.html) function.\n\n----\n\n**Default Value**: NIRFSA_VAL_NONE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'No Start Trigger is configured.' + ], + [ + 'NIRFSA_VAL_DIGITAL_EDGE', + 'The Start Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute.' + ], + [ + 'NIRFSA_VAL_SOFTWARE_EDGE', + 'The Start Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_START_TRIGGER as the value of the **trigger** parameter.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'StartTriggerType', + 'lv_property': 'Triggers:Start:Type', + 'name': 'START_TRIGGER_TYPE', + 'type': 'ViInt32' + }, + 1150025: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the source terminal for the Start Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_START_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureDigitalEdgeStartTrigger\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARB', + 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_TIMER_EVENT', + 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Triggers:Start:Digital Edge:Source', + 'name': 'DIGITAL_EDGE_START_TRIGGER_SOURCE', + 'type': 'ViString' + }, + 1150026: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the active edge for the Start Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_START_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: NIRFSA_VAL_RISING_EDGE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureDigitalEdgeStartTrigger\n\n**Defined and Valid Values:**', + 'table_body': [ + [ + 'NIRFSA_VAL_RISING_EDGE', + 'The trigger asserts on the rising edge of the signal.', + 'PXI-5661, PXIe-5663/5663E/5665/5668' + ], + [ + 'NIRFSA_VAL_FALLING_EDGE', + 'The trigger asserts on the falling edge of the signal', + 'PXIe-5668' + ] + ], + 'table_header': [ + 'Name', + 'Description', + 'Valid For' + ] + }, + 'enum': 'StartTriggerDigitalEdgeEdge', + 'lv_property': 'Triggers:Start:Digital Edge:Edge', + 'name': 'DIGITAL_EDGE_START_TRIGGER_EDGE', + 'type': 'ViInt32' + }, + 1150027: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the exported Start Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Triggers:Start:Export:Output Terminal', + 'name': 'EXPORTED_START_TRIGGER_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150028: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether you want the Reference Trigger to be a digital edge, I/Q power edge, or software trigger.\n\n**Default Value**: NIRFSA_VAL_NONE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'No Reference Trigger is configured.' + ], + [ + 'NIRFSA_VAL_DIGITAL_EDGE', + 'The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_REF_TRIGGER_SOURCE attribute.' + ], + [ + 'NIRFSA_VAL_IQ_POWER_EDGE', + 'The Reference Trigger is asserted when the signal is changing past the level specified with the slope (rising or falling) configured with the NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_SLOPE attribute.' + ], + [ + 'NIRFSA_VAL_SOFTWARE_EDGE', + 'The Reference Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_REF_TRIGGER as the **trigger** parameter.' + ], + [ + 'NIRFSA_VAL_IQ_ANALOG_EDGE', + 'The Reference Trigger is asserted when the I or Q signal is changed past the level specified with the slope configured with the NIRFSA_ATTR_IQ_ANALOG_EDGE_REF_TRIGGER_SLOPE attribute. This value is valid only for PXIe-5644/5645 devices.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceTriggerType', + 'lv_property': 'Triggers:Ref:Type', + 'name': 'REF_TRIGGER_TYPE', + 'type': 'ViInt32' + }, + 1150029: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the source terminal for the digital edge Reference Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_REF_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARB', + 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_TIMER_EVENT', + 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Triggers:Ref:Digital Edge:Source', + 'name': 'DIGITAL_EDGE_REF_TRIGGER_SOURCE', + 'type': 'ViString' + }, + 1150030: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the active edge for the Reference Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_REF_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: NIRFSA_VAL_RISING_EDGE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureDigitalEdgeRefTrigger\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_RISING_EDGE', + 'The trigger asserts on the rising edge of the signal.' + ], + [ + 'NIRFSA_VAL_FALLING_EDGE', + 'The trigger asserts on the falling edge of the signal' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceTriggerDigitalEdgeEdge', + 'lv_property': 'Triggers:Ref:Digital Edge:Edge', + 'name': 'DIGITAL_EDGE_REF_TRIGGER_EDGE', + 'type': 'ViInt32' + }, + 1150032: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the exported Reference Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Triggers:Ref:Export:Output Terminal', + 'name': 'EXPORTED_REF_TRIGGER_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150033: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the minimum time, in seconds, that must elapse after the Start Trigger is received before the device recognizes a Reference Trigger.\n\n**Units:** seconds\n\n**Default Value**: 0\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Triggers:Ref:Advanced:Start To Ref Trigger Holdoff (s)', + 'name': 'START_TO_REF_TRIGGER_HOLDOFF', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150034: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the minimum time, in seconds, that must elapse between Reference Triggers of two records. \n\nThe device does not recognize the Reference Trigger of the next record before this minimum time elapses.\n\n**Units:**: seconds\n\n**Default Value**: 0\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Triggers:Ref:Advanced:Ref To Ref Trigger Holdoff (s)', + 'name': 'REF_TO_REF_TRIGGER_HOLDOFF', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150035: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of pretrigger samples the samples acquired before the Reference Trigger is received to be acquired per record.\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureDigitalEdgeRefTrigger\n- nirfsa_ConfigureSoftwareEdgeRefTrigger\n- nirfsa_ConfigureIqPowerEdgeRefTrigger' + }, + 'lv_property': 'Triggers:Ref:Pretrigger Samples', + 'name': 'REF_TRIGGER_PRETRIGGER_SAMPLES', + 'type': 'ViInt64' + }, + 1150036: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether you want the Advance Trigger to be a digital edge or software trigger.\n\n----\n**Note**\nSet this attribute to NIRFSA_VAL_NONE if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM or if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function.\n\n----\n\n**Default Value**: NIRFSA_VAL_NONE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'No Advance Trigger is configured.' + ], + [ + 'NIRFSA_VAL_DIGITAL_EDGE', + 'The Advance Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_ADVANCE_TRIGGER_SOURCE attribute.' + ], + [ + 'NIRFSA_VAL_SOFTWARE_EDGE', + 'The Advance Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_ADVANCE_TRIGGER as the **trigger** parameter.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'AdvanceTriggerType', + 'lv_property': 'Triggers:Advance:Type', + 'name': 'ADVANCE_TRIGGER_TYPE', + 'type': 'ViInt32' + }, + 1150037: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the source terminal for the Advance Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_ADVANCE_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureDigitalEdgeRefTrigger\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on the PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on the PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on the PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on the PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on the PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on the PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on the PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on the PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on the PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARB', + 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_TIMER_EVENT', + 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Triggers:Advance:Digital Edge:Source', + 'name': 'DIGITAL_EDGE_ADVANCE_TRIGGER_SOURCE', + 'type': 'ViString' + }, + 1150038: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the exported Advance Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Triggers:Advance:Export:Output Terminal', + 'name': 'EXPORTED_ADVANCE_TRIGGER_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150039: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether you want the Arm Reference Trigger to be a digital edge or software trigger.\n\n----\n**Note**\nThe PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841 only support NIRFSA_VAL_NONE.\n\n----\n\n----\n**Note**\nSet this attribute to NIRFSA_VAL_NONE if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM or if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function.\n\n----\n\n**Default Value**: NIRFSA_VAL_NONE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'No Arm Reference Trigger is configured.' + ], + [ + 'NIRFSA_VAL_DIGITAL_EDGE', + 'The Arm Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_ARM_REF_TRIGGER_SOURCE attribute.' + ], + [ + 'NIRFSA_VAL_SOFTWARE_EDGE', + 'The Arm Reference Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_ARM_REF_TRIGGER as the **trigger** parameter.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ArmReferenceTriggerType', + 'lv_property': 'Triggers:Arm Ref:Type', + 'name': 'ARM_REF_TRIGGER_TYPE', + 'type': 'ViInt32' + }, + 1150040: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the source terminal for the digital edge Arm Reference Trigger.\n\nThis attribute is used only when the NIRFSA_ATTR_ARM_REF_TRIGGER_TYPE attribute is set to NIRFSA_VAL_DIGITAL_EDGE.\n\n**Default Value**: "" (empty string)\n\n----\n**Note**\nThe PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841 devices only support "" (empty string).\n\nThe trigger is received on PFI0 from the front panel DIO terminal.\n\nThe trigger is received on PFI1 from the front panel DIO terminal.\n\nThe trigger is received on PFI2 from the front panel DIO terminal.\n\nThe trigger is received on PFI3 from the front panel DIO terminal.\n\nThe trigger is received on PFI4 from the front panel DIO terminal.\n\nThe trigger is received on PFI5 from the front panel DIO terminal.\n\nThe trigger is received on PFI6 from the front panel DIO terminal.\n\nThe trigger is received on PFI7 from the front panel DIO terminal.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667, PXIe-5820/5830/5831/5832/5840/5841\n\n**Related Topics**\n\n`Triggers `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARB', + 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_TIMER_EVENT', + 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Triggers:Arm Ref:Digital Edge:Source', + 'name': 'DIGITAL_EDGE_ARM_REF_TRIGGER_SOURCE', + 'type': 'ViString' + }, + 1150041: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the Ready for Start Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Events:Ready For Start:Output Terminal', + 'name': 'EXPORTED_READY_FOR_START_EVENT_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150042: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the Ready for Advance Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on the PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on the PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on the PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on the PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on the PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on the PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on the PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on the PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Events:Ready For Advance:Output Terminal', + 'name': 'EXPORTED_READY_FOR_ADVANCE_EVENT_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150043: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the Ready for Reference Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Events:Ready For Ref:Output Terminal', + 'name': 'EXPORTED_READY_FOR_REF_EVENT_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150044: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the End of Record Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`Signal Routing `_\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Events:End Of Record:Output Terminal', + 'name': 'EXPORTED_END_OF_RECORD_EVENT_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150045: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the reference location within the acquired record from which to begin fetching.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_MOST_RECENT_SAMPLE', + 'Fetching occurs relative to the most recently acquired data. The value of the NIRFSA_ATTR_FETCH_OFFSET attribute must be negative.' + ], + [ + 'NIRFSA_VAL_FIRST_SAMPLE', + 'Fetching occurs at the first sample acquired by the device. If the device wraps its buffer, the first sample is no longer available. In this case, NI-RFSA returns an error if the fetch offset is in the overwritten data.' + ], + [ + 'NIRFSA_VAL_REFERENCE_TRIGGER', + 'Fetching occurs relative to the Reference Trigger. This value behaves like NIRFSA_VAL_FIRST_SAMPLE if no Reference Trigger is configured.' + ], + [ + 'NIRFSA_VAL_FIRST_PRETRIGGER_SAMPLE', + 'Fetching occurs relative to the first pretrigger sample acquired.' + ], + [ + 'NIRFSA_VAL_CURRENT_READ_POSITION', + 'Fetching occurs after the last fetched sample.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'FetchRelativeTo', + 'lv_property': 'Acquisition:Fetch:Fetch Relative To', + 'name': 'FETCH_RELATIVE_TO', + 'type': 'ViInt32' + }, + 1150046: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the offset relative to the position specified by the NIRFSA_ATTR_FETCH_RELATIVE_TO attribute from which to start fetching data. \n\nOffset can be a positive or negative value.\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Fetch:Fetch Offset', + 'name': 'FETCH_OFFSET', + 'type': 'ViInt64' + }, + 1150047: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the number of records the RF vector signal analyzer has acquired.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Fetch:Records Done', + 'name': 'RECORDS_DONE', + 'type': 'ViInt64' + }, + 1150048: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Enables use of the digital equalization filter for the RF downconverter.\n\n**PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: The only valid value for this attribute is VI_TRUE.\n\n----\n**Note**\nFor PXIe-5665/5667 devices, digital IF equalization is supported only with a 150 MHz clock. You cannot set this attribute to VI_TRUE if the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute is set to NIRFSA_VAL_LO_REF_CLK.\n\n----\n\n----\n**Note**\nFor the PXIe-5665 (14 GHz)/5667 (7 GHz)/5668, the preselector is not part of the IF filter path, so NI-RFSA does not equalize the preselector distortions.\n\n----\n\n**Default Value**: VI_TRUE, if the device configuration is supported.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841\n\n**Defined Values**:', + 'table_body': [ + [ + 'VI_TRUE', + 'Enables digital IF equalization on the RF downconverter.' + ], + [ + 'VI_FALSE', + 'Disables digital IF equalization on the RF downconverter.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Signal Path:Digital IF Equalization Enabled', + 'name': 'DIGITAL_IF_EQUALIZATION_ENABLED', + 'type': 'ViBoolean' + }, + 1150049: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the size of the window used in the fast Fourier transform (FFT), in terms of the number of samples in the window.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:FFT Window Size', + 'name': 'FFT_WINDOW_SIZE', + 'type': 'ViInt32' + }, + 1150050: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the size of the fast Fourier transform (FFT).\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:FFT Size', + 'name': 'FFT_SIZE', + 'type': 'ViInt32' + }, + 1150051: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the current temperature, in degrees Celsius, of the module.\n\n**PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860**: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n**PXIe-5830/5831/5832**: To use this attribute, you must first set the channelName parameter of the nirfsa_SetAttributeViReal64 function to using the appropriate string for your instrument configuration. Setting the nirfsa_SetAttributeViReal64 attribute is not required for the PXIe-3621/3622. Refer to the following table to determine which strings are valid for your configuration.\n\n**Units**: degrees Celcius\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'table_body': [ + [ + 'PXIe-3621/3622/5842', + '-', + 'if or "" (empty string)' + ], + [ + 'PXIe-5820', + '-', + 'fpga' + ], + [ + 'PXIe-5860', + '-', + '5860 or "" (empty string)' + ], + [ + 'First connected mmRH-5582', + 'DIRECT TRX PORTS Only', + 'rf0' + ], + [ + 'First connected mmRH-5582', + 'SWITCHED TRX PORTS [0-7]', + 'rf0switch0' + ], + [ + 'First connected mmRH-5582', + 'SWITCHED TRX PORTS [8-15]', + 'rf0switch1' + ], + [ + 'Second connected mmRH-5582', + 'DIRECT TRX PORTS Only', + 'rf1' + ], + [ + 'Second connected mmRH-5582', + 'SWITCHED TRX PORTS [0-7]', + 'rf1switch0' + ], + [ + 'Second connected mmRH-5582', + 'SWITCHED TRX PORTS [8-15]', + 'rf1switch1' + ], + [ + 'First connected RMM-5544/5546', + '-', + 'rmm0' + ], + [ + 'Second connected RMM-5544/5546', + '-', + 'rmm1' + ] + ], + 'table_header': [ + 'Hardware Module', + 'TRX Port Type', + 'Active Channel String' + ] + }, + 'lv_property': 'Device Characteristics:Device Temperature (Degrees C)', + 'name': 'DEVICE_TEMPERATURE', + 'supported_rep_caps': [ + 'device_temperatures' + ], + 'type': 'ViReal64' + }, + 1150053: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the serial number of the RF downconverter module.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646 and PXIe-5820/5840/5841, this attribute returns the serial number of the VST module. For the PXIe-5830/5831/5832, this attribute returns the serial number of the PXIe-3621/3622.\n\n----\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Serial Number', + 'name': 'SERIAL_NUMBER', + 'type': 'ViString' + }, + 1150054: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the destination terminal for the Done Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DO_NOT_EXPORT', + 'The signal is not exported.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_PFI0', + 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + ], + [ + 'NIRFSA_VAL_PFI1', + 'The trigger is received on PFI 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG0', + 'The trigger is received on PXI trigger line 0.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG1', + 'The trigger is received on PXI trigger line 1.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG2', + 'The trigger is received on PXI trigger line 2.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG3', + 'The trigger is received on PXI trigger line 3.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG4', + 'The trigger is received on PXI trigger line 4.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG5', + 'The trigger is received on PXI trigger line 5.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG6', + 'The trigger is received on PXI trigger line 6.' + ], + [ + 'NIRFSA_VAL_PXI_TRIG7', + 'The trigger is received on PXI trigger line 7.' + ], + [ + 'NIRFSA_VAL_PXI_STAR', + 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_PXIE_DSTARC', + 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_DIO_PFI0', + 'The trigger is received on PFI0 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI1', + 'The trigger is received on PFI1 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI2', + 'The trigger is received on PFI2 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI3', + 'The trigger is received on PFI3 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI4', + 'The trigger is received on PFI4 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI5', + 'The trigger is received on PFI5 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI6', + 'The trigger is received on PFI6 from the front panel DIO terminal.' + ], + [ + 'NIRFSA_VAL_DIO_PFI7', + 'The trigger is received on PFI7 from the front panel DIO terminal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ExportOutputTerminal', + 'lv_property': 'Events:Done:Output Terminal', + 'name': 'EXPORTED_DONE_EVENT_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150055: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the channel from which the device monitors the trigger. \n\nNI-RFSA currently supports only 0 as the value of this attribute.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureIqPowerEdgeRefTrigger' + }, + 'lv_property': 'Triggers:Ref:IQ Power Edge:Source', + 'name': 'IQ_POWER_EDGE_REF_TRIGGER_SOURCE', + 'type': 'ViString' + }, + 1150056: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the power level, in dBm, at which the device triggers. \n\nThe device asserts the trigger when the signal crosses the level specified by the value of this attribute, taking into consideration the specified slope. If you are using external gain, refer to the NIRFSA_ATTR_EXTERNAL_GAIN attribute for more information about how this attribute affects the I/Q power edge trigger level.\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureIqPowerEdgeRefTrigger' + }, + 'lv_property': 'Triggers:Ref:IQ Power Edge:Level', + 'name': 'IQ_POWER_EDGE_REF_TRIGGER_LEVEL', + 'type': 'ViReal64' + }, + 1150057: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the device asserts the trigger when the signal power is rising or falling. \n\nWhen you set the NIRFSA_ATTR_REF_TRIGGER_TYPE attribute to NIRFSA_VAL_IQ_POWER_EDGE, the device asserts the trigger when the signal power exceeds the specified level with the slope you specify.\n\n**Default Value**: NIRFSA_VAL_RISING_SLOPE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureIqPowerEdgeRefTrigger\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_RISING_SLOPE', + 'The trigger asserts when the signal power is rising.' + ], + [ + 'NIRFSA_VAL_FALLING_SLOPE', + 'The trigger asserts when the signal power is falling.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceTriggerIqPowerEdgeSlope', + 'lv_property': 'Triggers:Ref:IQ Power Edge:Slope', + 'name': 'IQ_POWER_EDGE_REF_TRIGGER_SLOPE', + 'type': 'ViInt32' + }, + 1150058: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies a time duration, in seconds, for which the signal must be quiet before the device arms the trigger. \n\nThe signal is quiet when it is below the trigger level if the trigger slope, specified by the NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_SLOPE attribute, is set to NIRFSA_VAL_RISING_SLOPE or when it is above the trigger level if the trigger slope is set to NIRFSA_VAL_FALLING_SLOPE.\n\nBy default, this value is set to 0, which means the device does not wait for a quiet time before arming the trigger. This attribute is useful to trigger the acquisition on signals containing repeated bursts, but for which each burst may have large changes in signal power within itself. By configuring the minimum quiet time to the time between bursts, you can ensure that the trigger occurs at the beginning of a burst rather than at the signal power change within a burst.\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Triggers:Ref:Minimum Quiet Time', + 'name': 'REF_TRIGGER_MINIMUM_QUIET_TIME', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150059: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the expected carrier frequency of the incoming signal for demodulation. \n\nThe NI-RFSA device tunes to this frequency. NI-RFSA may coerce this value based on hardware settings and the RF downconverter specifications.\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the I/Q ports.\n\n----\n\n**Units**: hertz (Hz)\n\n**Default Values**:\n\n**PXIe-5644/5645/5646, PXIe-5840/5841/5860, PXIe-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options)**: 1 GHz\n\n**PXIe-5842 (4 GHz bandwidth option) using the Standard personality**: 1 GHz\n\n**PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality**: 6.5 GHz\n\n**PXIe-5820**: 0 Hz\n\n**PXIe-5830/5831/5832**: 6.5 GHz\n\n**All other devices**: 100 MHz\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Carrier Wave `_\n\n`I/Q Modulation `_\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureIqCarrierFrequency' + }, + 'lv_property': 'Acquisition:IQ:IQ Carrier Frequency', + 'name': 'IQ_CARRIER_FREQUENCY', + 'type': 'ViReal64' + }, + 1150060: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the trigger delay time, in seconds. \n\nThe trigger delay time is the length of time the IF digitizer waits after it receives the trigger before it asserts the Reference Event.\n\n**Units:**: seconds\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Triggers:Ref:Advanced:Ref Trigger Delay (s)', + 'name': 'REF_TRIGGER_DELAY', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150061: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Indicates the minimum time between temperature sensor readings in seconds. \n\nWhen you call the nirfsa_ReadPowerSpectrumF64 function, the nirfsa_ReadIqSingleRecordComplexF64 function, or the nirfsa_Initiate function, NI-RFSA checks whether at least the amount of time specified by this attribute has elapsed before reading the hardware temperature.\n\n----\n**Note**\nNI-RFSA ignores this attribute if you call the nirfsa_PerformThermalCorrection function or read the NIRFSA_ATTR_DOWNCONVERTER_GAIN attribute.\n\n----\n\n**Default Value**: 30 seconds\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Temperature Read Interval', + 'name': 'TEMPERATURE_READ_INTERVAL', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150065: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the net signal gain for the NI-RFSA device at the current NI-RFSA settings and temperature. \n\nNI-RFSA scales the acquired I/Q and spectrum data from the digitizer using the value of this attribute.\n\nFor a vector signal analyzer (VSA), the system is defined as the RF downconverter and all interfaces between the RF IN connector on the RF downconverter front panel and the IF IN connector on the digitizer front panel. For a spectrum monitoring receiver, the system is defined as the RF preselector, RF downconverter, and IF conditioning modules including all interfaces between the RF IN connector on the RF preselector module front panel and the IF IN connector on the digitizer front panel.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Downconverter Gain (dB)', + 'name': 'DOWNCONVERTER_GAIN', + 'type': 'ViReal64' + }, + 1150067: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the loop bandwidth of the RF downconverter tuning PLLs. \n\nTo set this attribute, the NI-RFSA device must be in the Configuration state.\n\n**PXI-5600/5661** : For signal bandwidths greater than 10 MHz, NIRFSA_VAL_WIDE is the only value supported for this attribute.\n\n**PXIe-5601/5663/5663E** : The PXIe-5601 does not support the NIRFSA_VAL_MEDIUM value. This attribute is not supported if you are using an external LO.\n\n**PXIe-5830/5831/5832/5840/5841/5842** : The PXIe-5840/5841/5842 supports only NIRFSA_VAL_MEDIUM for this attribute. This attribute is not supported if you are using an external LO.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Values**:\n\n**PXI-5600** : NIRFSA_VAL_WIDE\n\n**PXIe-5601** : NIRFSA_VAL_NARROW\n\n**PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842** : NIRFSA_VAL_MEDIUM\n\n**Supported Devices**: PXI-5600, PXIe-5601 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E, PXIe-5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NARROW', + 'Specifies that the downconverter module uses a narrow loop bandwidth.' + ], + [ + 'NIRFSA_VAL_MEDIUM', + 'Specifies that the downconverter module uses a medium loop bandwidth.' + ], + [ + 'NIRFSA_VAL_WIDE', + 'Specifies that the downconverter module uses a wide loop bandwidth.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DownconverterLoopBandwidth', + 'lv_property': 'Signal Path:Advanced:Downconverter Loop Bandwidth', + 'name': 'DOWNCONVERTER_LOOP_BANDWIDTH', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViInt32' + }, + 1150068: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the LO signal frequency for the configured center frequency.\n\nIf you are using the NI RF vector signal analyzer with an external LO, use this attribute to specify the LO frequency that the external LO source passes into the LO IN or LO1 IN connector on the RF downconverter front panel. If you are using an external LO, reading the value of this attribute after configuring the rest of the parameters returns the LO frequency needed by the device.\n\nSet this attribute to the actual LO frequency because NI-RFSA corrects for any difference between expected and actual LO frequencies.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Values**:\n\n**PXIe-5694**: 215 MHz\n\n**All other devices**: 0\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Configuration `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Configuration `_\n\n`PXIe-5841 Frequency and Bandwidth Configuration `_' + }, + 'lv_property': 'Signal Path:LO Frequency', + 'name': 'LO_FREQUENCY', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViReal64' + }, + 1150069: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the LO injection side.\n\n**PXIe-5601/5663/5663E**: For frequencies below 517.5 MHz or above 6.4125 GHz, the LO injection side is fixed and NI-RFSA returns an error if you specify the incorrect value. If you do not configure this attribute, NI-RFSA selects the default LO injection side based on the downconverter center frequency. Reset this attribute to return to automatic behavior.\n\n**PXIe-5603/5605/5665 (3.6 GHz)/5667 (3.6 GHz)**: Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is not supported for this device.\n\n**PXIe-5605/5665 (14 GHz)/5667 (7 GHz)**: Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is supported for this device for frequencies greater than 4 GHz, but this configuration is not calibrated, and device specifications are not guaranteed.\n\n**PXIe-5606/5668**: Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is supported for certain frequencies in high band, varying by final IF frequency. This configuration is not calibrated and device specifications are not guaranteed.\n\n**Default Values**:\n\n**PXIe-5601 (external digitizer mode), PXIe-5663/5663E (frequencies < 3.0 GHz)**: NIRFSA_VAL_LO_INJECTION_HIGH_SIDE\n\n**PXIe-5601 (external digitizer mode), PXIe-5663/5663E (frequencies 3.0 GHz)**: NIRFSA_VAL_LO_INJECTION_LOW_SIDE\n\n**PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5667/5668**: NIRFSA_VAL_LO_INJECTION_HIGH_SIDE\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_LO_INJECTION_HIGH_SIDE', + 'Configures the LO signal that the NI-RFSA device generates at a frequency higher than the RF frequency. This LO frequency is given by the formula fLO = fRF + fIF.' + ], + [ + 'NIRFSA_VAL_LO_INJECTION_LOW_SIDE', + 'Configures the LO signal that the NI-RFSA device generates at a frequency lower than the RF frequency. This LO frequency is given by the formula fLO = fRF - fIF.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoInjection', + 'lv_property': 'Signal Path:Advanced:LO Injection Side', + 'name': 'LO_INJECTION_SIDE', + 'type': 'ViInt32' + }, + 1150070: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the vertical range of the digitizer.\n\nThe vertical range is defined as the absolute value of the input range for a channel. The default vertical range works for all device configurations, but you can use this attribute to optimize performance if you know that the signal level at the digitizer input terminal is low.\n\n----\n**Note**\nFor most applications, NI-RFSA selects an appropriate value for this attribute.\n\n----\n\nThis value is expressed in volts. For example, to acquire a sine wave that spans between 20130.5 V and +0.5 V, set this attribute to 1.0.\n\n**PXIe-5840/5841/5842/5860**: This attribute is read-only.\n\n**Default Value**: 1.0\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667, PXIe-5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Digitizer Vertical Range', + 'name': 'DIGITIZER_VERTICAL_RANGE', + 'type': 'ViReal64' + }, + 1150071: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether fractional resampling is enabled on the digitizer. \n\nFractional resampling allows the digitizer to achieve very fine resolution on the I/Q rate value. Setting this attribute to VI_FALSE improves spectral performance.\n\n**PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: The only valid value for this attribute is VI_TRUE.\n\n**PXIe-5668**: When using a 400 MHz FPGA image, the only valid value for this attribute is VI_TRUE. When using a 800 MHz FPGA image, the only valid value for this attribute is VI_FALSE. Refer to `NI-RFSA Instrument Driver FPGA Extensions `_ for more information about FPGA images.\n\n**Default Value**: VI_TRUE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'VI_TRUE', + 'Enables fractional resampling.' + ], + [ + 'VI_FALSE', + 'Disables fractional resampling.' + ] + ], + 'table_header': [ + 'Value', + 'Description' + ] + }, + 'lv_property': 'Signal Path:Fractional Resample Enabled', + 'name': 'ENABLE_FRACTIONAL_RESAMPLING', + 'type': 'ViBoolean' + }, + 1150072: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies a comma-separated list of the terminals at which to export the Reference Clock.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_REF_OUT', + 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_REF_OUT2', + 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ], + [ + 'NIRFSA_VAL_IF_COND_REF_OUT', + 'Export the clock on the REF OUT terminal on the PXIe-5694. This value is valid only for the PXIe-5667.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceClockExportedTerminal', + 'lv_property': 'Clocking:Ref Clock Exported Terminal', + 'name': 'EXPORTED_REF_CLOCK_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150074: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device attenuation to a value that has the actual calibrated IF attenuation closest to the desired value.\n\n**Valid Values**: 0 to 30\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5663/5663E/5665/5667, PXIe-5693' + }, + 'lv_property': 'Signal Path:Advanced:NI 5663:IF Attenuation (dB)', + 'name': 'IF_ATTENUATION', + 'type': 'ViReal64' + }, + 1150080: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether dithering is enabled on the digitizer.\n\nDithering adds band-limited noise in the analog signal path to help reduce the quantization effects of the A/D converter and improve spectral performance. On the PXIe-5622, this out-of-band noise is added at low frequencies up to approximately 12 MHz. On the PXIe-5624, this out-of-band noise is added at low frequencies up to approximately 50 MHz.\n\n**PXIe-5663/5663E/5665/5667**: When you enable dithering, the maximum signal level is reduced by up to 3 dB. This signal level reduction is accounted for in the nominal input ranges of the PXIe-5622. Therefore, you can overrange the input by up to 3 dB with dither disabled. For example, the +4 dBm input range can handle signal levels up to +7 dBm with dither disabled. For wider bandwidth acquisitions, such as 40 MHz, disable dithering to eliminate residual leakage of the dither signal into the lower frequencies of the IF passband, which starts at 12.5 MHz and ends at 62.5 MHz. This leakage can slightly raise the noise floor in the lower frequencies, thus degrading the performance in high-sensitivity applications. When taking spectral measurements, this leakage can also appear as a wide, low-amplitude signal near 12.5 MHz and 62.5 MHz. The width and amplitude of the signal depends on your resolution bandwidth and the type of time-domain window you apply to your FFT.\n\n**PXIe-5668**: When you enable dithering, the maximum signal level is reduced by up to 2 dB. For the PXIe-5624, the maximum input power with dither off is 8 dBm and the maximum input power with dither on is 6 dBm. When acquiring an 800 MHz bandwidth signal, the I/Q data contains the dither even if the dither signal is not in the displayed spectrum. The dither can affect actions like power level triggering.\n\n----\n**Note**\nFor the PXIe-5668, disabling dithering can negatively affect absolute amplitude accuracy.\n\n----\n\n----\n**Note**\nFor the PXIe-5820/5830/5831/5832/5840/5841/5842, only NIRFSA_VAL_ENABLED is supported.\n\n----\n\n**Default Value**: NIRFSA_VAL_ENABLED\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables dither on the digitizer.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables dither on the digitizer.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DigitizerDitherEnabled', + 'lv_property': 'Signal Path:Digitizer Dither Enabled', + 'name': 'DIGITIZER_DITHER_ENABLED', + 'type': 'ViInt32' + }, + 1150082: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Enables in-band retuning and specifies the current frequency, in hertz (Hz), of the RF downconverter. \n\nIf you set this attribute, any measurements outside the instantaneous bandwidth of the device are invalid. To disable in-band retuning, reset the attribute or call the nirfsa_ResetDevice function.\n\nAfter you set this attribute, the downconverter is locked to that frequency until the value is changed or the attribute is reset. Locking the downconverter to a fixed value allows frequencies within the instantaneous bandwidth of the downconverter to be measured with minimal overhead, decreasing tuning time.\n\n**Valid Values**: Any supported tuning frequency of the device\n\n**PXIe-5820**: The only valid value for this attribute is 0 Hz.\n\n**Default Value**:\n\n**PXIe-5694**: The default value for the PXIe-5694 is 193.6 MHz unless you set the NIRFSA_ATTR_SIGNAL_CONDITIONING_ENABLED attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED, in which case the default value is 187.5 MHz.\n\n**All other devices**: The carrier frequency or spectrum center frequency. NI-RFSA sets this attribute to the default value based on the value of the NIRFSA_ATTR_ACQUISITION_TYPE attribute.\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842' + }, + 'lv_property': 'Acquisition:Advanced:Downconverter Center Frequency', + 'name': 'DOWNCONVERTER_CENTER_FREQUENCY', + 'type': 'ViReal64' + }, + 1150085: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the digitizer onboard memory size, in bytes.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Memory Size', + 'name': 'MEMORY_SIZE', + 'type': 'ViInt64' + }, + 1150086: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the center frequency of the IF output signal that corresponds to the configured RF center frequency.\n\nThe downconverter translates the RF input frequency to the IF output frequency by mixing it with the LO signal. The nominal values for the IF output frequency are shown in the following table.\n\nThe coarse nature of the LO settings can cause the downconverter to be unable to tune to the exact LO frequency that would produce the nominal IF output frequency. Any coercion in the actual LO frequency results in the IF output frequency being slightly off from the nominal value.\n\nAdditionally, if you use the NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY and NIRFSA_ATTR_LO_FREQUENCY attributes to program the downconverter, the IF output frequency could vary from the nominal value. NI-RFSA adjusts the acquired spectrum or I/Q data for the difference between nominal and actual IF output frequency. If you use an external digitizer with a RF downconverter, use this attribute to specify the actual IF output frequency.\n\n**Default Value**: N/A\n\n**Supported Devices**:PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694', + 'table_body': [ + [ + 'PXI-5600', + '15 MHz' + ], + [ + 'PXIe-5601', + '53 MHz or 187.5 MHz' + ], + [ + 'PXIe-5603', + '187.5 MHz or 199 MHz' + ], + [ + 'PXIe-5605', + '187.5 MHz, 190 MHz, or 199 MHz' + ], + [ + 'PXIe-5606', + '187.5 MHz, 190 MHz, 199 MHz, 507.5 MHz, or 730 MHz' + ], + [ + 'PXIe-5694', + '- signal_conditioning_enabled set to SIGNAL_CONDITIONING_ENABLED and if_conditioning_down_conversion_enabled set to disabled: 193.6 MHz
- if_conditioning_down_conversion_enabled set to enabled: 21.4 MHz
- signal_conditioning_enabled set to SIGNAL_CONDITIONING_BYPASSED: 162.5 MHz to 212.5 MHz' + ] + ], + 'table_header': [ + 'Downconverter', + 'Nominal IF Output Frequency' + ] + }, + 'lv_property': 'Acquisition:Advanced:IF Output Frequency', + 'name': 'IF_OUTPUT_FREQUENCY', + 'type': 'ViReal64' + }, + 1150087: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the delay duration units and interpretation for LO settling. \n\nSpecify the actual settling value using the NIRFSA_ATTR_FREQUENCY_SETTLING attribute. This attribute is not supported if you are using an external LO.\n\n**Default Value**: NIRFSA_VAL_FSU_PPM\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_FSU_PPM', + 'Specifies the frequency settling time in parts per million (PPM).' + ], + [ + 'NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK', + 'Specifies the frequency settling in time after lock (seconds).' + ], + [ + 'NIRFSA_VAL_FSU_SECONDS_AFTER_IO', + 'Specifies the frequency settling time after I/O (seconds).' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'FrequencySettlingUnits', + 'lv_property': 'Signal Path:Advanced:Frequency Settling Units', + 'name': 'FREQUENCY_SETTLING_UNITS', + 'type': 'ViInt32' + }, + 1150088: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the value used for local oscillator (LO) frequency settling. \n\nThe units and interpretation for this scalar value are specified using the NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS attribute. This attribute is not supported if you are using an external LO.\n\nThe valid values for this attribute depend on the NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n**Notes:**\n1. If the frequency settling units attribute is set to NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK and the downconverter loop bandwidth attribute is set to narrow, NI recommends a minimum settling time of 128 microseconds to ensure that the phase-locked loop (PLL) lock stabilizes. If the downconverter loop bandwidth is set to wide, NI recommends a minimum settling time of 16 microseconds.\n2. When in RF list mode, the valid values for NIRFSA_VAL_FSU_SECONDS_AFTER_IO are 0 microseconds to 50 milliseconds.\n3. The valid values for this configuration depend on the module used as the LO source. Refer to the lo source attribute for more information.\n\n**Default Value**: 0.1\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842', + 'table_body': [ + [ + 'PXIe-5663/5663E', + '2 microseconds1 to 80 milliseconds, resolution of approximately 2 microseconds', + '0 microseconds to 80 milliseconds2, resolution of 1 microsecond', + '1.0, 0.1, 0.01' + ], + [ + 'PXIe-5665/5667/5668', + '4 microseconds to 80 milliseconds, resolution of approximately 4 microseconds', + '0 microseconds to 80 milliseconds2, resolution of 1 microsecond', + '1.0, 0.1, 0.01, 0.001' + ], + [ + 'PXIe-5644/5645/5646', + '1 microsecond1 to 65 milliseconds, resolution of 1 microsecond', + '1 microsecond1 to 65 milliseconds, resolution of 1 microsecond', + '1.0, 0.1, 0.01' + ], + [ + 'PXIe-5830/5831/5832/5840/5841/5842', + '1 microsecond1 to 10 seconds, resolution of 1 microsecond', + '0 microseconds to 10 seconds, resolution of 1 microsecond', + '1.0 to 0.01' + ], + [ + 'PXIe-5831/5832 with PXIe-5653 (using PXIe-3622 LO)3', + '1 microsecond1 to 10 seconds, resolution of 1 microsecond', + '0 microseconds to 10 seconds, resolution of 1 microsecond', + '1.0 to 0.01' + ], + [ + 'PXIe-5831/5832 with PXIe-5653 (using PXIe-5653 LO)3', + '4 microseconds to 80 milliseconds, resolution of approximately 4 microseconds', + '0 microseconds to 80 milliseconds, resolution of 1 microsecond', + '1.0 to 0.01' + ] + ], + 'table_header': [ + 'Device', + 'NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK', + 'NIRFSA_VAL_FSU_SECONDS_AFTER_IO', + '%enum_value{frequency settling units.fsu ppm}' + ] + }, + 'lv_property': 'Signal Path:Advanced:Frequency Settling', + 'name': 'FREQUENCY_SETTLING', + 'type': 'ViReal64' + }, + 1150089: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the current temperature, in degrees Celsius, of the LO module.\n\n**PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode) PXI-5661, PXIe-5663/5663E/5665/5667/5668** This attribute is not supported if you are using an external LO.\n\n**PXIe-5840/5841/5842**: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode) PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5840/5841/5842' + }, + 'lv_property': 'Device Characteristics:LO Temperature (Degrees C)', + 'name': 'LO_TEMPERATURE', + 'type': 'ViReal64' + }, + 1150090: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the current temperature, in degrees Celsius, of the digitizer module.\n\n**PXIe-5820/5840/5841/5842**: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842' + }, + 'lv_property': 'Device Characteristics:Digitizer Temperature (Degrees C)', + 'name': 'DIGITIZER_TEMPERATURE', + 'type': 'ViReal64' + }, + 1150091: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the revision of the RF downconverter module.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5840/5841, this attribute returns the revision of the VST module. For the PXIe-5830/5831/5832, this attribute returns the revision of the PXIe-3621/3622\n\n----\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Module Revision', + 'name': 'MODULE_REVISION', + 'type': 'ViString' + }, + 1150094: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the gain, in dB, of a switch (or cable) connected before the RF IN connector of an NI-RFSA system. \n\nWhen you set this attribute, NI-RFSA calculates appropriate attenuator settings based on the value of this attribute and the value of the NIRFSA_ATTR_REFERENCE_LEVEL attribute. In this case, NI-RFSA interprets the reference level as the maximum expected power level of the signal at the input of the external gain device. For more information about attenuation, refer to the *Attenuation and Signal Levels* topic for your device in the *NI RF Vector Signal Analyzers Help*.\n\n----\n**Note**\nFor the PXIe-5820, this attribute specifies the gain, in dB, of a switch (or cable) connected before the IQ IN connector.\n\n----\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the I/Q ports.\n\n----\n\nWith this attribute set, NI-RFSA reads the NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_LEVEL attribute value as the power level at the input of the external gain device at which the NI-RFSA device should trigger.\n\nNegative values indicate attenuation.\n\n**Valid Values**: INF to +INF\n\n**Units**: dB\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:External Gain (dB)', + 'name': 'EXTERNAL_GAIN', + 'type': 'ViReal64' + }, + 1150106: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the offset to apply to the initial I and Q phases.\n\n**Valid Values**: 0 to 180\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842' + }, + 'lv_property': 'Acquisition:IQ:Phase Offset', + 'name': 'PHASE_OFFSET', + 'type': 'ViReal64' + }, + 1150117: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/ReadyForStartEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/ReadyForStartEvent, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/ReadyForStartEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/ReadyForStartEvent, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Events:Ready For Start:Terminal Name', + 'name': 'READY_FOR_START_EVENT_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150118: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/ReadyForAdvanceEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/ReadyForAdvanceEvent, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/ReadyForAdvanceEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerNameReadyForAdvanceEvent, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Events:Ready For Advance:Terminal Name', + 'name': 'READY_FOR_ADVANCE_EVENT_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150119: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/ReadyForReferenceEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/ReadyForReferenceEvent, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/ReadyForReferenceEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/ReadyForReferenceEvent, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Events:Ready For Ref:Terminal Name', + 'name': 'READY_FOR_REF_EVENT_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150120: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/EndOfRecordEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/EndOfRecordEvent, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/EndOfRecordEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/EndOfRecordEvent, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Events:End Of Record:Terminal Name', + 'name': 'END_OF_RECORD_EVENT_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150121: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/DoneEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/DoneEvent, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/DoneEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/DoneEvent, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Events:Done:Terminal Name', + 'name': 'DONE_EVENT_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150122: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/StartTrigger, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/StartTrigger, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/StartTrigger, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/StartTrigger, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Triggers:Start:Terminal Name', + 'name': 'START_TRIGGER_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150123: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/RefTrigger, where *BasebandModule* is the name of your baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleName/ai/0/RefTrigger, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/RefTrigger, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/RefTrigger, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Triggers:Ref:Terminal Name', + 'name': 'REF_TRIGGER_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150124: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified signal name as a string.\n\n**Default Values**:\n\n**PXIe-5830/5831/5832**: /BasebandModule/ai/0/AdvanceTrigger, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n**PXIe-5820/5840/5841/5842**: /ModuleNameai/0/AdvanceTrigger, where *ModuleName* is the name of your device in MAX.\n\n**PXIe-5860**: /ModuleName/ai/ChannelNumber/AdvanceTrigger, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**All other devices**: /DigitizerName/AdvanceTrigger, where *DigitizerName* is the name associated with your digitizer module in MAX.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n**High-Level Functions**:\n\n- nirfsa_GetTerminalName' + }, + 'lv_property': 'Triggers:Advance:Terminal Name', + 'name': 'ADVANCE_TRIGGER_TERMINAL_NAME', + 'type': 'ViString' + }, + 1150125: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': "Specifies the instantaneous bandwidth of the device in hertz (Hz).\n\nThe instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration.\n\nSpecify the maximum instantaneous bandwidth needed for your measurement. NI-RFSA coerces the actual IF filter to use based on other measurement constraints such as the NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute and the NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED attribute.\n\nTo change the value that NI-RFSA uses for the maximum size of multispan acquisition subspans, use the NIRFSA_ATTR_FFT_WIDTH attribute.\n\n----\n**Note**\nIf your application uses the PXIe-5622 IF digitizer, your maximum device instantaneous bandwidth is constrained to 50 MHz or 25 MHz, depending on the digitizer option you purchased. If your application uses the PXIe-5624 digitizer, your maximum device instantaneous bandwidth is constrained by the hardware option you purchased and your FPGA image.\n\n----\n\n**PXI-5661**: The PXI-5600 RF downconverter instantaneous bandwidth is 20 MHz.\n\n**PXIe-5663/5663E**: Your maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use. Refer to the `PXIe-5601 RF Signal Downconverter Overview `_ for more information about instantaneous bandwidth.\n\n----\n**Note**\nFor the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the instantaneous bandwidth for frequencies above 120 MHz is different than the instantaneous bandwidth for frequencies less than 120 MHz, which are 20 MHz and 10 MHz respectively.\n\n----\n\n**PXIe-5665**: Your maximum allowed instantaneous bandwidth is independent of the downconverter center frequency. Refer to the *NI PXIe-5665 Specifications* for more information about instantaneous bandwidth.\n\n**PXIe-5665 (14 GHz), PXIe-5668**: If you have enabled the preselector for the PXIe-5605/5606, the device instantaneous bandwidth value is only a typical specification. For multispan acquisitions, NI-RFSA uses this typical specification as the maximum size for the acquisition subspans.\n\n----\n**Note**\nWhen used with an external digitizer, the PXIe-5603 and the low band signal path of the PXIe-5605 provide a nominal 80 MHz bandwidth at dB. At frequencies greater than 3.6 GHz, the PXIe-5605 provides a typical bandwidth of 47 MHz at dB with the preselector (YIG-tuned filter) enabled.\n\n----\n\n----\n**Note**\nFor PXIe-5606 devices, the 765 MHz IF filter is available only at center frequencies above 3.6 GHz.\n\n----\n\n**PXIe-5693**: This attribute is read-only for the PXIe-5693. The value for the device instantaneous bandwidth depends on the value for the RF preselector filter.\n\n**PXIe-5694/PXIe-5667**: If your application uses the PXIe-5694 as part of an PXIe-5667 spectrum monitoring receiver or the PXIe-5694 as a stand-alone device, NI-RFSA determines the appropriate IF filter to use based on the value that you set for this attribute.\n\n----\n**Note**\n\n----\n\n**PXIe-5644/5645/5646**: This attribute is read-only for the PXIe-5644/5645/5646. Refer to the specifications document for your device for more information about instantaneous bandwidth.\n\n**PXIe-5840/5841/5860**: Your maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use. Refer to the *PXIe-5840/5841/5860 Specifications* for more information about instantaneous bandwidth. Set this attribute to select different device instantaneous bandwidths for a given downconverter center frequency. The device instantaneous bandwidth that you select is greater than or equal to the requested instantaneous bandwidth. If this attribute is not set, NI-RFSA uses the maximum allowed instantaneous bandwidth.\n\n**PXIe-5842**: Your maximum allowed instantaneous bandwidth depends on the device's hardware options, configured device personality, and the downconverter center frequency you use. Refer to the *PXIe-5842 Specifications* for more information about instantaneous bandwidth. Set this attribute to select different device instantaneous bandwidths for a given downconverter center frequency. The device instantaneous bandwidth that you select is greater than or equal to the requested instantaneous bandwidth. If this attribute is not set, NI-RFSA uses the maximum allowed instantaneous bandwidth.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_" + }, + 'lv_property': 'Acquisition:Device Instantaneous Bandwidth (Hz)', + 'name': 'DEVICE_INSTANTANEOUS_BANDWIDTH', + 'type': 'ViReal64' + }, + 1150127: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of dB by which to adjust the device mixer level. \n\nThe default value is 0, which specifies device settings that are the best compromise between distortion and noise. Specifying a positive value for this attribute configures the device for moderate distortion and low noise, and specifying a negative value results in low distortion and higher noise.\n\nYou cannot set the NIRFSA_ATTR_MIXER_LEVEL and NIRFSA_ATTR_MIXER_LEVEL_OFFSET attributes at the same time.\n\n**PXIe-5667**: This attribute is read-only when the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute is set to NIRFSA_VAL_DISABLED.\n\n**Units**: dB\n\n**Default Value**: 0\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:Mixer Level Offset (dB)', + 'name': 'MIXER_LEVEL_OFFSET', + 'type': 'ViReal64' + }, + 1150128: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the level of mechanical attenuation for the RF path, in dB.\n\n**PXIe-5667**: This attribute is read-only when the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute is set to NIRFSA_VAL_DISABLED.\n\n**PXIe-5668with PXIe-5698**: This attribute is read-only when the NIRFSA_ATTR_RF_PREAMP_ENABLED attribute is set to NIRFSA_VAL_RF_PREAMP_ENABLED.\n\n**Units**: dB\n\n**Valid Values:**\n\n**PXIe-5601/5663/5663E**: 0, 16\n\n**PXIe-5603/5665 (3.6 GHz)**: 0, 10, 20, 30\n\n**PXIe-5605/5665 (14 GHz), PXIe-5606/5668**: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector low frequency bypass path**: 0, 10, 20, 30\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector filter path**: 0\n\n**PXIe-5667 (7 GHz) using the PXIe-5693 RF preselector low frequency bypass path**: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75\n\n**PXIe-5667 (7 GHz) using the PXIe-5693 RF preselector filter path**: 0\n\n**PXIe-5668 with PXIe-5698 with the** NIRFSA_ATTR_RF_PREAMP_ENABLED attribute set to NIRFSA_VAL_RF_PREAMP_ENABLED: 5\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:Advanced:Mechanical Attenuation (dB)', + 'name': 'MECHANICAL_ATTENUATION', + 'type': 'ViReal64' + }, + 1150129: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the RF preamplifier is enabled in the system.\n\n**PXIe-5667, PXIe-5644/5645/5646, PXIe-5830/5831/5840/5841/5842**: The NIRFSA_VAL_RF_PREAMP_AUTOMATIC value enables the RF preamplifier based on the value of the NIRFSA_ATTR_REFERENCE_LEVEL attribute and the center frequency. Except on the PXIe-5830/5831/5832, NI-RFSA coerces this attribute from NIRFSA_VAL_RF_PREAMP_AUTOMATIC to the selected value.\n\n----\n**Note**\nFor the PXIe-5840/5841, the automatically selected value may not be optimal for all measurements. At some reference levels, NIRFSA_VAL_RF_PREAMP_ENABLED may improve the noise floor while NIRFSA_VAL_RF_PREAMP_DISABLED may improve distortion.\n\n----\n\n**PXIe-5667**: The NIRFSA_VAL_RF_PREAMP_AUTOMATIC value is supported only when the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute is set to NIRFSA_VAL_RF_PREAMP_DISABLED. If the reference level is greater than -25 dBm, NI-RFSA disables the preamplifier. If the reference level is less than or equal to -25 dBm, NI-RFSA sets the NIRFSA_ATTR_RF_PREAMP_ENABLED attribute to NIRFSA_VAL_RF_PREAMP_ENABLED_WHEN_IN_SIGNAL_PATH.\n\n**PXIe-5668 with PXIe-5698**: If you set this attribute to NIRFSA_ATTR_RF_PREAMP_ENABLED, only the preamplifier on the PXIe-5698 is used, and the preamplifier on the PXIe-5668 remains disabled.\n\n**Default Value**:\n\n**PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842**: NIRFSA_VAL_RF_PREAMP_AUTOMATIC\n\n**All other devices**: NIRFSA_VAL_RF_PREAMP_DISABLED\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5698, PXIe-5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_RF_PREAMP_DISABLED', + 'Disables the RF preamplifier.' + ], + [ + 'NIRFSA_VAL_RF_PREAMP_ENABLED_WHEN_IN_SIGNAL_PATH', + 'Enables the RF preamplifier when the RF preamplifier is present in the signal path and disables the preamplifier when it is not in the signal path. Only devices with an RF preamplifier on the downconverter and an RF preselector support this option. Use the NIRFSA_ATTR_RF_PREAMP_PRESENT attribute to determine whether the downconverter has a preamplifier.' + ], + [ + 'NIRFSA_VAL_RF_PREAMP_ENABLED', + 'Enables the RF preamplifier. If the RF preamplifier is not in a signal path, NI-RFSA returns an error. Select the NIRFSA_VAL_RF_PREAMP_ENABLED_WHEN_IN_SIGNAL_PATH value whenever possible to avoid an error.' + ], + [ + 'NIRFSA_VAL_RF_PREAMP_AUTOMATIC', + 'Automatically enables the RF preamplifier based on the value of the NIRFSA_ATTR_REFERENCE_LEVEL attribute. This value is valid only for the PXIe-5644/5645/5646, PXIe-5667, and PXIe-5830/5831/5832/5840/5841.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'EnableRfPreamp', + 'lv_property': 'Vertical:Advanced:Preamp Enabled', + 'name': 'RF_PREAMP_ENABLED', + 'type': 'ViInt32' + }, + 1150130: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the level of the IF signal leaving the system, in dBm. \n\nUse this attribute to increase or decrease the nominal IF signal output level to achieve better measurement results.\n\nIf you set the NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL and NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL_OFFSET attributes at the same time, NI-RFSA returns an error.\n\n----\n**Note**\nIf you set the NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL attribute to a value less than 201310 dBm, the IF output power level may be higher than the value you request. Read the value of this attribute to determine the configured IF output power level.\n\n----\n\n----\n**Note**\nThe value of this attribute is limited by the amount of IF attenuation that the downconverter can apply, the NIRFSA_ATTR_REFERENCE_LEVEL attribute, the NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attribute, and the NIRFSA_ATTR_CENTER_FREQUENCY attribute or NIRFSA_ATTR_IQ_CARRIER_FREQUENCY attribute, depending on your acquisition type.\n\n----\n\n**Units**: dBm\n\n**Default Value**:\n\n**PXIe-5667**: -2 dBm\n\n**PXIe-5668**: -1 dBm\n\n**All other devices**: dBm\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694' + }, + 'lv_property': 'Vertical:IF Output Power Level (dBm)', + 'name': 'IF_OUTPUT_POWER_LEVEL', + 'type': 'ViReal64' + }, + 1150131: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the number of dB by which to adjust the default IF output power level. \n\nThis attribute does not depend on absolute IF output power levels, so you can use it to adjust the IF output power level on all NI-RFSA devices without knowing the exact default value. Use this attribute to increase or decrease the nominal output level to achieve better measurement results. The default value for the offset is 0 dB.\n\nIf you set the NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL and NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL_OFFSET attributes at the same time, NI-RFSA returns an error.\n\n**Units**: dB\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:IF Output Power Level Offset (dB)', + 'name': 'IF_OUTPUT_POWER_LEVEL_OFFSET', + 'type': 'ViReal64' + }, + 1150132: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the tunable preselector is enabled on the downconverter.\n\n----\n**Note**\nAll devices support setting this attribute to NIRFSA_VAL_PRESELECTOR_DISABLED or NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH. Only devices with a preselector support setting this attribute to NIRFSA_VAL_PRESELECTOR_ENABLED.\n\n----\n\n**Default Value**: NIRFSA_VAL_PRESELECTOR_DISABLED if the device has no preselector. NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH if the device has a preselector.\n\n**Supported Devices:** PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_PRESELECTOR_DISABLED', + 'Disables the preselector.' + ], + [ + 'NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH', + 'The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the NIRFSA_ATTR_PRESELECTOR_PRESENT attribute to determine if the downconverter has an preselector.' + ], + [ + 'NIRFSA_VAL_PRESELECTOR_ENABLED', + 'Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH whenever possible avoid an error.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DownconverterPreselectorEnabled', + 'lv_property': 'Signal Path:Advanced:Downconverter Preselector Enabled', + 'name': 'DOWNCONVERTER_PRESELECTOR_ENABLED', + 'type': 'ViInt32' + }, + 1150134: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to enable the LO OUT terminals on the installed devices.\n\n**PXIe-5601**: The only valid value for this attribute is VI_TRUE.\n\n**PXIe-5603/5605/5606**: If you want to daisy-chain multiple devices together using the same LO source, set this attribute to TRUE to export the LO input signals on the LO1 IN, LO2 IN, and LO3 IN terminals to LO1 OUT, LO2 OUT, and LO3 OUT, respectively.\n\n**PXIe-5694**: You can enable this attribute only if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_LO_IN, or if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_ONBOARD and the NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED attribute to NIRFSA_VAL_ENABLED.\n\n**PXIe-5830/5831**: To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViBoolean function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the only valid value for the channel string is "" (empty string).\n\n----\n**Note**\nIf you are sharing an LO for the PXIe-5830/5831/5832 between an NI-RFSA and NI-RFSG session, ensure both sessions use the same shared setting.\n\n----\n\n**Defined Values:**\n\n| Value | Description |\n|:---------|:-------------------------------|\n| VI_TRUE | Enables the LO OUT terminals. |\n| VI_FALSE | Disables the LO OUT terminals. |\n\n**Default Values**:\n\n**PXIe-5601, PXIe-5663/5663E**: VI_TRUE\n\n**PXIe-5603/5605/5606, PXIe-5644/5645/5646, PXIe-5665/5667/5668, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842**: VI_FALSE\n\n**Supported Devices**: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842' + }, + 'lv_property': 'Signal Path:LO Export Enabled', + 'name': 'LO_EXPORT_ENABLED', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViBoolean' + }, + 1150135: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Adjusts the dynamics of the current driving the YIG main coil.\n\n----\n**Note**\nSetting this attribute to NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_FAST allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise. This attribute is not supported if you are using an external LO.\n\n----\n\n**Default Value**: NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_NORMAL\n\n**Supported Devices:** PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5667/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_NORMAL', + 'Adjusts the YIG main coil on the LO for an underdamped response.' + ], + [ + 'NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_FAST', + 'Adjusts the YIG main coil on the LO for an overdamped response.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoYigMainCoilDrive', + 'lv_property': 'Signal Path:Advanced:LO YIG Main Coil Drive', + 'name': 'LO_YIG_MAIN_COIL_DRIVE', + 'type': 'ViInt32' + }, + 1150136: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns whether a preselector is available on the RF downconverter module.\n\n**Defined Values**:\n\n| Value | Description |\n|:---------|:--------------------------------------------------|\n| VI_TRUE | A preselector is available on the downconverter. |\n| VI_FALSE | No preselector is available on the downconverter. |\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842' + }, + 'lv_property': 'Device Characteristics:Preselector Present', + 'name': 'PRESELECTOR_PRESENT', + 'type': 'ViBoolean' + }, + 1150137: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns whether an RF preamplifier is available on the RF downconverter module.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'VI_TRUE', + 'The device has an enabled RF preamplifier available.' + ], + [ + 'VI_FALSE', + 'The device has no RF preamplifier available.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Device Characteristics:RF Preamp Present', + 'name': 'RF_PREAMP_PRESENT', + 'type': 'ViBoolean' + }, + 1150142: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the minimum adjacent channel power ratio (ACPR), in dB, relative to the main channel reference level. \n\nThis attribute configures NI-RFSA to optimize downconverter gain to measure a lower-power adjacent channel, adding gain only after filtering the main channel. The gain NI-RFSA applies is always less than or equal to the ACPR value you specify.\n\n----\n**Note**\nFor the PXIe-5665 (3.6 GHz), this attribute is supported only if you set the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH, NIRFSA_ATTR_SPECTRUM_SPAN, or NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute to a value less than 300 kHz. For the PXIe-5665 (14 GHz), this attribute is supported for NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH, NIRFSA_ATTR_SPECTRUM_SPAN, or NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute values less than 300 kHz by using the 300 kHz IF filter, and it is supported for values between 300 kHz and 5 MHz by using the 5 MHz IF filter.\n\n----\n\n----\n**Note**\nNI-RFSA coerces this attribute to zero for the PXI-5600, PXIe-5601 and the PXIe-5667. For all other devices, read the coerced value of this attribute to determine the actual amount of gain applied.\n\n----\n\n----\n**Note**\nFor the PXIe-5668, this attribute alters the NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL attribute. This attribute will not affect the NIRFSA_ATTR_REFERENCE_LEVEL attribute.\n\n----\n\n**Default Value**: 0\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:Advanced:Minimum Adjacent Channel Power Ratio (dB)', + 'name': 'MINIMUM_ACPR', + 'type': 'ViReal64' + }, + 1150144: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the oversampling ratio used by the digitizer onboard signal processing (OSP) when you are in spectrum acquisition mode. This attribute allows you to acquire a larger bandwidth in hardware and reduce that bandwidth in software, decreasing the possibility of hardware data path overflows.\n\n**PXIe-5644/5645/5646**: The only valid value for this attribute is 1.\n\n**Default Value**: 1.0\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:Spectrum OSP Sampling Ratio', + 'name': 'SPECTRUM_OSP_SAMPLING_RATIO', + 'type': 'ViReal64' + }, + 1150149: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the RF IN connector is AC- or DC-coupled on the downconverter.\n\n----\n**Note**\nFor the PXIe-5605/5606/5665/5667/5668, this attribute must be set to NIRFSA_VAL_AC when the DC block is present and set to NIRFSA_VAL_DC when the DC block is not present to ensure device specifications are met and proper calibration data is used. For more information about removing or attaching the DC block, refer to the `PXIe-5665 Block Diagram `_, the `PXIe-5605 Front Panel and LEDs `_, the `PXIe-5667 Block Diagram `_, or the `PXIe-5668 Block Diagram `_ topics in this help file.\n\n----\n\n**Valid Values**:\n\n**PXIe-5603/5665 (3.6 GHz)**: NIRFSA_VAL_AC, NIRFSA_VAL_DC\n\n**PXIe-5605/5665 (14 GHz)**: NIRFSA_VAL_AC, NIRFSA_VAL_DC\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector low-frequency bypass path**: NIRFSA_VAL_AC, NIRFSA_VAL_DC\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector filter path**: NIRFSA_VAL_AC\n\n**PXIe-5667 (7 GHz)**: NIRFSA_VAL_AC\n\n**PXIe-5606/5668**: NIRFSA_VAL_AC, NIRFSA_VAL_DC\n\n**Default Value**: NIRFSA_VAL_AC\n\n**Supported Devices**: PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5667/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_AC', + 'Specifies that the RF input channel is AC-coupled. For low frequencies (<10 MHz), accuracy decreases because NI-RFSA does not calibrate the configuration.' + ], + [ + 'NIRFSA_VAL_DC', + 'Specifies that the RF input channel is DC-coupled. NI-RFSA enforces a minimum RF attenuation for device protection.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ChannelCoupling', + 'lv_property': 'Vertical:Advanced:NI 5665/5667/5668R:Channel Coupling', + 'name': 'CHANNEL_COUPLING', + 'type': 'ViInt32' + }, + 1150151: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the scaling factor applied to the time-domain voltage data in the IF digitizer. \n\nUse this attribute to maximize the dynamic range of the digitizer by increasing the maximum IF power the digitizer can measure without creating OSP overflows.\n\nBecause of the device amplitude response, some wide-band signals normally attenuated by the downconverter go through the IF digitizer without causing an ADC overflow. During IF equalization, these wide-band digitizer input signals may become amplified. These amplified input signal values overflow the available numeric range used in the signal processing algorithm.\n\nYou can use this attribute when OSP calculations would generate an overflow while applying digital filters to the data. The OSP module in the digitizer multiplies the time-domain signal amplitude, in volts, by the specified attribute value before further onboard processing. Set this attribute to a value less than 1 to avoid OSP overflow for near full-scale IF signals and to use the maximum dynamic range of the digitizer. NI-RFSA compensates for the specified OSP data scaling factor to ensure that the correct scaled data, in absolute levels, is always returned regardless of the value of this attribute.\n\n**Valid Values:**: 0.25 to 1.0\n\n**Default Values:**\n\n**PXI-5661, PXIe-5663/5663E/5665 (3.6 GHz)/5667 (3.6 GHz)/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: 1.0\n\n**PXIe-5665 (14 GHz)/5667 (7 GHz)**: 0.8\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:OSP Data Scaling Factor', + 'name': 'OSP_DATA_SCALING_FACTOR', + 'type': 'ViReal64' + }, + 1150154: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to allow the device to acquire more records than can fit in the device memory of the PXIe-5622/5624.\n\n----\n**Note**\nIf you set the attribute to FALSE and attempt to acquire more records than can fit into the PXIe-5622/5624 device memory, NI-RFSA returns an error. If this attribute is set to TRUE, NI-RFSA returns an error only in the event of an acquisition buffer overflow.\n\n----\n\n----\n**Note**\nThis attribute is always set to VI_TRUE for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841.\n\n----\n\n**Default Value**: VI_FALSE\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'VI_TRUE', + 'Allows acquisition of more records than fit in device memory.' + ], + [ + 'VI_FALSE', + 'Does not allow acquisitions of more records than fit in device memory.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'lv_property': 'Acquisition:IQ:Allow More Records Than Memory', + 'name': 'ALLOW_MORE_RECORDS_THAN_MEMORY', + 'type': 'ViBoolean' + }, + 1150155: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the step size for the RF attenuation level. \n\nThe actual RF attenuation is coerced up to the next highest multiple of this step size. You can also set this value to change the step size for the device within the supported device precision and configuration.\n\n**PXI-5600**: The device configuration supports only the following attenuation step size values: 10, 20, 30, 40, and 50.\n\n**PXIe-5601**: The attenuation is calculated based on the actual calibrated value closest to the desired value, so the step size varies as the actual gain values vary between consecutive attenuation settings.\n\n**PXIe-5603**: The device configuration supports attenuation changes in 1 dB steps.\n\n**PXIe-5605**: The available attenuation step size depends on the specified center frequency. In the high band signal path (input frequencies greater than 3.6 GHz), the only available attenuation is the step attenuator that you can change in 5 dB steps. In the low band signal path (input frequencies less than or equal to 3.6 GHz), an additional 31 dB of solid-state attenuation is available in 1 dB steps. The 5 dB default value indicates that, even when in the low band signal path, NI-RFSA changes the attenuation in 5 dB steps using only the mechanical attenuator. You can use this attribute to affect when the device changes the attenuation settings. To use the solid-state attenuation in the low band signal path, change the step size to a value other than a multiple of 5 (for example, a step size of 1 dB). If you use a value other than a multiple of 5 while in the high band of the PXIe-5605, NI-RFSA returns an error.\n\n**Units**: dB\n\n**Valid Values:**\n\n**PXI-5600/5661**: 10, 20, 30, 40, and 50\n\n**PXIe-5601/5663/5663E**: 0.0 to 93.0, continuous\n\n**PXIe-5603/5665 (3.6 GHz)**: 1.0 to 74.0, in 1 dB steps\n\n**PXIe-5605/5665 (14 GHz) (low band), PXIe-5606/5668 (low band)**: 1.0 to 106.0, in 1 dB steps\n\n**PXIe-5605/5665 (14 GHz) (high band), PXIe-5606/5668 (high band)**: 5.0 to 75.0, in 5 dB steps\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector low frequency bypass path**: 1.0 to 74.0, in 1 dB steps\n\n**PXIe-5667 (3.6 GHz) using the PXIe-5693 RF preselector filter path**: 1.0\n\n**PXIe-5667 (7 GHz) using the PXIe-5693 preselector low frequency bypass path**: 1.0 to 106.0 in 1 dB steps\n\n**PXIe-5667 (7 GHz) using the PXIe-5693 RF preselector filter path**: 1.0\n\n**Default Value:**\n\n**PXI-5600/5661**: 10.0\n\n**PXIe-5601/5663/5663E**: 0.0\n\n**PXIe-5603/5665 (3.6 GHz)**: 1.0\n\n**PXIe-5605/5665 (14 GHz), PXIe-5606/5668**: 5.0\n\n**PXIe-5667**: 1.0\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668' + }, + 'lv_property': 'Vertical:Advanced:RF Attenuation Step Size (dB)', + 'name': 'RF_ATTENUATION_STEP_SIZE', + 'type': 'ViReal64' + }, + 1150159: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the temperature, in degrees Celsius, that NI-RFSA uses to calculate the device configuration settings.\n\n----\n**Note**\nFor most applications, you can choose not to set this attribute, so NI-RFSA uses the device temperature to calculate best attenuation settings. Set this attribute only if you want NI-RFSA to maintain the same device configuration settings from acquisition to acquisition, independent of device temperature changes.\n\n----\n\n**PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: This attribute is read-only.\n\n**Units**: degrees Celsius\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:Device Configuration Temperature (Degrees C)', + 'name': 'DEVICE_CONFIGURATION_TEMPERATURE', + 'type': 'ViReal64' + }, + 1150160: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether all signal conditioning is enabled on the PXIe-5694.\n\n----\n**Note**\nIf you set this attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED, NI-RFSA bypasses all signal conditioning, prevents any signal downconversion, and fixes the values for NIRFSA_ATTR_DOWNCONVERTER_GAIN attribute, the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, and the NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute.\n\n----\n\n**Default Value**: NIRFSA_VAL_SIGNAL_CONDITIONING_ENABLED\n\n**Supported Devices**: PXIe-5694\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_SIGNAL_CONDITIONING_ENABLED', + 'Enables signal conditioning.' + ], + [ + 'NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED', + 'Bypasses all signal conditioning.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SignalConditioningEnabled', + 'lv_property': 'Signal Path:Advanced:NI 5694:Signal Conditioning Enabled', + 'name': 'SIGNAL_CONDITIONING_ENABLED', + 'type': 'ViInt32' + }, + 1150162: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the LO signal source used to downconvert the RF input signal.\n\n If no signal downconversion is required, this attribute is ignored. If this attribute is set to "" (empty string), NI-RFSA uses the internal LO source.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the only valid value for the channel string is "" (empty string).\n\n ----\n **Note**\n For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED.\n\n ----\n\n \n \n\n **Default Value**: NIRFSA_VAL_ONBOARD ("Onboard")\n\n **Supported Devices**: PXIe-5644/5645/5646, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'Specifies that no LO source is required to downconvert the RF input signal.' + ], + [ + 'NIRFSA_VAL_ONBOARD', + 'Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655.' + ], + [ + 'NIRFSA_VAL_LO_IN', + 'Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel.' + ], + [ + 'NIRFSA_VAL_LO_SOURCE_SECONDARY', + 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid on only the PXIe-5831 with PXIe-5653 (LO1 stage only) or PXIe-5832 with PCIe-5653 (LO1 stage only).' + ], + [ + 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED', + 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoSource', + 'lv_property': 'Signal Path:LO Source', + 'name': 'LO_SOURCE', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViString' + }, + 1150163: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the amplitude settling accuracy in decibels.\n\nNI-RFSA waits until the RF power settles within the specified accuracy level after calling the nirfsa_Initiate function.\n\nAny specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value.\n\n**Units**: dB\n\n**Default Value:** 0.5\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:Amplitude Settling', + 'name': 'AMPLITUDE_SETTLING', + 'type': 'ViReal64' + }, + 1150169: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the FFT width of the device. \n\nThe FFT width is the effective bandwidth of the signal path during each signal acquisition.\n\n----\n**Note**\nThe maximum FFT width when using the PXIe-5622 is constrained to 50 MHz or 25 MHz, depending on the digitizer option you purchased. The maximum FFT width when using thing PXIe-5624 is constrained to 400 MHz or 765 MHz, depending on the digitizer configuration.\n\n----\n\n----\n**Note**\nYou can use the NIRFSA_ATTR_FFT_WIDTH attribute with in-band retuning. For more information about in-band retuning, refer to the NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attribute.\n\n----\n\nNI-RFSA treats the *device instantaneous bandwidth* as the effective real-time bandwidth of the signal path. The *span* specifies the frequency range of the computed spectrum. An RF vector signal analyzer can acquire a bandwidth only within the device instantaneous bandwidth frequency. If the span you choose is greater than the device instantaneous bandwidth, NI-RFSA obtains multiple acquisitions and combines them into a single spectrum. By specifying the FFT width, you can control the specific bandwidth obtained in each signal acquisition. If you read the NIRFSA_ATTR_FFT_WIDTH attribute without setting it, NI-RFSA returns the value of the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute.\n\n**Valid Values**:\n\nThe lower limit for all FFT width supported devices using the PXIe-5622 IF digitizer is 7.325 kHz. The lower limit for all FFT width supported devices using the PXIe-5624 IF digitizer is 400 MHz or 800 MHz, depending on the FPGA image that is downloaded upon opening the session to the PXIe-5624 IF digitizer.\n\n**PXIe-5663/5663E**: The FFT width upper limit for the PXIe-5663/5663E depends on the downconverter center frequency and on the module revision of the PXIe-5601 as illustrated in the following table. Refer to the `Identifying Module Revision `_ topic for more information about determining which revision of the PXIe-5601 RF downconverter you have installed.\n\n**PXIe-5665/5667/5668**: The upper limit of the FFT width is the maximum device instantaneous bandwidth.\n\n----\n**Note**\n\n----\n\n----\n**Note**\nAt frequencies greater than 3.6 GHz, the PXIe-5605 provides a typical bandwidth of 47 MHz at dB with the preselector enabled. The NIRFSA_ATTR_FFT_WIDTH attribute can override the typical bandwidth of the PXIe-5605 up to 57 MHz using an external digitizer and up to 50 MHz or 25 MHz depending on the PXIe-5622 digitizer option you purchased. The increase in bandwidth results in faster signal acquisitions, but amplitude accuracy is decreased for spectrum acquisitions, and magnitude and phase accuracy is decreased for I/Q acquisitions. National Instruments does not guarantee device specifications if you set the NIRFSA_ATTR_FFT_WIDTH attribute greater than the warranted instantaneous bandwidth specification.\n\n----\n\n----\n**Note**\nWhen using the PXIe-5606, the 765 MHz IF filter is only available at center frequencies of 3.6 GHz and above.\n\n----\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668', + 'table_body': [ + [ + '10 MHz to <120 MHz', + '10 MHz', + '10 MHz (Revision E), 20 MHz< sup >* < /sup> (Revision G or later)' + ], + [ + '120 MHz to <330 MHz', + '20 MHz', + '20 MHz (Revision E), 30 MHz< sup > * < /sup> (Revision G or later)' + ], + [ + '330 MHz to <6.6 GHz', + '50 MHz', + '50 MHz' + ], + [ + ' * < / sup >National Instruments does not guarantee device specifications if you set the NIRFSA_ATTR_FFT_WIDTH attribute greater than the warranted instantaneous bandwidth specification.', + '', + '' + ] + ], + 'table_header': [ + 'Downconverter Center Frequency', + 'PXIe-5601 Instantaneous Bandwidth', + 'FFT Width Upper Limit' + ] + }, + 'lv_property': 'Acquisition:Spectrum:FFT Width', + 'name': 'FFT_WIDTH', + 'type': 'ViReal64' + }, + 1150170: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether input isolation is enabled.\n\nEnabling this attribute isolates the input signal at the RF IN connector on the RF downconverter from the rest of the RF downconverter signal path. Disabling this attribute reintegrates the input signal into the RF downconverter signal path.\n\n----\n**Note**\nIf you enable input isolation for your device, the device impedance is changed from the characteristic 50 impedance. A change in the device impedance may also cause a VSWR value higher than the device specifications.\n\n----\n\nFor the PXIe-5830/5831/5832, input isolation is supported for all available ports for your hardware configuration.\n\n**Default Value**: NIRFSA_VAL_DISABLED, if the device configuration is supported.\n\n**Supported Devices**: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5693, PXIe-5820/5830/5831/5832/5840/5841\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables input isolation.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables input isolation.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'InputIsolationEnabled', + 'lv_property': 'Signal Path:Advanced:Input Isolation Enabled', + 'name': 'INPUT_ISOLATION_ENABLED', + 'type': 'ViInt32' + }, + 1150180: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the connector(s) to use to acquire the signal. \n\nTo set this attribute, the NI-RFSA device must be in the Configuration state.\n\n**Default Values**:\n\n**PXIe-5820**: NIRFSA_VAL_IQ_IN\n\n**All other devices**: NIRFSA_VAL_RF_IN\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_RF_IN', + 'Enables the RF IN port.' + ], + [ + 'NIRFSA_VAL_IQ_IN', + 'Enables the I/Q IN port.' + ], + [ + 'NIRFSA_VAL_CAL_IN', + 'Enables the CAL IN port.' + ], + [ + 'NIRFSA_VAL_I_ONLY', + 'Enables the I terminals of the I/Q IN port. It is supported only for PXIe-5645.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'InputPort', + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Input Port', + 'name': 'INPUT_PORT', + 'type': 'ViInt32' + }, + 1150181: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the frequency of the signal. \n\nThe onboard signal processing (OSP) frequency shifts the signal at this frequency to baseband prior to acquiring it.\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the RF ports.\n\n----\n\n**Valid Values**:\n\n**PXIe-5645**: -60 MHz to +60 MHz\n\n**PXIe-5820**: -500 MHz to +500 MHz\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5645, PXIe-5820' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ In Port:Carrier Frequency', + 'name': 'IQ_IN_PORT_CARRIER_FREQUENCY', + 'type': 'ViReal64' + }, + 1150182: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the terminal configuration of the I/Q port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsa_SetAttributeViInt32 function to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to "" (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is "" (empty string).\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the RF ports.\n\n----\n\n**PXIe-5820**: The only valid value for this attribute is NIRFSA_VAL_DIFFERENTIAL.\n\n**Default Value**: NIRFSA_VAL_DIFFERENTIAL\n\n**Supported Devices:** PXIe-5645, PXIe-5820\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DIFFERENTIAL', + 'Sets the terminal configuration to differential.' + ], + [ + 'NIRFSA_VAL_SINGLE_ENDED', + 'Sets the terminal configuration to single-ended.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'IqInPortTerminalConfiguration', + 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ In Port:Terminal Configuration', + 'name': 'IQ_IN_PORT_TERMINAL_CONFIGURATION', + 'type': 'ViInt32' + }, + 1150183: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the voltage range for the I/Q terminals.\n\nTo use this attribute, you must use the channelName parameter of the nirfsa_SetAttributeViReal64 function to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to "" (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is "" (empty string).\n\nThe voltage range in differential terminal configuration is configurable from 2 Vpk-pk to 0.032 Vpk-pk in 1 dB steps. In single-ended terminal configuration, valid ranges are half those for differential. Values are always coerced up to the next valid range.\n\n----\n**Note**\nFor the PXIe-5645, this attribute is ignored if you are using the RF ports.\n\n----\n\n**Valid Values:**\n\n**PXIe-5645**: 0 Vpk-pk to 2 Vpk-pk for differential terminal configuration, 0 Vpk-pk to 1 Vpk-pk for single-ended terminal configuration.\n\n**PXIe-5820**: 0 Vpk-pk to 4 Vpk-pk for differential terminal configuration.\n\n**Default Value**: 2 Vpk-pk\n\n**Supported Devices:** PXIe-5645, PXIe-5820' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ In Port:Vertical Range', + 'name': 'IQ_IN_PORT_VERTICAL_RANGE', + 'type': 'ViReal64' + }, + 1150186: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the power level, in dBm, expected at the LO IN terminal when the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, this attribute is always read-only.\n\n----\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO In Power (dBm)', + 'name': 'LO_IN_POWER', + 'type': 'ViReal64' + }, + 1150187: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). \n\nFractional mode gives a finer frequency step resolution, but it may result in non harmonic spurs. Refer to the device specifications for your device for more information about fractional mode and non harmonic spurs.\n\n----\n**Note**\nThe NIRFSA_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is applicable only when using the internal LO.\n\n----\n\n----\n**Note**\nFor the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653, this attribute is ignored if the PXIe-5653 is used as the LO source. For the PXIe-5841 with PXIe-5655, this attribute is ignored if the PXIe-5655 is used as the LO source.\n\n----\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Value**: NIRFSA_VAL_ENABLED\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables fractional mode for the LO PLL.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables fractional mode for the LO PLL.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoPllFractionalModeEnabled', + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO PLL Fractional Mode Enabled', + 'name': 'LO_PLL_FRACTIONAL_MODE_ENABLED', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViInt32' + }, + 1150188: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL).\n\nYou can only tune the LO frequency by multiples of the NIRFSA_ATTR_LO_FREQUENCY_STEP_SIZE attribute. For the PXIe-5644/5645/5646 and PXIe-5840/5841, the LO frequency can therefore be offset from the requested center frequency by as much as half of the NIRFSA_ATTR_LO_FREQUENCY_STEP_SIZE attribute. This offset is corrected by digitally frequency shifting the NIRFSA_ATTR_LO_FREQUENCY attribute to the value requested in either the NIRFSA_ATTR_IQ_CARRIER_FREQUENCY attribute or the NIRFSA_ATTR_CENTER_FREQUENCY attribute.\n\n----\n**Note**\nFor the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653, this attribute is ignored if the PXIe-5653 is used as the LO source.\n\n----\n\nThe valid values for this attribute depend on the NIRFSA_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute.\n\n**PXIe-5644/5645/5646**: If the NIRFSA_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is set to NIRFSA_VAL_DISABLED, the specified value is coerced to the closest valid value.\n\n**PXIe-5840/5841/5842**: If the NIRFSA_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is set to NIRFSA_VAL_DISABLED, the specified value is coerced to the nearest valid value that is less than or equal to the desired step size.\n\n* Values up to 100 MHz are coerced to 50 MHz.\n\n----\n**Note**\nThe default value for the PXIe-5831 depends on the frequency range of the selected port for your instrument configuration. Refer to the `Instrument Configurations `_ topic for more information about available ports for your hardware configuration.\n\n----\n\n**Default Values:**\n\n**PXIe-5644/5645/5646:** 200 kHz\n\n**PXIe-5830:** 2 MHz\n\n**PXIe-5831/5832 (RF port):** 8 MHz\n\n**PXIe-5831/5832 (IF port):** 2 MHz, 4 MHz\n\n**PXIe-5840/5841:**\n\n- Fractional mode: 500 kHz\n- Integer mode: 10 MHz for frequencies less than or equal to 4 GHz. 20 MHz for frequencies greater than 4 GHz.\n\n**PXIe-5841 with PXIe-5655:** 500 kHz\n\n**PXIe-5842:** 1 Hz\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842', + 'table_body': [ + [ + 'NIRFSA_VAL_ENABLED', + '50 kHz to 24 MHz', + '50 kHz to 25 MHz', + '50 kHz to 100 MHz', + 'LO1: 8 Hz to 400 MHz\nLO2: 4 kHz to 400 MHz', + '1 nHz to 50 MHz' + ], + [ + 'NIRFSA_VAL_DISABLED', + '4 MHz, 5 MHz, 6 MHz, 12 MHz, 24 MHz', + '2 MHz, 5 MHz, 10 MHz, 25 MHz', + '1 MHz, 5 MHz, 10 MHz, 25 MHz, 50 MHz, 100 MHz', + 'LO1: --\nLO2: --', + '1 nHz to 50 MHz' + ] + ], + 'table_header': [ + 'lo_pll_fractional_mode_enabled', + 'PXIe-5644/5645', + 'PXIe-5646', + 'PXIe-5840/5841', + 'PXIe-5830/5831/5832', + 'PXIe-5841 w/PXIe-5655' + ] + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO Frequency Step Size (Hz)', + 'name': 'LO_FREQUENCY_STEP_SIZE', + 'type': 'ViReal64' + }, + 1150196: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether the digitizer OSP block delays Reference Triggers, along with the data samples, moving through the OSP block or if the Reference Triggers bypass the OSP block and are processed immediately.\n\nEnabling this attribute requires the following equipment configurations:\n\n- All digitizers being used must be the same model and hardware revision.\n- All digitizers must use the same firmware.\n- All digitizers must be configured with the same I/Q rate.\n- All devices must use the same signal path.\n\n**PXIe-5663/5663E**: Read the value of the NIRFSA_ATTR_IF_FILTER attribute to determine the IF filters used by the PXIe-5663/5663E.\n\n**PXIe-5665/5667/5668**:Refer to the device-specific information in the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute to determine the IF filters used by the PXIe-5665/5667/5668. If you set the NIRFSA_ATTR_FFT_WIDTH attribute, refer to the device-specific information for this attribute and the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute to determine the IF filters used. For frequencies less than 3.6 GHz, set the NIRFSA_ATTR_RF_PREAMP_ENABLED to the same value for all devices.\n\n**PXIe-5665 14 GHz**: Set the NIRFSA_ATTR_DOWNCONVERTER_PRESELECTOR_ENABLED to the same value for all devices.\n\nIf the I/Q rate is set programmatically for I/Q acquisitions, the following attributes should be identical for the best device synchronization:\n\n- NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED\n- NIRFSA_ATTR_SPECTRUM_OSP_SAMPLING_RATIO\n\nFor spectrum acquisitions, the following attributes should be identical for the best device synchronization:\n\n- NIRFSA_ATTR_SPECTRUM_SPAN\n- NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE\n- NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED\n- NIRFSA_ATTR_SPECTRUM_OSP_SAMPLING_RATIO\n\nFor more information about the digitizer OSP block and Reference Triggers, refer to the following topics in the *NI High-Speed Digitizers Help*:\n\n- NI 5622 Onboard Signal Processing (OSP)\n- NI 5142 Onboard Signal Processing (OSP)\n- NI PXIe-5622 Trigger Sources\n- NI PXI-5142 Trigger Sources\n- NI PXIe-5622 Block Diagram\n- NI PXI-5142 Trigger Sources\n\n**Default Value**: NIRFSA_VAL_ENABLED\n\n**Supported Devices**:PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables OSP delay for the Reference Trigger.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables OSP delay for the Reference Trigger.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ReferenceTriggerOspDelayEnabled', + 'lv_property': 'Triggers:Ref:Advanced:OSP Delay Enabled', + 'name': 'REF_TRIGGER_OSP_DELAY_ENABLED', + 'type': 'ViInt32' + }, + 1150203: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies an offset from the I/Q carrier frequency for the downconverter. \n\nIf you set this attribute, any measurements outside the instantaneous bandwidth of the device are invalid. After you set this attribute, the RF downconverter is locked to that frequency offset until the value is changed or the attribute is reset.\n\n**Valid Values:**\n\n**PXIe-5646:**: -100 MHz to +100 MHz\n\n**PXIe-5830/5831/5832/5840/5841:**: -500 MHz to +500 MHz\n\n**All other devices:**: -42 MHz to +42 MHz\n\n**Default Values:**: For spectrum acquisition types the driver automatically calculates the default to avoid residual LO power. For I/Q acquisition types the default is 0 Hz. If the center frequency is set to a non-multiple of the NIRFSA_ATTR_LO_FREQUENCY_STEP_SIZE attribute, the NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET attribute is set to compensate for the difference.\n\n**Supported Devices:**: PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Acquisition:Advanced:Downconverter Frequency Offset', + 'name': 'DOWNCONVERTER_FREQUENCY_OFFSET', + 'type': 'ViReal64' + }, + 1150204: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the temperature of the I/Q IN circuitry on the device.\n\n**Units:** degrees C\n\n**Supported Devices:** PXIe-5645, PXIe-5820' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ In Port:Temperature (Degrees C)', + 'name': 'IQ_IN_PORT_TEMPERATURE', + 'type': 'ViReal64' + }, + 1150205: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the IF filter path bandwidth for your device configuration.\n\n----\n**Note**\nFor composite devices, such as the PXIe-5665/5667/5668, the IF filter path bandwidth includes all IF filters across the component modules of a composite device.\n\n----\n\nNI-RFSA uses this attribute in conjunction with the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute and the NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED attribute to determine the settings for your measurement. NI-RFSA selects the next highest available filter based on the value you specify. The following table lists the IF filters available for NI devices. You may specify a higher value than your device instantaneous bandwidth if your measurement requires it, but specifying a lower value returns an error.\n\n**Valid Values**:\n\n**PXIe-5603/5605**: 0 to 80 MHz\n\n**PXIe-5665/5667**: 0 to 50 MHz\n\n**PXIe-5668**: 0 to 765 MHz\n\n**PXIe-5694**: 0 to 50 MHz\n\n----\n**Note**\nTo set this attribute to values greater than 20 MHz, you must set the NIRFSA_ATTR_SIGNAL_CONDITIONING_ENABLED attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED\n\n----\n\n**Default Values:** For spectrum acquisition types the default is greater than or equal to the NIRFSA_ATTR_SPECTRUM_SPAN attribute. NI-RFSA chooses the default value of the NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute to correspond to the appropriate IF filter. For I/Q acquisition types NI-RFSA chooses the default value corresponding to the widest IF filter possible for your equipment setup.\n\n**Supported Devices**: PXIe-5603/5605/5606, PXIe-5665/5667/5668, PXIe-5694', + 'table_body': [ + [ + 'PXIe-5603/5665 (3.6 GHz)', + '2264300 kHz', + '300 kHz IF filter' + ], + [ + 'PXIe-5603/5665 (3.6 GHz)', + '>300 kHz and 22645 MHz', + 'Through IF filter' + ], + [ + 'PXIe-5603/5665 (3.6 GHz)', + '>5 MHz', + 'Through IF filter' + ], + [ + 'PXIe-5605/5665 (14 GHz)', + '2264300 kHz', + '300 kHz IF filter' + ], + [ + 'PXIe-5603/5665 (14 GHz)', + '>300 kHz and 22645 MHz', + '5 MHz IF filter' + ], + [ + 'PXIe-5603/5665 (14 GHz)', + '>5 MHz', + 'Through IF filter' + ], + [ + 'PXIe-5668', + '2264300 kHz', + '300 kHz IF filter' + ], + [ + 'PXIe-5668', + '>300 kHz and 22645 MHz', + '5 MHz IF filter' + ], + [ + 'PXIe-5668', + '>5 MHz and 2264100 MHz', + '100 MHz IF filter' + ], + [ + 'PXIe-5668', + '>100 MHz and 2264320 MHz', + '320 MHz IF filter' + ], + [ + 'PXIe-5668', + '>320 MHz', + '765 MHz IF filter' + ] + ], + 'table_header': [ + 'Device', + 'IF Filter Bandwidth Range', + 'IF Filter' + ] + }, + 'lv_property': 'Signal Path:IF Filter Bandwidth', + 'name': 'IF_FILTER_BANDWIDTH', + 'type': 'ViReal64' + }, + 1150206: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the shape factor of the window used in the fast Fourier transform (FFT). \n\nThe window shape factor is defined as the ratio of the 60 dB to 6 dB bandwidths.\n\nThe following table shows the shape factor for each NI-RFSA FFT window type.\n\n| Window Type | Shape Factor |\n|:-----------------------|:-------------|\n| Uniform | 1.57:1 |\n| Hanning | 1.94:1 |\n| Hamming | 2.13:1 |\n| Exact Blackman | 2.52:1 |\n| Flat Top | 2.0:1 |\n| 4-term Blackman-Harris | 2.5:1 |\n| 7-term Blackman-Harris | 4.1:1 |\n| Low Side Lobe | 2.78:1 |\n| Gaussian | 2.3:1 |\n| Kaiser Bessel | 2.55:1 |\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Spectrum:FFT Window Shape Factor', + 'name': 'FFT_WINDOW_SHAPE_FACTOR', + 'type': 'ViReal64' + }, + 1150219: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies that an optimized IF filtering selection is made at different spectrum frequency ranges during spectrum acquisition.\n\nThe IF filter used depends on the configured RF center frequency, as shown in the following table.\n\n| Center Frequency | IF Filter |\n|:--------------------|:----------|\n| 0 Hz and <80 MHz | 300 kHz |\n| 0 MHz | 50 MHz |\n\n----\n**Note**\nSetting this attribute to **Enabled** prevents you from setting NIRFSA_ATTR_IF_FILTER_BANDWIDTH or NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH.\n\n----\n\n**Default Value**: NIRFSA_VAL_DISABLED\n\n**Supported Devices**: PXIe-5665/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables spectrum smoothing.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables spectrum smoothing.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SmoothSpectrumEnabled', + 'lv_property': 'Acquisition:Spectrum:Smooth Spectrum Enabled', + 'name': 'SMOOTH_SPECTRUM_ENABLED', + 'type': 'ViInt32' + }, + 1150220: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the maximum corner frequency of the highpass filter in the RF signal path. \n\nThe device uses the highest frequency highpass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables highpass filtering.\n\nFor multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this attribute returns the value you specified rather than a coerced value if multiple highpass filters are used during the acquisition.\n\nThe PXIe-5606 features highpass filters at 1.35 GHz and 2.2 GHz.\n\n**Valid Values**: 0 to 26.5\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5606, PXIe-5668' + }, + 'lv_property': 'Signal Path:Advanced:RF Highpass Filtering', + 'name': 'RF_HIGH_PASS_FILTERING', + 'type': 'ViReal64' + }, + 1150221: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a string containing the path to the location of the current NI-RFSA instrument driver FPGA extensions bitfile, a .lvbitx file, that is programmed on the device. \n\nYou can specify the bitfile location using the Driver Setup string in the **optionString** parameter of the nirfsa_InitWithOptions function.\n\nNI-RFSA instrument driver FPGA extensions enable you to use pre-compiled FPGA bitfiles to customize the behavior of the device FPGA while maintaining the functionality of the NI-RFSA instrument driver.\n\nRefer to `NI-RFSA Instrument Driver FPGA Extensions `_ for more information about using NI-RFSA instrument driver FPGA extensions for NI devices.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:FPGA Bitfile Path', + 'name': 'FPGA_BITFILE_PATH', + 'type': 'ViString' + }, + 1150222: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Enables the 28 V DC source on the device front panel.\n\n**PXIe-5668 with PXIe-5698**: When this attribute is set to NIRFSA_VAL_ENABLED, the PXIe-5698 noise source is used instead of the PXIe-5668 noise source.\n\n**Units**: dB\n\n**Default Value**: NIRFSA_VAL_DISABLED\n\n**Supported Devices**: PXIe-5606, PXIe-5668, PXIe-5698\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables the noise source power.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables the noise source power.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'NoiseSourcePowerEnabled', + 'lv_property': 'Device Specific:5606:Noise Source Power Enabled', + 'name': 'NOISE_SOURCE_POWER_ENABLED', + 'type': 'ViInt32' + }, + 1150228: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the actual frequency, in hertz (Hz), of the digitizer Sample Clock.\n\n**Units**: hertz (Hz)\n\n**Supported Devices**: PXIe-5668' + }, + 'lv_property': 'Clocking:Digitizer Sample Clock Rate', + 'name': 'DIGITIZER_SAMPLE_CLOCK_RATE', + 'type': 'ViReal64' + }, + 1150229: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the terminal at which to export the Digitizer Sample Clock.\n\n**Valid Values**: \n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_NONE', + 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' + ], + [ + 'NIRFSA_VAL_CLK_OUT', + 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DigitizerSampleClockExportedTerminal', + 'lv_property': 'Clocking:Digitizer Sample Clock Exported Terminal', + 'name': 'EXPORTED_DIGITIZER_SAMPLE_CLOCK_OUTPUT_TERMINAL', + 'type': 'ViString' + }, + 1150233: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a string containing the name of the FPGA target being used. \n\nThis name can be used with the RIO open session to open a reference to the FPGA.\n\nThis attribute is channel dependent if multiple targets are supported.\n\n**Supported Devices:** PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:FPGA Target Name', + 'name': 'FPGA_TARGET_NAME', + 'type': 'ViString' + }, + 1150234: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Use subspan overlap process to eliminate or reduce analyzer spurs. \n\nTo enable this feature, specify a non-zero percentage overlap between consecutive subspans in a spectrum acquisition.\n\nIf a value greater than 0 is specified, then for each spectral line in the resulting spectrum, the driver acquires data twice with slightly different hardware settings, so that the analyzer spurs, if any, are present at different frequencies in the two acquisitions. Typically, LO frequency is shifted between the acquisitions causing analyzer spurs that are relative to the LO frequency, to move from one frequency to another. Those spurs, which are present in only one of the acquisitions for each spectral line, get removed.\n\nThe subspan overlap feature will not remove any spurs from the Device Under Test or modify the signal being measured; unlike the analyzer spurs, the spurs in the signal being measured stay at a constant frequency in the two acquisitions.\n\n----\n**Note**\nSubspan overlap process effectively is performing minimum averaging, which might reduce the measured noise floor level. NI-RFSA Spectrum Averaging can be enabled to minimize the effect of subspan overlap on the noise floor.\n\n----\n\n----\n**Note**\nNI-RFSA may apply further shifts to the specified value to accommodate fixed-frequency edges of components such as preselectors.\n\n----\n\n**Valid Values**:\n\n**PXIe-5665/5668**: 0 to < 100\n\n**PXIe-5820/5830/5831/5832/5840/5841/5860**: 0\n\n**PXIe-5842**: 0, 50\n\n**Default Value**: 0\n\n**Supported Devices**: PXIe-5665/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n----\n**Note**\nSubspan overlap will not be supported by PXIe-5842, if RMM-5585 (54GHz Frequency Extension) is connected.\n\n----' + }, + 'lv_property': 'Acquisition:Spectrum:Subspan Overlap', + 'name': 'SUBSPAN_OVERLAP', + 'type': 'ViReal64' + }, + 1150235: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to enable the LO2 OUT terminal on the installed devices.\n\nSet this attribute to TRUE to export the 4 GHz LO signal from the device LO2 IN terminal to the LO2 OUT terminal.\n\nYou can also export the LO2 signal by setting the NIRFSA_ATTR_LO_EXPORT_ENABLED attribute and the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute.\n\n| Value | Description |\n|:------|:-------------------------------|\n| VI_TRUE | Enables the LO2 OUT terminal. |\n| VI_FALSE | Disables the LO2 OUT terminal. |\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5668\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables LO2 export.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables LO2 export.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'Lo2ExportEnabled', + 'lv_property': 'Signal Path:LO2 Export Enabled', + 'name': 'LO2_EXPORT_ENABLED', + 'type': 'ViInt32' + }, + 1150236: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the maximum instantaneous bandwidth of the device.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Max Device Instantaneous Bandwidth', + 'name': 'MAX_DEVICE_INSTANTANEOUS_BANDWIDTH', + 'type': 'ViReal64' + }, + 1150237: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the maximum I/Q rate.\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Max IQ Rate', + 'name': 'MAX_IQ_RATE', + 'type': 'ViReal64' + }, + 1150246: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the power level, in dBm, of the signal at the LO OUT terminal when the NIRFSA_ATTR_LO_EXPORT_ENABLED attribute is set to VI_TRUE.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Units:** dBm\n\n**Supported Devices:** PXIe-5830/5831/5832/5840/5841/5842' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO Out Power (dBm)', + 'name': 'LO_OUT_POWER', + 'supported_rep_caps': [ + 'los' + ], + 'type': 'ViReal64' + }, + 1150254: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the current temperature, in degrees Celsius, of the FPGA.\n\n----\n**Note**\nIf you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n----\n\n**Units**: degrees Celcius\n\n**Default Value**: N/A\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:FPGA Temperature (Degrees C)', + 'name': 'FPGA_TEMPERATURE', + 'type': 'ViReal64' + }, + 1150255: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the module power consumption.\n\n----\n**Note**\nIf you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n----\n\n**Units**: watts\n\n**Default Value**: N/A\n\n**Supported Devices:**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Characteristics:Module Power Consumption (W)', + 'name': 'MODULE_POWER_CONSUMPTION', + 'type': 'ViReal64' + }, + 1150256: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Enables or disables warnings and errors when you set frequency, power, or bandwidth values beyond the limits of the NI-RFSA device specifications.\n\nWhen you set this attribute to NIRFSA_VAL_ENABLED, the driver does not report out-of-specification warnings and errors.\n\n**Default Value**: NIRFSA_VAL_DISABLED\n\n**Supported Devices:** PXIe-5820/5830/5831/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Disables out-of-specification user settings.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Enables out-of-specification user settings.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'AllowOutOfSpecificationUserSettings', + 'lv_property': 'Acquisition:Advanced:Allow Out Of Specification User Settings', + 'name': 'ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS', + 'type': 'ViInt32' + }, + 1150266: { + 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the sub-sample clock delay, in seconds, to apply to the acquired signal.\n\nUse this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. \nThis attribute can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session.\n\nTo set this attribute, the NI-RFSA device must be in the Configuration state.\n\n----\n**Note**\nIf this attribute is set, NI-TClk cannot do any sub-sample clock adjustment.\n\n----\n\n**Units:** Seconds\n\n**Valid Values:** Plus or minus half of one sample clock period\n\n**Default Value**: 0\n\n**Supported Devices:** PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Absolute Delay', + 'name': 'ABSOLUTE_DELAY', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + }, + 1150267: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': "Specifies the bandwidth of the input signal around the NIRFSA_ATTR_IQ_CARRIER_FREQUENCY. \n\nThis value must be less than or equal to (0.8 7 [I/Q rate](NIRFSA_ATTR_IQ_RATE.html)).\n\nNI-RFSA defines *signal bandwidth* as twice the maximum I/Q signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0 Hz. In such cases, the signal bandwidth is simply the baseband signal's minimum frequency subtracted from its maximum frequency, or *f* < sub>max - *f*< sub>min.\n\nIf you do not set this attribute, NI-RFSA uses the maximum available signal bandwidth. Depending on your device settings, setting this attribute enables certain optimizations. Based on the specified signal bandwidth, NI-RFSA decides the minimum equalized bandwidth and equalizer gain.\n\n----\n**Note**\nYou must set this attribute to enable the NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET_MODE attribute.\n\n----\n\nEnsure you set the signal bandwidth wide enough to encompass all significant anticipated input power. In cases where NI-RFSA optimizes the input gain based on the signal bandwidth, significant input power outside the signal bandwidth can lead to clipping and associated overflow warnings if you do not have enough margin in your [reference level.](NIRFSA_ATTR_REFERENCE_LEVEL.html)\n\n**Units**: Hz\n\n**Default Value**: 0 Hz\n\n**Supported Devices:**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_" + }, + 'lv_property': 'Acquisition:IQ:Signal Bandwidth (Hz)', + 'name': 'SIGNAL_BANDWIDTH', + 'type': 'ViReal64' + }, + 1150269: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the common-mode level presented at each differential input terminal.\n\nCommon-mode level shifts both positive and negative terminals in the same direction. This must match the common-mode level of the device under test (DUT).\n\n**Units**: volts\n\n**Default Value**: 0 V\n\n**Supported Devices**: PXIe-5820' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ In Port:Common Mode Level', + 'name': 'COMMON_MODE_LEVEL', + 'type': 'ViReal64' + }, + 1150271: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures error reporting for ADC and onboard signal processing overflows. \n\nOverflows lead to clipping of the waveform.\n\n**Default Value**: NIRFSA_VAL_ERROR_REPORTING_WARNING\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_ERROR_REPORTING_WARNING', + 'Configures NI-RFSA to return a warning when an ADC or onboard signal processing (OSP) overflow occurs.' + ], + [ + 'NIRFSA_VAL_ERROR_REPORTING_DISABLED', + 'Configures NI-RFSA to not return an error or a warning when an ADC or OSP overflow occurs.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'OverflowErrorReporting', + 'lv_property': 'Vertical:Advanced:Overflow Error Reporting', + 'name': 'OVERFLOW_ERROR_REPORTING', + 'type': 'ViInt32' + }, + 1150285: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the size of the DMA buffer in computer memory, in bytes. \n\nTo set this attribute, the NI-RFSA device must be in the Configuration state.\n\nA sufficiently large host DMA buffer improves performance by allowing large fetches to be transferred more efficiently.\n\n**Default Value:** 8 MB\n\n**Supported Devices**: PXI-5820/5830/5831/5840/5841/5842/5860' + }, + 'lv_property': 'Acquisition:Fetch:Data Transfer:Host DMA Buffer Size', + 'name': 'HOST_DMA_BUFFER_SIZE', + 'type': 'ViInt64' + }, + 1150297: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the port to configure.\n\n----\n**Note**\nWhen using RF list mode, ports cannot be shared with NI-RFSA.\n\n----\n\n**Valid Values**:\n\n**PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860**: "" (empty string)\n\n**PXIe-5830**: if0, if1\n\n**PXIe-5831/5832**: if0, if1, rf <0-1> port , where\n\n*0-1* indicates one (*0*) or two (*1*) mmRH-5582 connections and\n\n*x* is the port number on the mmRH-5582 front panel.\n\n**Default Value:**\n\n**PXIe-5830/5831/5832:**: if1\n\n**PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\nNIRFSA_ATTR_AVAILABLE_PORTS' + }, + 'lv_property': 'Signal Path:Advanced:Selected Ports', + 'name': 'SELECTED_PORTS', + 'type': 'ViString' + }, + 1150298: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840/5841.\n\nWhen this attribute is enabled, if the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN and you do not set the NIRFSA_ATTR_LO_FREQUENCY or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes, NI-RFSA rounds the LO frequency to approximately an LO step size as if the source was NIRFSA_VAL_ONBOARD. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible.\n\n**Default Value:**: NIRFSA_VAL_UNSPECIFIED\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'The LO signal is not exported from the RF OUT LO OUT terminal.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'The LO signal is exported from the RF OUT LO OUT terminal.' + ], + [ + 'NIRFSA_VAL_UNSPECIFIED', + 'The LO signal may or may not be exported to the RF OUT LO OUT terminal, because NI-RFSG may be controlling it.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'RfOutLoExport', + 'lv_property': 'Signal Path:RF Out LO Export Enabled', + 'name': 'RF_OUT_LO_EXPORT_ENABLED', + 'type': 'ViInt32' + }, + 1150299: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to allow NI-RFSG to control the NI-RFSA LO out export.\n\nSet this attribute to NIRFSA_VAL_ENABLED to allow NI-RFSG to control the LO out export. Use the NIRFSG ATTR RF IN LO EXPORT ENABLED attribute to control the NI-RFSA LO out export from NI-RFSG.\n\n**Default Value:** NIRFSA_VAL_DISABLED\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DISABLED', + 'Do not allow NI-RFSG to control the NI-RFSA local oscillator export.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'Allow NI-RFSG to control the NI-RFSA local oscillator export.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoOutExportConfigureFromRfsg', + 'lv_property': 'Signal Path:LO Out Export Configure From RFSG', + 'name': 'LO_OUT_EXPORT_CONFIGURE_FROM_RFSG', + 'type': 'ViInt32' + }, + 1150300: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the temperature change required before NI-RFSA recalculates the thermal correction settings when entering the Running state.\n\n**Units:** degrees Celsius (C)\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Default Values**:\n\n**PXIe-5830/5831/5832/5842/5860**: 0.2\n\n**PXIe-5840/5841**: 1.0' + }, + 'lv_property': 'Vertical:Advanced:Thermal Correction Temperature Resolution (Degrees C)', + 'name': 'THERMAL_CORRECTION_TEMPERATURE_RESOLUTION', + 'type': 'ViReal64' + }, + 1150301: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the scaling factor applied to the time-domain voltage data in the digitizer.\n\nNI-RFSA does not compensate for the specified digital gain.\n\nYou can use this attribute to account for external gain changes without changing the analog signal path.\n\n----\n**Note**\nThe PXIe-5644/5645/5646 applies this gain when the data is scaled. The raw data does not include this scaling on these devices.\n\n----\n\n**Units:** dB\n\n**Default Value:** 0 dB\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:Digital Gain (dB)', + 'name': 'DIGITAL_GAIN', + 'type': 'ViReal64' + }, + 1150305: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies whether to allow NI-RFSA to select the downconveter frequency offset. \n\nYou can either set an offset yourself or let NI-RFSA select one for you.\n\nPlacing the downconverter center frequency outside the bandwidth of your input signal can help avoid issues such as LO leakage.\n\nTo set an offset yourself, set this attribute to NIRFSA_VAL_AUTOMATIC or NIRFSA_VAL_USER_DEFINED, and set either the NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY or the NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET attributes.\n\nTo allow NI-RFSA to automatically select the downconverter frequency offset, set this attribute to NIRFSA_VAL_AUTOMATIC or NIRFSA_VAL_ENABLED and configure the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute to describe your expected input signal. The signal bandwidth must be no greater than half the specified value of the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, minus a device-specific guard band. Do not set the NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY or NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET attributes. If all conditions are met, NI-RFSA places the downconverter center frequency outside the signal bandwidth. Set this attribute to NIRFSA_VAL_ENABLED if you want to receive an error any time NI-RFSA is unable to apply automatic offset.\n\nWhen you set an offset yourself or do not use an offset, the reference frequency for gain is near the downconverter center frequency, and NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSA_VAL_USER_DEFINED. When NI-RFSA automatically sets an offset, the reference frequency for gain is the NIRFSA_ATTR_IQ_CARRIER_FREQUENCY, and NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSA_VAL_ENABLED. Refer to the specifications document for your device for more information about gain, flatness, and reference frequencies.\n\n----\n**Note**\nBelow 120 MHz, the PXIe-5841 does not use an LO and NIRFSA_VAL_ENABLED is unavailable. Refer to the *PXIe-5841 Automatic Frequency Offset* topic for more information about using an automatic offset with an external LO.\n\n----\n\n**Default Value:** NIRFSA_VAL_AUTOMATIC\n\n**Supported Devices**: PXIe-5830/5831/5832/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Automatic Frequency Offset `_\n\n`PXIe-5831/5832 Automatic Frequency Offset `_\n\n`PXIe-5841 Automatic Frequency Offset `_\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_AUTOMATIC', + 'NI-RFSA places the downconverter center frequency outside of the signal bandwidth if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided.' + ], + [ + 'NIRFSA_VAL_ENABLED', + 'NI-RFSA places the downconverter center frequency outside of the signal bandwidth if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided. NI-RFSA returns an error if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has not been set, or if the signal bandwidth is too large.' + ], + [ + 'NIRFSA_VAL_USER_DEFINED', + 'NI-RFSA uses the offset that you specified with the NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DownconverterFrequencyOffsetMode', + 'lv_property': 'Acquisition:Advanced:Downconverter Frequency Offset Mode', + 'name': 'DOWNCONVERTER_FREQUENCY_OFFSET_MODE', + 'type': 'ViInt32' + }, + 1150306: { + 'access': 'read only', + 'attribute_class': 'AttributeViStringCommaSeparated', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a comma-separated list of the available ports for use based on your instrument configuration.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Signal Path:Advanced:Available Ports', + 'name': 'AVAILABLE_PORTS', + 'type': 'ViString', + 'type_in_documentation': 'list of str' + }, + 1150307: { + '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**:', + 'table_body': [ + [ + 'NIRFSA_VAL_DEEMBEDDING_TYPE_NONE', + 'De-embedding is not applied to the measurement.' + ], + [ + 'NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR', + 'De-embeds the measurement using only the gain term.' + ], + [ + 'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR', + 'De-embeds the measurement using the gain term and the reflection term.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'DeembeddingType', + 'lv_property': 'De-embedding:Type', + 'name': 'DEEMBEDDING_TYPE', + 'supported_rep_caps': [ + 'ports' + ], + 'type': 'ViInt32' + }, + 1150308: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Selects the de-embedding table to apply to the measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsa_SetAttributeViString function to specify the name of the port to configure for de-embedding.\n\nIf de-embedding is enabled, NI-RFSA uses the specified table to remove the effects of the external network between the instrument and the DUT.\n\nUse the nirfsa_CreateDeembeddingSparameterTableArray function to create tables.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'De-embedding:Selected Table', + 'name': 'DEEMBEDDING_SELECTED_TABLE', + 'supported_rep_caps': [ + 'ports' + ], + 'type': 'ViString' + }, + 1150309: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the margin NI-RFSA adds to the NIRFSA_ATTR_REFERENCE_LEVEL attribute. \n\nThe margin helps to avoid clipping and overflow warnings if the input signal exceeds the configured reference level.\n\nNI-RFSA configures the input gain to avoid clipping and associated overflow warnings as long as the instantaneous power of the input signal remains within the reference level plus the reference level headroom. If you know the input power of the signal precisely or have already included margin in the reference level, you may be able to improve the signal-to-noise ratio by reducing the reference level headroom.\n\n**Units**: dB\n\n**Default Value**:\n\n**PXIe-5830/5831/5832/5841/5842/5860**: 1 dB\n\n**PXIe-5840**: 0 dB\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:Reference Level Headroom (dB)', + 'name': 'REFERENCE_LEVEL_HEADROOM', + 'type': 'ViReal64' + }, + 1150312: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal.\n\n----\n**Note**\nDo not set this attribute with the NIRFSA_ATTR_LO_FREQUENCY_STEP_SIZE attribute.\n\n----\n\n**Valid Values**:\n\nLO1: 1 Hz to 50 MHz\n\nLO2: 1 Hz to 100 MHz\n\n**Default Values**: 1 MHz\n\n**Supported Devices**: PXIe-5830/5831/5832' + }, + 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO VCO Frequency Step Size (Hz)', + 'name': 'LO_VCO_FREQUENCY_STEP_SIZE', + 'type': 'ViReal64' + }, + 1150316: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the NIRFSA_ATTR_DEVICE_TEMPERATURE attribute.\n\nFor example, if this property is set to 5.0, and the device is self-calibrated at 35 C, then you can expect to run the device from 30 C to 40 C with corrected accuracy and no overflows. Setting this property with a smaller value can result in improved dynamic range, but you must ensure thermal stability while the instrument is running. Operating the instrument outside of the specified range may cause degraded performance and ADC or DSP overflows.\n\n**Units:** degrees Celsius (C)\n\n**Default Value**:\n\n**PXIe-5830/5831/5832/5842/5860**: 5\n\n**PXIe-5840/5841**: 10\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Vertical:Advanced:Thermal Correction Headroom Range (Degrees C)', + 'name': 'THERMAL_CORRECTION_HEADROOM_RANGE', + 'type': 'ViReal64' + }, + 1150321: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the pulse width units for the User Source. \n\nWhen the value is NIRFSA_VAL_PULSE_WIDTH_UNITS_SECONDS, it is assumed that the clock rate of the signal is the data clock. Use NIRFSA_VAL_PULSE_WIDTH_UNITS_CLOCK_PERIODS if the user source clock rate is anything else.\n\n**Default Value**: NIRFSA_VAL_PULSE_WIDTH_UNITS_SECONDS\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_PULSE_WIDTH_UNITS_SECONDS', + 'Units are seconds.' + ], + [ + 'NIRFSA_VAL_PULSE_WIDTH_UNITS_CLOCK_PERIODS', + 'Units are clock periods.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'UserSourcePulseWidthUnits', + 'lv_property': 'Events:User Source:Pulse Width Units', + 'name': 'USER_SOURCE_PULSE_WIDTH_UNITS', + 'type': 'ViInt32' + }, + 1150322: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the pulse width for the User Source. \n\nUse the NIRFSA_ATTR_USER_SOURCE_PULSE_WIDTH_UNITS attribute to set the units for the pulse width.\n\n**Default Value**: 200E(-9)\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'lv_property': 'Events:User Source:Pulse Width', + 'name': 'USER_SOURCE_PULSE_WIDTH', + 'type': 'ViReal64' + }, + 1150324: { + 'access': 'read-write', + 'attribute_class': 'AttributeViStringCommaSeparated', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies a comma-separated list of ports for which to fix the group delay.\n\n**Valid Values**:\n\nPXIe-5831/5832: rf<0-1>/port, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel.\n\n**Default Value**:\n\nPXIe-5831/5832: (empty string), which specifies that the group delay will not be fixed for any port.\n\n**Supported Devices**: PXIe-5831/5832' + }, + 'lv_property': 'Signal Path:Advanced:Fixed Group Delay Across Ports', + 'name': 'FIXED_GROUP_DELAY_ACROSS_PORTS', + 'type': 'ViString', + 'type_in_documentation': 'list of str' + }, + 1150325: { + 'access': 'read only', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the de-embedding gain applied to compensate for the mismatch on the specified port. Use the Active Channel property to specify the name of the port to configure for de-embedding.\n\nIf de-embedding is enabled, NI-RFSA uses the returned compensation gain to remove the effects of the external network between the instrument and the DUT.\n\n**Supported Devices**: PXIe-5830/5831/5840/5841/5842/5860' + }, + 'lv_property': 'De-embedding:Compensation Gain', + 'name': 'DEEMBEDDING_COMPENSATION_GAIN', + 'type': 'ViReal64' + }, + 1150326: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the Reference Clock Rate, in Hz, of the signal sent to the Ref Clock Exported Terminal.\n\n**Default Value**: 10 MHz\n\n**Valid Values**:\n\nPXIe-5820/5830/5831/5832/5840/5841: 10 MHz\n\nPXIe-5842: 10 MHz, 100 MHz, 1 GHz\n\nPXIe-5860: 10 MHz, 100 MHz\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'enum': 'ReferenceClockExportedRate', + 'lv_property': 'Clocking:Ref Clock Exported Rate:Ref Clock Exported Rate', + 'name': 'EXPORTED_REF_CLOCK_RATE', + 'type': 'ViReal64' + }, + 1150331: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies which path to configure to acquire a signal.\n\n**Default Value**: "" (empty string)' + }, + 'lv_property': 'Signal Path:Advanced:Selected Path', + 'name': 'SELECTED_PATH', + 'type': 'ViString' + }, + 1150332: { + 'access': 'read only', + 'attribute_class': 'AttributeViStringCommaSeparated', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns a comma separated list of the configurable paths available for use based on your instrument configuration.' + }, + 'lv_property': 'Signal Path:Advanced:Available Paths', + 'name': 'AVAILABLE_PATHS', + 'type': 'ViString', + 'type_in_documentation': 'list of str' + }, + 1150337: { + 'access': 'read-write', + 'codegen_method': 'public', + 'documentation': { + 'description': 'Specifies the configurations to skip to reset while loading configurations from a file.\n\n**Default Value:** NIRFSA_VAL_SKIP_NONE\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'table_body': [ + [ + 'NIRFSA_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', + 'NI-RFSA resets all configurations.' + ], + [ + 'NIRFSA_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES', + 'NI-RFSA skips resetting the de-embedding tables.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LoadConfigurationResetOptions', + 'lv_property': 'Load Configurations:Reset Options', + 'name': 'LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS', + 'type': 'ViInt32' + } +} diff --git a/src/nirfsa/metadata/attributes_addon.py b/src/nirfsa/metadata/attributes_addon.py new file mode 100644 index 000000000..65af90534 --- /dev/null +++ b/src/nirfsa/metadata/attributes_addon.py @@ -0,0 +1,6 @@ +# These dictionaries are applied to the generated attributes dictionary at build time +# Any changes to the API should be made here. attributes.py is code generated + +attributes_override_metadata = { +} + diff --git a/src/nirfsa/metadata/config.py b/src/nirfsa/metadata/config.py new file mode 100644 index 000000000..ab275faf1 --- /dev/null +++ b/src/nirfsa/metadata/config.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +config = { + 'api_version': '26.5.0d9999', + 'c_function_prefix': 'niRFSA_', + 'close_function': 'close', + 'context_manager_name': { + 'abort_function': 'Abort', + 'initiate_function': 'Initiate', + 'task': 'acquisition' + }, + 'custom_types': [ + { + 'ctypes_type': 'struct_niRFSA_coefficientInfo', + 'file_name': 'coefficient_info_type', + 'grpc_name': 'CoefficientInfo', + 'python_name': 'CoefficientInfo' + }, + { + 'ctypes_type': 'struct_niRFSA_wfmInfo', + 'file_name': 'waveform_info', + 'grpc_name': 'WaveformInfo', + 'python_name': 'WaveformInfo' + }, + { + 'ctypes_type': 'struct_niRFSA_spectrumInfo', + 'file_name': 'spectrum_info_type', + 'grpc_name': 'SpectrumInfo', + 'python_name': 'SpectrumInfo' + } + ], + 'driver_name': 'NI-RFSA', + 'enum_whitelist_prefix': [ + 'RANGE_', + 'CLOCK_RATE_', + 'EXT_CAL_IF_FILTER_PATH_', + 'EXT_CAL_LO_PATH_', + 'EXT_CAL_RF_LOWBAND_SIGNAL_CONDITIONING_PATH_', + 'EXT_CAL_RF_BAND_' + ], + 'enum_whitelist_suffix': [ + '_TOWARDS_DUT' + ], + 'extra_errors_used': [ + 'InvalidRepeatedCapabilityError', + 'SelfTestError' + ], + 'grpc_service_class_prefix': 'NiRFSA', + 'init_function': 'InitWithOptions', + 'library_info': { + 'Linux': { + '64bit': { + 'name': 'nirfsa', + 'type': 'cdll' + } + }, + 'Windows': { + '32bit': { + 'name': 'niRFSA.dll', + 'type': 'windll' + }, + '64bit': { + 'name': 'niRFSA_64.dll', + 'type': 'cdll' + } + } + }, + 'module_name': 'nirfsa', + 'repeated_capabilities': [ + { + 'prefix': '', + 'python_name': 'ports' + }, + { + 'prefix': 'LO', + 'python_name': 'los' + }, + { + 'prefix': '', + 'python_name': 'device_temperatures' + }, + { + 'prefix': '', + 'python_name': 'channels' + } + ], + 'session_class_description': 'An NI-RFSA session to the NI-RFSA driver', + 'session_handle_parameter_name': 'vi', + 'uses_nitclk': True +} diff --git a/src/nirfsa/metadata/config_addon.py b/src/nirfsa/metadata/config_addon.py new file mode 100644 index 000000000..726609afb --- /dev/null +++ b/src/nirfsa/metadata/config_addon.py @@ -0,0 +1,7 @@ +# We need to maintain the version here since it needs to be updated by the build process on GitHub +config_additional_config = { + 'module_version': '1.0.0.dev0', + 'development_status': '4 - Beta', + 'latest_runtime_version_tested_against': '2026 Q3', + 'initial_release_year': '2026', +} diff --git a/src/nirfsa/metadata/enums.py b/src/nirfsa/metadata/enums.py new file mode 100644 index 000000000..52e640626 --- /dev/null +++ b/src/nirfsa/metadata/enums.py @@ -0,0 +1,2595 @@ +# -*- coding: utf-8 -*- +# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +enums = { + 'AcquisitionType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Configures NI-RFSA for I/Q acquisitions.' + }, + 'name': 'NIRFSA_VAL_IQ', + 'value': 100 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA for spectrum acquisitions.' + }, + 'name': 'NIRFSA_VAL_SPECTRUM', + 'value': 101 + } + ] + }, + 'Action': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The new calibration constants are stored in the EEPROM.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_COMMIT', + 'value': 1501 + }, + { + 'documentation': { + 'description': 'The old calibration constants are kept, and the new ones are discarded.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_ABORT', + 'value': 1500 + } + ] + }, + 'AdvanceTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No Advance Trigger is configured.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 600 + }, + { + 'documentation': { + 'description': 'The Advance Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_ADVANCE_TRIGGER_SOURCE attribute.' + }, + 'name': 'NIRFSA_VAL_DIGITAL_EDGE', + 'value': 601 + }, + { + 'documentation': { + 'description': 'The Advance Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_ADVANCE_TRIGGER as the **trigger** parameter.' + }, + 'name': 'NIRFSA_VAL_SOFTWARE_EDGE', + 'value': 604 + } + ] + }, + 'AdvanceTriggerDigitalEdgeEdge': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The trigger asserts on the rising edge of the signal.' + }, + 'name': 'NIRFSA_VAL_RISING_EDGE', + 'value': 900 + }, + { + 'documentation': { + 'description': 'The trigger asserts on the falling edge of the signal.' + }, + 'name': 'NIRFSA_VAL_FALLING_EDGE', + 'value': 901 + } + ] + }, + 'AllowOutOfSpecificationUserSettings': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables out-of-specification user settings.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables out-of-specification user settings.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'ArmReferenceTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No Arm Reference Trigger is configured.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 600 + }, + { + 'documentation': { + 'description': 'The Arm Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_ARM_REF_TRIGGER_SOURCE attribute.' + }, + 'name': 'NIRFSA_VAL_DIGITAL_EDGE', + 'value': 601 + }, + { + 'documentation': { + 'description': 'The Arm Reference Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_ARM_REF_TRIGGER as the **trigger** parameter.' + }, + 'name': 'NIRFSA_VAL_SOFTWARE_EDGE', + 'value': 604 + } + ] + }, + 'CalToneMode': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the calibration tone for the associated signal path. ' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the low band RF signal path. ' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_LOWBAND_RF', + 'value': 2701 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the high band RF signal path. ' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_HIGHBAND_RF', + 'value': 2702 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the high band IF signal path.' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_HIGHBAND_IF', + 'value': 2703 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the low band RF signal path, bypassing the ALC.' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_LOWBAND_RF_WITHOUT_ALC', + 'value': 2704 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the high band RF signal path through the Comb Generator. ' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_COMB_GENERATOR', + 'value': 2705 + } + ] + }, + 'CalibrateStep': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Initializes the IF Attenuation Calibration step. This step is not supported for the PXIe-5693.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_ATTENUATION_CALIBRATION', + 'value': 1600 + }, + { + 'documentation': { + 'description': 'Initializes the IF Response Calibration step. This step is not supported for the PXIe-5603/5605 or PXIe-5693/5698.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_RESPONSE_CALIBRATION', + 'value': 1601 + }, + { + 'documentation': { + 'description': 'Initializes the Ref Level Calibration step. This step is not supported on the PXIe-5694. ' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_REF_LEVEL_CALIBRATION', + 'value': 1602 + }, + { + 'documentation': { + 'description': 'Initializes the LO Export Calibration step. This step calibrates the output power of each LO to be within specification. This step is not supported on the PXIe-5601 or the PXIe-5693/5694/5698.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_EXPORT_CALIBRATION', + 'value': 1603 + }, + { + 'documentation': { + 'description': 'Initializes the Gain Reference Calibration step. This step calibrates the calibration tone amplitude across supported calibration tone frequencies. This step is not supported on the PXIe-5601/5603/5605 or PXIe-5694.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_GAIN_REFERENCE_CALIBRATION', + 'value': 1604 + } + ] + }, + 'ChannelCoupling': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that the RF input channel is AC-coupled. For low frequencies (<10 MHz), accuracy decreases because NI-RFSA does not calibrate the configuration.' + }, + 'name': 'NIRFSA_VAL_AC', + 'value': 3001 + }, + { + 'documentation': { + 'description': 'Specifies that the RF input channel is DC-coupled. NI-RFSA enforces a minimum RF attenuation for device protection.' + }, + 'name': 'NIRFSA_VAL_DC', + 'value': 3002 + } + ] + }, + 'ConditioningCalToneMode': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the calibration tone for the associated signal path.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the low band RF signal path.' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_LOWBAND_RF', + 'value': 2701 + }, + { + 'documentation': { + 'description': 'Injects the calibration tone into the high band RF signal path.' + }, + 'name': 'NIRFSA_VAL_CAL_TONE_HIGHBAND_RF', + 'value': 2702 + } + ] + }, + 'DeembeddingType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'De-embedding is not applied to the measurement.' + }, + 'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_NONE', + 'value': 3900 + }, + { + 'documentation': { + 'description': 'De-embeds the measurement using only the gain term.' + }, + 'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_SCALAR', + 'value': 3901 + }, + { + 'documentation': { + 'description': 'De-embeds the measurement using the gain term and the reflection term.' + }, + 'name': 'NIRFSA_VAL_DEEMBEDDING_TYPE_VECTOR', + 'value': 3902 + } + ] + }, + 'DeviceResponseType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Returns the IF response of the downconverter.' + }, + 'name': 'NIRFSA_VAL_DOWNCONVERTER_IF_RESPONSE', + 'value': 2800 + }, + { + 'documentation': { + 'description': 'Returns the RF response of the downconverter. This value is supported only for the PXIe-5603/5605/5665/5667/5693..' + }, + 'name': 'NIRFSA_VAL_DOWNCONVERTER_RF_RESPONSE', + 'value': 2801 + }, + { + 'documentation': { + 'description': 'Returns the combined RF and IF response of the downconverter. The combined response is in terms of IF frequency. This value is supported only for the PXIe-5603/5605/5665/5667.' + }, + 'name': 'NIRFSA_VAL_DOWNCONVERTER_COMBINED_RESPONSE', + 'value': 2802 + }, + { + 'documentation': { + 'description': 'Returns the IF response of the entire NI-RFSA device. This value is supported only for the PXIe-5665/5667.' + }, + 'name': 'NIRFSA_VAL_VSA_IF_RESPONSE', + 'value': 2803 + }, + { + 'documentation': { + 'description': 'Returns the combined IF and RF response of the entire NI-RFSA device. The combined response is in terms of IF frequency. This value is supported only for the PXIe-5665/5667.' + }, + 'name': 'NIRFSA_VAL_VSA_COMBINED_RESPONSE', + 'value': 2804 + } + ] + }, + 'DigitizerDitherEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables dither on the digitizer.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables dither on the digitizer.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'DigitizerSampleClockExportedTerminal': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 'None' + }, + { + 'documentation': { + 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_CLK_OUT', + 'value': 'ClkOut' + } + ] + }, + 'DigitizerSampleClockTimebaseSource': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The digitizer uses its onboard clock as the Sample Clock timebase.' + }, + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'value': 'OnboardClock' + }, + { + 'documentation': { + 'description': 'The digitizer uses the signal present on the CLK IN connector as the Sample Clock timebase.' + }, + 'name': 'NIRFSA_VAL_CLK_IN', + 'value': 'ClkIn' + }, + { + 'documentation': { + 'description': 'The digitizer uses the signal generated on the 100 MHz REF OUT terminal on the PXIe-5653 as the Sample Clock timebase. This value is supported only for the PXIe-5665.' + }, + 'name': 'NIRFSA_VAL_LO_REF_CLK', + 'value': 'LORefClk' + }, + { + 'documentation': { + 'description': 'The digitizer uses the signal present at the PXI star trigger line as the Sample Clock timebase. This value is not supported for the PXIe-5668.' + }, + 'name': 'NIRFSA_VAL_PXI_STAR', + 'value': 'PXI_STAR' + }, + { + 'documentation': { + 'description': 'The digitizer uses the signal present on the LO2 OUT connector on the downconverter as the Sample Clock timebase. This value is supported only for the PXIe-5668.' + }, + 'name': 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT', + 'value': 'DownconverterLO2Out' + } + ] + }, + 'DownconverterFrequencyOffsetMode': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSA places the downconverter center frequency outside of the signal bandwidth if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided.' + }, + 'name': 'NIRFSA_VAL_AUTOMATIC', + 'value': 1903 + }, + { + 'documentation': { + 'description': 'NI-RFSA places the downconverter center frequency outside of the signal bandwidth if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided. NI-RFSA returns an error if the NIRFSA_ATTR_SIGNAL_BANDWIDTH attribute has not been set, or if the signal bandwidth is too large.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + }, + { + 'documentation': { + 'description': 'NI-RFSA uses the offset that you specified with the NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes.' + }, + 'name': 'NIRFSA_VAL_USER_DEFINED', + 'value': 1904 + } + ] + }, + 'DownconverterLoopBandwidth': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that the downconverter module uses a narrow loop bandwidth.' + }, + 'name': 'NIRFSA_VAL_NARROW', + 'value': 800 + }, + { + 'documentation': { + 'description': 'Specifies that the downconverter module uses a medium loop bandwidth.' + }, + 'name': 'NIRFSA_VAL_MEDIUM', + 'value': 801 + }, + { + 'documentation': { + 'description': 'Specifies that the downconverter module uses a wide loop bandwidth.' + }, + 'name': 'NIRFSA_VAL_WIDE', + 'value': 802 + } + ] + }, + 'EnableAttrVals': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The attribute is disabled.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'The attribute is enabled.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'DownconverterPreselectorEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the preselector.' + }, + 'name': 'NIRFSA_VAL_PRESELECTOR_DISABLED', + 'value': 2600 + }, + { + 'documentation': { + 'description': 'The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the NIRFSA_ATTR_PRESELECTOR_PRESENT attribute to determine if the downconverter has an preselector.' + }, + 'name': 'NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH', + 'value': 2601 + }, + { + 'documentation': { + 'description': 'Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH whenever possible avoid an error.' + }, + 'name': 'NIRFSA_VAL_PRESELECTOR_ENABLED', + 'value': 2602 + } + ] + }, + 'EnableRfPreamp': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the RF preamplifier.' + }, + 'name': 'NIRFSA_VAL_RF_PREAMP_DISABLED', + 'value': 2500 + }, + { + 'documentation': { + 'description': 'Enables the RF preamplifier when the RF preamplifier is present in the signal path and disables the preamplifier when it is not in the signal path. Only devices with an RF preamplifier on the downconverter and an RF preselector support this option. Use the NIRFSA_ATTR_RF_PREAMP_PRESENT attribute to determine whether the downconverter has a preamplifier.' + }, + 'name': 'NIRFSA_VAL_RF_PREAMP_ENABLED_WHEN_IN_SIGNAL_PATH', + 'value': 2501 + }, + { + 'documentation': { + 'description': 'Enables the RF preamplifier. If the RF preamplifier is not in a signal path, NI-RFSA returns an error. Select the NIRFSA_VAL_RF_PREAMP_ENABLED_WHEN_IN_SIGNAL_PATH value whenever possible to avoid an error.' + }, + 'name': 'NIRFSA_VAL_RF_PREAMP_ENABLED', + 'value': 2502 + }, + { + 'documentation': { + 'description': 'Automatically enables the RF preamplifier based on the value of the NIRFSA_ATTR_REFERENCE_LEVEL attribute. This value is valid only for the PXIe-5644/5645/5646, PXIe-5667, and PXIe-5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_RF_PREAMP_AUTOMATIC', + 'value': 2503 + } + ] + }, + 'RfOutLoExport': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The LO signal is not exported from the RF OUT LO OUT terminal.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'The LO signal is exported from the RF OUT LO OUT terminal.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + }, + { + 'documentation': { + 'description': 'The LO signal may or may not be exported to the RF OUT LO OUT terminal, because NI-RFSG may be controlling it.' + }, + 'name': 'NIRFSA_VAL_UNSPECIFIED', + 'value': 1902 + } + ] + }, + 'ExportOutputTerminal': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The signal is not exported.' + }, + 'name': 'NIRFSA_VAL_DO_NOT_EXPORT', + 'value': '' + }, + { + 'documentation': { + 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_CLK_OUT', + 'value': 'ClkOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_REF_OUT', + 'value': 'RefOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + }, + 'name': 'NIRFSA_VAL_REF_OUT2', + 'value': 'RefOut2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + }, + 'name': 'NIRFSA_VAL_PFI0', + 'value': 'PFI0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI 1.' + }, + 'name': 'NIRFSA_VAL_PFI1', + 'value': 'PFI1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 0.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG0', + 'value': 'PXI_Trig0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 1.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG1', + 'value': 'PXI_Trig1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 2.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG2', + 'value': 'PXI_Trig2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 3.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG3', + 'value': 'PXI_Trig3' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 4.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG4', + 'value': 'PXI_Trig4' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 5.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG5', + 'value': 'PXI_Trig5' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 6.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG6', + 'value': 'PXI_Trig6' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 7.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG7', + 'value': 'PXI_Trig7' + }, + { + 'documentation': { + 'description': 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + }, + 'name': 'NIRFSA_VAL_PXI_STAR', + 'value': 'PXI_STAR' + }, + { + 'documentation': { + 'description': 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_PXIE_DSTARC', + 'value': 'PXIe_DStarC' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI0', + 'value': 'DIO/PFI0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI1', + 'value': 'DIO/PFI1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI2', + 'value': 'DIO/PFI2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI3', + 'value': 'DIO/PFI3' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI4', + 'value': 'DIO/PFI4' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI5', + 'value': 'DIO/PFI5' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI6', + 'value': 'DIO/PFI6' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI7', + 'value': 'DIO/PFI7' + } + ] + }, + 'FetchRelativeTo': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Fetching occurs relative to the most recently acquired data. The value of the NIRFSA_ATTR_FETCH_OFFSET attribute must be negative.' + }, + 'name': 'NIRFSA_VAL_MOST_RECENT_SAMPLE', + 'value': 700 + }, + { + 'documentation': { + 'description': 'Fetching occurs at the first sample acquired by the device. If the device wraps its buffer, the first sample is no longer available. In this case, NI-RFSA returns an error if the fetch offset is in the overwritten data.' + }, + 'name': 'NIRFSA_VAL_FIRST_SAMPLE', + 'value': 701 + }, + { + 'documentation': { + 'description': 'Fetching occurs relative to the Reference Trigger. This value behaves like NIRFSA_VAL_FIRST_SAMPLE if no Reference Trigger is configured.' + }, + 'name': 'NIRFSA_VAL_REFERENCE_TRIGGER', + 'value': 702 + }, + { + 'documentation': { + 'description': 'Fetching occurs relative to the first pretrigger sample acquired.' + }, + 'name': 'NIRFSA_VAL_FIRST_PRETRIGGER_SAMPLE', + 'value': 703 + }, + { + 'documentation': { + 'description': 'Fetching occurs after the last fetched sample.' + }, + 'name': 'NIRFSA_VAL_CURRENT_READ_POSITION', + 'value': 704 + } + ] + }, + 'FrequencySettlingUnits': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies the frequency settling time in parts per million (PPM).' + }, + 'name': 'NIRFSA_VAL_FSU_PPM', + 'python_name': 'PPM', + 'value': 2000 + }, + { + 'documentation': { + 'description': 'Specifies the frequency settling in time after lock (seconds).' + }, + 'name': 'NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK', + 'python_name': 'SECONDS_AFTER_LOCK', + 'value': 2001 + }, + { + 'documentation': { + 'description': 'Specifies the frequency settling time after I/O (seconds).' + }, + 'name': 'NIRFSA_VAL_FSU_SECONDS_AFTER_IO', + 'python_name': 'SECONDS_AFTER_IO', + 'value': 2002 + } + ] + }, + 'IFattenTableSel': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that the standard IF attenuation table is used for the external calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_ATTENUATION_TABLE_STANDARD', + 'value': 2900 + }, + { + 'documentation': { + 'description': 'Specifies that the adjacent channel power ratio (ACPR) IF attenuation table is used for the external calibration. You can only select this value if you set the NIRFSA_ATTR_CAL_IF_FILTER_SELECTION attribute to NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_1 or NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_2.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_ATTENUATION_TABLE_ACPR', + 'value': 2901 + } + ] + }, + 'IFfilter': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The device uses the 187.5 MHz wide bandwidth filter.' + }, + 'name': 'NIRFSA_VAL_187_5_MHZ_WIDE', + 'python_name': '_187_5_MHZ_WIDE', + 'value': 1400 + }, + { + 'documentation': { + 'description': 'The device uses the 187.5 MHz narrow bandwidth filter.' + }, + 'name': 'NIRFSA_VAL_187_5_MHZ_NARROW', + 'python_name': '_187_5_MHZ_NARROW', + 'value': 1401 + }, + { + 'documentation': { + 'description': 'The device uses the 53 MHz filter.' + }, + 'name': 'NIRFSA_VAL_53_MHZ', + 'python_name': '_53_MHZ', + 'value': 1402 + }, + { + 'documentation': { + 'description': 'The device bypasses the IF filter.' + }, + 'name': 'NIRFSA_VAL_BYPASS', + 'value': 1403 + } + ] + }, + 'IFfilterSelection': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that the 5 MHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_1', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_1', + 'value': 2100 + }, + { + 'documentation': { + 'description': 'Specifies that the 300 kHz filter path is used during calibration. Not supported for the PXIe-5694.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_2', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_2', + 'value': 2101 + }, + { + 'documentation': { + 'description': 'None of the IF filter paths are used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_3', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_3', + 'value': 2102 + }, + { + 'documentation': { + 'description': 'Specifies that the 20 MHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_4', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_4', + 'value': 2103 + }, + { + 'documentation': { + 'description': 'Specifies that the 1.4 MHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_5', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_5', + 'value': 2104 + }, + { + 'documentation': { + 'description': 'Specifies that the 400 kHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_6', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_6', + 'value': 2105 + }, + { + 'documentation': { + 'description': 'Specifies that the 110 kHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_7', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_7', + 'value': 2106 + }, + { + 'documentation': { + 'description': 'Specifies that the 30 kHz filter path is used during calibration.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_IF_FILTER_PATH_8', + 'python_name': 'EXT_CAL_IF_FILTER_PATH_8', + 'value': 2107 + } + ] + }, + 'InputIsolationEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables input isolation.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables input isolation.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'IfConditioningDownConversionEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables IF conditioning downconversion.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables IF conditioning downconversion.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'InputPort': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Enables the RF IN port.' + }, + 'name': 'NIRFSA_VAL_RF_IN', + 'value': 2000 + }, + { + 'documentation': { + 'description': 'Enables the I/Q IN port.' + }, + 'name': 'NIRFSA_VAL_IQ_IN', + 'value': 2001 + }, + { + 'documentation': { + 'description': 'Enables the CAL IN port.' + }, + 'name': 'NIRFSA_VAL_CAL_IN', + 'value': 2002 + }, + { + 'documentation': { + 'description': 'Enables the I terminals of the I/Q IN port. It is supported only for PXIe-5645.' + }, + 'name': 'NIRFSA_VAL_I_ONLY', + 'value': 2003 + } + ] + }, + 'IqInPortTerminalConfiguration': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Sets the terminal configuration to differential.' + }, + 'name': 'NIRFSA_VAL_DIFFERENTIAL', + 'value': 2100 + }, + { + 'documentation': { + 'description': 'Sets the terminal configuration to single-ended.' + }, + 'name': 'NIRFSA_VAL_SINGLE_ENDED', + 'value': 2101 + } + ] + }, + 'SelfCalSteps': { + 'class': 'IntFlag', + 'values': [ + { + 'documentation': { + 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', + 'value': 8 + }, + { + 'documentation': { + 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', + 'value': 1 + }, + { + 'documentation': { + 'description': 'No calibration steps are omitted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_OMIT_NONE', + 'value': 0 + }, + { + 'documentation': { + 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', + 'value': 2 + }, + { + 'documentation': { + 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', + 'value': 4 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', + 'value': 10 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', + 'value': 20 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', + 'value': 40 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', + 'value': 80 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', + 'value': 100 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', + 'value': 200 + } + ] + }, + 'LinearInterpolationFormat': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': ' Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.' + }, + 'name': 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_AND_PHASE', + 'value': 4001 + }, + { + 'documentation': { + 'description': 'Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.' + }, + 'name': 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_DB_AND_PHASE', + 'value': 4002 + }, + { + 'documentation': { + 'description': 'Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.' + }, + 'name': 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_REAL_AND_IMAGINARY', + 'value': 4000 + } + ] + }, + 'Lo2ExportEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables LO2 export.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables LO2 export.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'LoInjection': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Configures the LO signal that the NI-RFSA device generates at a frequency higher than the RF frequency. This LO frequency is given by the formula fLO = fRF + fIF.' + }, + 'name': 'NIRFSA_VAL_LO_INJECTION_HIGH_SIDE', + 'value': 1300 + }, + { + 'documentation': { + 'description': 'Configures the LO signal that the NI-RFSA device generates at a frequency lower than the RF frequency. This LO frequency is given by the formula fLO = fRF - fIF.' + }, + 'name': 'NIRFSA_VAL_LO_INJECTION_LOW_SIDE', + 'value': 1301 + } + ] + }, + 'LoNumber': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Selects LO2, which is the 4 GHz signal path.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO2', + 'value': 2201 + }, + { + 'documentation': { + 'description': 'Selects LO3, which is the 800 MHz signal path.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO3', + 'value': 2202 + }, + { + 'documentation': { + 'description': 'Selects LO1, which is the 3.2 GHz to 8.3 GHz variable signal path.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO1', + 'value': 2200 + } + ] + }, + 'LoOutExportConfigureFromRfsg': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Do not allow NI-RFSG to control the NI-RFSA local oscillator export.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Allow NI-RFSG to control the NI-RFSA local oscillator export.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'LoPathSel': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that the LO path 1 is used.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_PATH_1', + 'python_name': 'EXT_CAL_LO_PATH_1', + 'value': 2300 + }, + { + 'documentation': { + 'description': 'Specifies that the LO path 2 is used.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_PATH_2', + 'python_name': 'EXT_CAL_LO_PATH_2', + 'value': 2301 + }, + { + 'documentation': { + 'description': 'Specifies that the LO path 3 is used.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_PATH_3', + 'python_name': 'EXT_CAL_LO_PATH_3', + 'value': 2302 + }, + { + 'documentation': { + 'description': 'Specifies that the LO path 4 is used.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_PATH_4', + 'python_name': 'EXT_CAL_LO_PATH_4', + 'value': 2303 + }, + { + 'documentation': { + 'description': 'Specifies that the LO path 5 is used.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_LO_PATH_5', + 'python_name': 'EXT_CAL_LO_PATH_5', + 'value': 2304 + } + ] + }, + 'LoPllFractionalModeEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables fractional mode for the LO PLL.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables fractional mode for the LO PLL.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'LoSource': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Specifies that no LO source is required to downconvert the RF input signal.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 'None' + }, + { + 'documentation': { + 'description': 'Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655.' + }, + 'name': 'NIRFSA_VAL_ONBOARD', + 'value': 'Onboard' + }, + { + 'documentation': { + 'description': 'Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel.' + }, + 'name': 'NIRFSA_VAL_LO_IN', + 'value': 'LO_In' + }, + { + 'documentation': { + 'description': 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid on only the PXIe-5831 with PXIe-5653 (LO1 stage only) or PXIe-5832 with PCIe-5653 (LO1 stage only).' + }, + 'name': 'NIRFSA_VAL_LO_SOURCE_SECONDARY', + 'value': 'Secondary' + }, + { + 'documentation': { + 'description': 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655.' + }, + 'name': 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED', + 'value': 'SG_SA_Shared' + } + ] + }, + 'LoYigMainCoilDrive': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Adjusts the YIG main coil on the LO for an underdamped response.' + }, + 'name': 'NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_NORMAL', + 'value': 2400 + }, + { + 'documentation': { + 'description': 'Adjusts the YIG main coil on the LO for an overdamped response.' + }, + 'name': 'NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_FAST', + 'value': 2401 + } + ] + }, + 'LoadConfigurationResetOptions': { + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSA resets all configurations.' + }, + 'name': 'NIRFSA_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', + 'value': 0 + }, + { + 'documentation': { + 'description': 'NI-RFSA skips resetting the de-embedding tables.' + }, + 'name': 'NIRFSA_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES', + 'value': 2 + } + ] + }, + 'NoiseSourcePowerEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the noise source power.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables the noise source power.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'NotchFilterEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables the notch filter.' + }, + 'name': 'NIRFSA_VAL_NOTCH_FILTER_DISABLED', + 'value': 3400 + }, + { + 'documentation': { + 'description': 'The notch filter is automatically enabled when it is in the signal path and automatically disabled when it is not in the signal path.' + }, + 'name': 'NIRFSA_VAL_NOTCH_FILTER_ENABLED_WHEN_IN_SIGNAL_PATH', + 'value': 3401 + }, + { + 'documentation': { + 'description': 'Enables the notch filter. If the notch filter is not in the signal path or if the notch filter is not supported on the device, NI-RFSA returns an error. Select NIRFSA_VAL_NOTCH_FILTER_ENABLED_WHEN_IN_SIGNAL_PATH whenever possible to avoid an error.' + }, + 'name': 'NIRFSA_VAL_NOTCH_FILTER_ENABLED', + 'value': 3402 + } + ] + }, + 'OutputTerm': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The signal is not exported.' + }, + 'name': 'NIRFSA_VAL_DO_NOT_EXPORT', + 'value': '' + }, + { + 'documentation': { + 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_CLK_OUT', + 'value': 'ClkOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_REF_OUT', + 'value': 'RefOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + }, + 'name': 'NIRFSA_VAL_REF_OUT2', + 'value': 'RefOut2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' + }, + 'name': 'NIRFSA_VAL_PFI0', + 'value': 'PFI0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI 1.' + }, + 'name': 'NIRFSA_VAL_PFI1', + 'value': 'PFI1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 0.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG0', + 'value': 'PXI_Trig0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 1.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG1', + 'value': 'PXI_Trig1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 2.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG2', + 'value': 'PXI_Trig2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 3.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG3', + 'value': 'PXI_Trig3' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 4.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG4', + 'value': 'PXI_Trig4' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 5.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG5', + 'value': 'PXI_Trig5' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 6.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG6', + 'value': 'PXI_Trig6' + }, + { + 'documentation': { + 'description': 'The trigger is received on PXI trigger line 7.' + }, + 'name': 'NIRFSA_VAL_PXI_TRIG7', + 'value': 'PXI_Trig7' + }, + { + 'documentation': { + 'description': 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' + }, + 'name': 'NIRFSA_VAL_PXI_STAR', + 'value': 'PXI_STAR' + }, + { + 'documentation': { + 'description': 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_PXIE_DSTARB', + 'value': 'PXIe_DStarB' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI0', + 'value': 'DIO/PFI0' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI1', + 'value': 'DIO/PFI1' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI2', + 'value': 'DIO/PFI2' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI3', + 'value': 'DIO/PFI3' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI4', + 'value': 'DIO/PFI4' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI5', + 'value': 'DIO/PFI5' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI6', + 'value': 'DIO/PFI6' + }, + { + 'documentation': { + 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' + }, + 'name': 'NIRFSA_VAL_DIO_PFI7', + 'value': 'DIO/PFI7' + }, + { + 'documentation': { + 'description': 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' + }, + 'name': 'NIRFSA_VAL_TIMER_EVENT', + 'value': 'TimerEvent' + } + ] + }, + 'OverflowErrorReporting': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Configures NI-RFSA to return a warning when an ADC or onboard signal processing (OSP) overflow occurs.' + }, + 'name': 'NIRFSA_VAL_ERROR_REPORTING_WARNING', + 'value': 1301 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA to not return an error or a warning when an ADC or OSP overflow occurs.' + }, + 'name': 'NIRFSA_VAL_ERROR_REPORTING_DISABLED', + 'value': 1302 + } + ] + }, + 'PowerSpectrumUnits': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Units are dB with reference to 1 milliwatt.' + }, + 'name': 'NIRFSA_VAL_DBM', + 'value': 200 + }, + { + 'documentation': { + 'description': 'Units are in volts squared.' + }, + 'name': 'NIRFSA_VAL_VOLTS_SQUARED', + 'value': 201 + }, + { + 'documentation': { + 'description': 'Units are dB with reference to 1 millivolt.' + }, + 'name': 'NIRFSA_VAL_DBMV', + 'value': 202 + }, + { + 'documentation': { + 'description': 'Units are dB with reference to 1 microvolt.' + }, + 'name': 'NIRFSA_VAL_DBUV', + 'value': 203 + }, + { + 'documentation': { + 'description': 'Units are in volts.' + }, + 'name': 'NIRFSA_VAL_VOLTS', + 'value': 204 + }, + { + 'documentation': { + 'description': 'Units are in watts.' + }, + 'name': 'NIRFSA_VAL_WATTS', + 'value': 205 + } + ] + }, + 'PxiChassisClk10Source': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The device does not drive the PXI 10 MHz backplane Reference Clock.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 'None' + }, + { + 'documentation': { + 'description': 'The device drives the PXI 10 MHz backplane Reference Clock with the PXI-5600 onboard clock. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O connector on the PXI-5600 front panel to use this option.' + }, + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'value': 'OnboardClock' + }, + { + 'documentation': { + 'description': 'The device drives the PXI 10 MHz backplane Reference Clock with the reference source attached to the PXI-5600 FREQ REF IN connector. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O connector on the PXI-5600 front panel to use this option.' + }, + 'name': 'NIRFSA_VAL_REF_IN', + 'value': 'RefIn' + } + ] + }, + 'ReferenceTriggerOspDelayEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables OSP delay for the Reference Trigger.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables OSP delay for the Reference Trigger.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'ReferenceClockExportedRate': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Exports a 10 MHz Reference Clock.' + }, + 'name': 'NIRFSA_VAL_10MHZ', + 'python_name': '_10MHZ', + 'value': 10000000 + }, + { + 'documentation': { + 'description': 'Exports a 100 MHz Reference Clock.' + }, + 'name': 'NIRFSA_VAL_100MHZ', + 'python_name': '_100MHZ', + 'value': 100000000 + }, + { + 'documentation': { + 'description': 'Exports a 1 GHz Reference Clock.' + }, + 'name': 'NIRFSA_VAL_1GHZ', + 'python_name': '_1GHZ', + 'value': 1000000000.0 + } + ] + }, + 'ReferenceClockExportedTerminal': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 'None' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_REF_OUT', + 'value': 'RefOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' + }, + 'name': 'NIRFSA_VAL_REF_OUT2', + 'value': 'RefOut2' + }, + { + 'documentation': { + 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' + }, + 'name': 'NIRFSA_VAL_CLK_OUT', + 'value': 'ClkOut' + }, + { + 'documentation': { + 'description': 'Export the clock on the REF OUT terminal on the PXIe-5694. This value is valid only for the PXIe-5667.' + }, + 'name': 'NIRFSA_VAL_IF_COND_REF_OUT', + 'value': 'IFCondRefOut' + } + ] + }, + 'ReferenceClockSource': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 'None' + }, + { + 'documentation': { + 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**PXIe-5830/5831 **For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector.**PXIe-5831/5832 with PXIe-5653 **Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**PXIe-5841 with PXIe-5655 **Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector.**PXIe-5842 **Lock to the PXIe-5655 onboard clock. Cables between modules are required as shown in the User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock.' + }, + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'value': 'OnboardClock' + }, + { + 'documentation': { + 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the signal at the external FREQ REF IN connector on the PXI-5600**PXIe-5663/5663E **Connect the external signal to the PXI/PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, this configuration can only be used in external digitizer mode.**PXIe-5665 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5667 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5668 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT on the PXIe-5606 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the **clock rate** parameter according to the frequency of your external clock signal.**PXIe-5694 **Connect the Reference Clock signal to the REF/LO IN connector on the PXIe-5694 front panel.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to the signal at the external REF IN connector.**PXIe-5830/5831 **For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector.**PXIe-5831/5832 with PXIe-5653 **Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.**PXIe-5841 with PXIe-5655 **Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. **PXIe-5842 **Lock to the signal at the REF IN connector on the associated PXIe-5655. Cables between modules are required as shown in the User Manual for the instrument. PXIe-5860 Lock to the signal at the REF IN connector on the PXIe-5860.' + }, + 'name': 'NIRFSA_VAL_REF_IN', + 'value': 'RefIn' + }, + { + 'documentation': { + 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI backplane clock using the PXI-5600. You must connect the PXI 10 MHz connector to the REF IN connector on the PXI-5600 front panel to use this option. **PXIe-5668 **Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT to the LO2 IN connector on the PXIe-5624.**PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **Lock the device to the PXI backplane clock.' + }, + 'name': 'NIRFSA_VAL_PXI_CLK', + 'value': 'PXI_Clk' + }, + { + 'documentation': { + 'description': '**PXI-5661 **This configuration does not apply to the PXI-5661.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXI/PXIe-5652.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5668 **Lock the PXIe-5668 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the **clock rate** parameter to 100 MHz.**PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **This configuration does not apply.' + }, + 'name': 'NIRFSA_VAL_CLK_IN', + 'value': 'ClkIn' + }, + { + 'documentation': { + 'description': '**PXIe-5831/5832 with PXIe-5653 **NI-RFSA configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5840/5841/5841 with PXIe-5655 /5842/5860**This configuration does not apply.' + }, + 'name': 'NIRFSA_VAL_PXI_CLK_MASTER', + 'value': 'PXI_ClkMaster' + }, + { + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655 **This configuration does not apply.' + }, + 'name': 'NIRFSA_VAL_REF_IN_2', + 'value': 'RefIn2' + } + ] + }, + 'ReferenceLevelDataType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The data is the configuration data when the mechanical relay is disabled. Use this option to save uncalibrated measurements for more advanced operations.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_MECHANICAL_ATTENUATOR_DISABLED', + 'value': 1801 + }, + { + 'documentation': { + 'description': ' The data is the default configuration data.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_DEFAULT', + 'value': 1800 + } + ] + }, + 'ReferenceTriggerDigitalEdgeEdge': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The trigger asserts on the rising edge of the signal.' + }, + 'name': 'NIRFSA_VAL_RISING_EDGE', + 'value': 900 + }, + { + 'documentation': { + 'description': 'The trigger asserts on the falling edge of the signal' + }, + 'name': 'NIRFSA_VAL_FALLING_EDGE', + 'value': 901 + } + ] + }, + 'ReferenceTriggerIqPowerEdgeSlope': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The trigger asserts when the signal power is rising.' + }, + 'name': 'NIRFSA_VAL_RISING_SLOPE', + 'value': 1000 + }, + { + 'documentation': { + 'description': 'The trigger asserts when the signal power is falling.' + }, + 'name': 'NIRFSA_VAL_FALLING_SLOPE', + 'value': 1001 + } + ] + }, + 'ReferenceTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No Reference Trigger is configured.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 600 + }, + { + 'documentation': { + 'description': 'The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_REF_TRIGGER_SOURCE attribute.' + }, + 'name': 'NIRFSA_VAL_DIGITAL_EDGE', + 'value': 601 + }, + { + 'documentation': { + 'description': 'The Reference Trigger is asserted when the signal is changing past the level specified with the slope (rising or falling) configured with the NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_SLOPE attribute.' + }, + 'name': 'NIRFSA_VAL_IQ_POWER_EDGE', + 'value': 603 + }, + { + 'documentation': { + 'description': 'The Reference Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_REF_TRIGGER as the **trigger** parameter.' + }, + 'name': 'NIRFSA_VAL_SOFTWARE_EDGE', + 'value': 604 + }, + { + 'documentation': { + 'description': 'The Reference Trigger is asserted when the I or Q signal is changed past the level specified with the slope configured with the NIRFSA_ATTR_IQ_ANALOG_EDGE_REF_TRIGGER_SLOPE attribute. This value is valid only for PXIe-5644/5645 devices.' + }, + 'name': 'NIRFSA_VAL_IQ_ANALOG_EDGE', + 'value': 605 + } + ] + }, + 'ResetWithOptionsStepsToOmit': { + 'codegen_method': 'public', + 'class': 'IntFlag', + 'values': [ + { + 'documentation': { + 'description': 'Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_DEEMBEDDING_TABLES', + 'value': 2 + }, + { + 'documentation': { + 'description': 'No step is omitted during reset.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_NONE', + 'value': 0 + }, + { + 'documentation': { + 'description': 'Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES', + 'value': 1 + } + ] + }, + 'RfLbSigCondPathSel': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'yet to be defined ' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_LOWBAND_SIGNAL_CONDITIONING_PATH_1', + 'python_name': 'EXT_CAL_RF_LOWBAND_SIGNAL_CONDITIONING_PATH_1', + 'value': 3700 + }, + { + 'documentation': { + 'description': 'yet to be defined ' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_LOWBAND_SIGNAL_CONDITIONING_PATH_2', + 'python_name': 'EXT_CAL_RF_LOWBAND_SIGNAL_CONDITIONING_PATH_2', + 'value': 3701 + } + ] + }, + 'RfPathSelection': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': ' The data is the default configuration data.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_BAND_1', + 'python_name': 'EXT_CAL_RF_BAND_1', + 'value': 1700 + }, + { + 'documentation': { + 'description': 'The data is the configuration data when the mechanical relay is disabled. Use this option to save uncalibrated measurements for more advanced operations.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_BAND_2', + 'python_name': 'EXT_CAL_RF_BAND_2', + 'value': 1701 + }, + { + 'documentation': { + 'description': ' The data is the default configuration data.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_BAND_3', + 'python_name': 'EXT_CAL_RF_BAND_3', + 'value': 1702 + }, + { + 'documentation': { + 'description': ' The data is the default configuration data.' + }, + 'name': 'NIRFSA_VAL_EXT_CAL_RF_BAND_4', + 'python_name': 'EXT_CAL_RF_BAND_4', + 'value': 1703 + } + ] + }, + 'SelfCalibrationStep': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Calls for preselector alignment. ' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', + 'value': 1 + }, + { + 'documentation': { + 'description': 'Measures the changes in gain since the last external calibration was run.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', + 'value': 2 + }, + { + 'documentation': { + 'description': 'Measures the IF response of the entire system for each of the supported IF filters' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', + 'value': 4 + }, + { + 'documentation': { + 'description': 'Calls for digitizer self-calibration, if the digitizer is associated with the RF downconverter.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', + 'value': 8 + }, + { + 'documentation': { + 'description': 'Calls for LO self-calibration, if the LO source module is associated with the RF downconverter.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', + 'value': 16 + }, + { + 'documentation': { + 'description': 'Selects the Amplitude Accuracy self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', + 'value': 32 + }, + { + 'documentation': { + 'description': 'Selects the Residual LO Power self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', + 'value': 64 + }, + { + 'documentation': { + 'description': 'Selects the Image Suppression self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', + 'value': 128 + }, + { + 'documentation': { + 'description': 'Selects the Synthesizer Alignment self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', + 'value': 256 + }, + { + 'documentation': { + 'description': 'Selects the DC Offset self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', + 'value': 512 + } + ] + }, + 'SelfCalibrateRangeStepsToOmit': { + 'class': 'IntFlag', + 'values': [ + { + 'documentation': { + 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', + 'value': 8 + }, + { + 'documentation': { + 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', + 'value': 1 + }, + { + 'documentation': { + 'description': 'No calibration steps are omitted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_OMIT_NONE', + 'value': 0 + }, + { + 'documentation': { + 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', + 'value': 2 + }, + { + 'documentation': { + 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', + 'value': 4 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', + 'value': 10 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', + 'value': 20 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', + 'value': 40 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', + 'value': 80 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', + 'value': 100 + }, + { + 'documentation': { + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', + 'value': 200 + } + ] + }, + 'Signal': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSA routes a Start Trigger.' + }, + 'name': 'NIRFSA_VAL_START_TRIGGER', + 'value': 1100 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a Reference' + }, + 'name': 'NIRFSA_VAL_REF_TRIGGER', + 'value': 702 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes an Advance' + }, + 'name': 'NIRFSA_VAL_ADVANCE_TRIGGER', + 'value': 1102 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a Ready for Start Event.' + }, + 'name': 'NIRFSA_VAL_READY_FOR_START_EVENT', + 'value': 1200 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a Ready for Reference Event..' + }, + 'name': 'NIRFSA_VAL_READY_FOR_REF_EVENT', + 'value': 1201 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a End of Record Event.' + }, + 'name': 'NIRFSA_VAL_END_OF_RECORD_EVENT', + 'value': 1203 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a Done Event.' + }, + 'name': 'NIRFSA_VAL_DONE_EVENT', + 'value': 1204 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a Reference Clock.' + }, + 'name': 'NIRFSA_VAL_REF_CLOCK', + 'value': 1205 + }, + { + 'documentation': { + 'description': 'NI-RFSA routes a User Defined Signal.' + }, + 'name': 'NIRFSA_VAL_USER', + 'value': 1206 + } + ] + }, + 'SignalConditioningEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Enables signal conditioning.' + }, + 'name': 'NIRFSA_VAL_SIGNAL_CONDITIONING_ENABLED', + 'value': 3600 + }, + { + 'documentation': { + 'description': 'Bypasses all signal conditioning.' + }, + 'name': 'NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED', + 'value': 3601 + } + ] + }, + 'SmoothSpectrumEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables spectrum smoothing.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables spectrum smoothing.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'SparameterOrientation': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Port 1 of the S2P is oriented towards the DUT port.' + }, + 'name': 'NIRFSA_VAL_PORT1_TOWARDS_DUT', + 'value': 3800 + }, + { + 'documentation': { + 'description': 'Port 2 of the S2P is oriented towards the DUT port.' + }, + 'name': 'NIRFSA_VAL_PORT2_TOWARDS_DUT', + 'value': 3801 + } + ] + }, + 'SpectrumAveragingMode': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Configures NI-RFSA to perform no averaging on acquisitions.' + }, + 'name': 'NIRFSA_VAL_NO_AVERAGING', + 'value': 400 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA for root-mean-square (RMS) averaging. RMS averaging reduces signal fluctuations but not the noise floor. RMS averaging averages the energy, or power, of the signal. This averaging prevents noise floor reduction and gives averaged RMS quantities of single-channel measurements zero phase. RMS averaging for dual-channel measurements preserves important phase information.' + }, + 'name': 'NIRFSA_VAL_RMS_AVERAGING', + 'value': 401 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA for vector averaging. Vector averaging reduces noise from synchronous signals. Vector averaging computes the average of complex quantities directly, which means that it allows separate averaging for real and imaginary parts. Complex averaging such as vector averaging reduces noise and usually requires a trigger to improve block-to-block phase coherence.' + }, + 'name': 'NIRFSA_VAL_VECTOR_AVERAGING', + 'value': 402 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA for peak-hold averaging. Peak-hold averaging retains the RMS peak levels of the averaged quantities. The peak-hold averaging process performs peak-hold at each frequency bin separately to retain peak RMS levels from one FFT record to the next.' + }, + 'name': 'NIRFSA_VAL_PEAK_HOLD_AVERAGING', + 'value': 403 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA to perform no averaging on acquisitions.' + }, + 'name': 'NIRFSA_VAL_MIN_HOLD_AVERAGING', + 'value': 404 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA to perform no averaging on acquisitions.' + }, + 'name': 'NIRFSA_VAL_SCALAR_AVERAGING', + 'value': 405 + }, + { + 'documentation': { + 'description': 'Configures NI-RFSA to perform no averaging on acquisitions.' + }, + 'name': 'NIRFSA_VAL_LOG_AVERAGING', + 'value': 406 + } + ] + }, + 'SpectrumFftWindowType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No window is applied.' + }, + 'name': 'NIRFSA_VAL_UNIFORM', + 'value': 500 + }, + { + 'documentation': { + 'description': 'The Hanning window is useful for analyzing transients longer than the time duration of the window, and also for general-purpose applications.' + }, + 'name': 'NIRFSA_VAL_HANNING', + 'value': 501 + }, + { + 'documentation': { + 'description': 'A Hamming window is applied to the waveform using the following equation: y[i] = x[i] * (0.54 - 0.46cos(w)) where w = (2)i/n and n = the waveform size. Note: Hanning and Hamming windows are somewhat similar. However, in the time domain, the Hamming window does not get as close to zero near the edges as does the Hanning window.' + }, + 'name': 'NIRFSA_VAL_HAMMING', + 'value': 502 + }, + { + 'documentation': { + 'description': 'A Blackman-Harris window is applied to the waveform using the following equation: y[i] = x[i] * (0.42323 - 0.49755*cos(w) + 0.07922*cos(2w))' + }, + 'name': 'NIRFSA_VAL_BLACKMAN_HARRIS', + 'value': 503 + }, + { + 'documentation': { + 'description': 'An Exact Blackman window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w))' + }, + 'name': 'NIRFSA_VAL_EXACT_BLACKMAN', + 'value': 504 + }, + { + 'documentation': { + 'description': 'A Blackman window is useful for analyzing transient signals, and provides similar windowing to Hanning and Hamming windows but adds one additional cosine term to reduce ripple. A Blackman window is applied to the waveform using the following equation: y[i] = x[i] * (0.42 - 0.50*cos(w) + 0.08*cos(2w))' + }, + 'name': 'NIRFSA_VAL_BLACKMAN', + 'value': 505 + }, + { + 'documentation': { + 'description': 'The fifth-order Flat Top window has the best amplitude accuracy of all the window functions. The increased amplitude accuracy (0.02 dB for signals exactly between integral cycles) is at the expense of frequency selectivity. The Flat Top window is most useful in accurately measuring the amplitude of single frequency components with little nearby spectral energy in the signal. A fifth-order Flat Top window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w) + a4*cos(4w))' + }, + 'name': 'NIRFSA_VAL_FLAT_TOP', + 'value': 506 + }, + { + 'documentation': { + 'description': 'A 4-term Blackman-Harris window is a general purpose window; it has side-lobe rejection in the upper 90 dB, with moderately wide side lobe. A 4-term Blackman Harris window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w))' + }, + 'name': 'NIRFSA_VAL_4_TERM_BLACKMAN_HARRIS', + 'python_name': '_4_TERM_BLACKMAN_HARRIS', + 'value': 507 + }, + { + 'documentation': { + 'description': 'A 7-term Blackman-Harris window has the highest dynamic range; it is ideal for signal-to-noise ratio applications. A 7-term Blackman Harris window is applied to the waveform using the following equation: y[i] = x[i] * (a0 - a1*cos(w) + a2*cos(2w) - a3*cos(3w) + a4*cos(4w) - a5*cos(5w) + a6*cos(6w))' + }, + 'name': 'NIRFSA_VAL_7_TERM_BLACKMAN_HARRIS', + 'python_name': '_7_TERM_BLACKMAN_HARRIS', + 'value': 508 + }, + { + 'documentation': { + 'description': 'The Low Side Lobe window further reduces the size of the main lobe. The following equation defines the Low Side Lobe window. where *N* is the length of window' + }, + 'name': 'NIRFSA_VAL_LOW_SIDE_LOBE', + 'value': 509 + }, + { + 'documentation': { + 'description': 'A Gaussian window is applied to the waveform using the following equation: y[i] = x[i] * exp(-0.5*(i - (N-1)/2)^2 / ((N-1)/2)^2) where N is the length of the window' + }, + 'name': 'NIRFSA_VAL_GAUSSIAN', + 'value': 510 + }, + { + 'documentation': { + 'description': 'A Kaiser-Bessel window is applied to the waveform using the following equation: y[i] = x[i] * I0(β*sqrt(1 - (2i/(N-1) - 1)^2))/I0(β) where i is between 0 and N-1, N is the length of the window, β determines the shape of the window, and I0 is the zeroth order Modified Bessel function of the first kind' + }, + 'name': 'NIRFSA_VAL_KAISER_BESSEL', + 'value': 511 + } + ] + }, + 'SpectrumResolutionBandwidthType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Defines the resolution bandwidth (RBW) in terms of the 3 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + }, + 'name': 'NIRFSA_VAL_RBW_THREE_DECIBELS', + 'value': 300 + }, + { + 'documentation': { + 'description': 'Defines the RBW in terms of the 6 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + }, + 'name': 'NIRFSA_VAL_RBW_SIX_DECIBELS', + 'value': 301 + }, + { + 'documentation': { + 'description': 'Defines the RBW in terms of the display resolution, which is the ratio of the sampling frequency to the number of samples that you acquire.' + }, + 'name': 'NIRFSA_VAL_RBW_BIN_WIDTH', + 'value': 302 + }, + { + 'documentation': { + 'description': 'Defines the RBW in terms of the equivalent noise bandwidth (ENBW) of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' + }, + 'name': 'NIRFSA_VAL_RBW_EQUIVALENT_NOISE_BANDWIDTH', + 'value': 303 + } + ] + }, + 'StartTriggerDigitalEdgeEdge': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The trigger asserts on the rising edge of the signal.PXI-5661, PXIe-5663/5663E/5665/5668' + }, + 'name': 'NIRFSA_VAL_RISING_EDGE', + 'value': 900 + }, + { + 'documentation': { + 'description': 'The trigger asserts on the falling edge of the signal | PXIe-5668 ' + }, + 'name': 'NIRFSA_VAL_FALLING_EDGE', + 'value': 901 + } + ] + }, + 'StartTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'No Start Trigger is configured.' + }, + 'name': 'NIRFSA_VAL_NONE', + 'value': 600 + }, + { + 'documentation': { + 'description': 'The Start Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the NIRFSA_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute.' + }, + 'name': 'NIRFSA_VAL_DIGITAL_EDGE', + 'value': 601 + }, + { + 'documentation': { + 'description': 'The Start Trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the nirfsa_SendSoftwareEdgeTrigger function and selecting NIRFSA_VAL_START_TRIGGER as the value of the **trigger** parameter.' + }, + 'name': 'NIRFSA_VAL_SOFTWARE_EDGE', + 'value': 604 + } + ] + }, + 'StepsToOmit': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_DEEMBEDDING_TABLES', + 'value': 2 + }, + { + 'documentation': { + 'description': 'No step is omitted during reset.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_NONE', + 'value': 0 + }, + { + 'documentation': { + 'description': 'Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.' + }, + 'name': 'NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES', + 'value': 1 + } + ] + }, + 'SyncRefTriggerDelayEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables synchronization reference trigger delay.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables synchronization reference trigger delay.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, + 'SoftwareTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSA sends a Start software trigger.' + }, + 'name': 'NIRFSA_VAL_START_TRIGGER', + 'value': 1100 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends a Reference software trigger. ' + }, + 'name': 'NIRFSA_VAL_REF_TRIGGER', + 'value': 702 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends an Advance software trigger.' + }, + 'name': 'NIRFSA_VAL_ADVANCE_TRIGGER', + 'value': 1102 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends an Arm Reference software trigger. This trigger is not valid for the PXIe-5668.' + }, + 'name': 'NIRFSA_VAL_ARM_REF_TRIGGER', + 'value': 1103 + } + ] + }, + 'UserSourcePulseWidthUnits': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Units are seconds.' + }, + 'name': 'NIRFSA_VAL_PULSE_WIDTH_UNITS_SECONDS', + 'value': 6200 + }, + { + 'documentation': { + 'description': 'Units are clock periods.' + }, + 'name': 'NIRFSA_VAL_PULSE_WIDTH_UNITS_CLOCK_PERIODS', + 'value': 6201 + } + ] + } +} diff --git a/src/nirfsa/metadata/enums_addon.py b/src/nirfsa/metadata/enums_addon.py new file mode 100644 index 000000000..48c253a67 --- /dev/null +++ b/src/nirfsa/metadata/enums_addon.py @@ -0,0 +1,9 @@ +# These dictionaries are applied to the generated enums dictionary at build time +# Any changes to the API should be made here. enums.py is code generated + +enums_override_metadata = { +} + +enums_additional_enums = { +} + diff --git a/src/nirfsa/metadata/functions.py b/src/nirfsa/metadata/functions.py new file mode 100644 index 000000000..18aea8b00 --- /dev/null +++ b/src/nirfsa/metadata/functions.py @@ -0,0 +1,5360 @@ +# -*- coding: utf-8 -*- +# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +functions = { + 'Abort': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Stops an acquisition previously started with the nirfsa_Initiate function or the nirfsa_ReadPowerSpectrumF64 function.\n\nYou can also use the nirfsa_Abort function to stop a self-calibration. Calling this function is optional, unless you want to stop an acquisition before it is complete or you are continuously acquiring data.\n\nYou can stop the following kinds of acquisitions:\n\n- Triggered spectrum acquisitions that have not yet been triggered\n- Multispan acquisitions in progress\n- Average spectrum acquisitions in progress\n- Single-record spectrum acquisitions in progress\n- Streaming in progress\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ChangeExternalCalibrationPassword': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Changes the password that is required to initialize an external calibration session.\n\n**Supported Devices**: PXIe-5601/5603/5605/5606, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the old (current) external calibration password.\n\nThe maximum length of the password varies by device.', + }, + 'name': 'oldPassword', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the new (desired) external calibration password.\n\nThe maximum length of the password varies by device.', + }, + 'name': 'newPassword', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'CheckAcquisitionStatus': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Checks the status of the acquisition.\n\nUse this function to check for any errors that may occur during signal acquisition or to check whether the device has completed the acquisition operation.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns signal acquisition status.\n\n|Value |Description |\n|:---------|:------------------------------------|\n| VI_TRUE | Signal acquisition is complete. |\n| VI_FALSE | Signal acquisition is not complete. |', + }, + 'name': 'isDone', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ClearSelfCalibrateRange': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Clears the data obtained from the nirfsa_SelfCalibrateRange function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'close': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Closes the session to the device.\n\nIf you close a session that has Soft Front Panel (SFP) session access enabled, any application connected to the shared device session is no longer usable. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about using SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'grpc_name': 'Close', + 'is_error_handling': False, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': '_close', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'Commit': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Commits settings to hardware.\n\nCalling this function is optional. Settings are automatically committed to hardware when you call the nirfsa_Initiate function, the read IQ single record complex F64 function, or the nirfsa_ReadPowerSpectrumF64 function.\n\n----\n**Note**\nThis function does not wait for settling time, unlike the nirfsa_Initiate function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDeembeddingTableInterpolationLinear': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nSelects the linear interpolation method.\n\nIf the carrier frequency does not match a row in the de-embedding table, NI-RFSA performs a linear interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the format of parameters to interpolate. **Defined Values** :', + 'table_body': [ + [ + 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_REAL_AND_IMAGINARY', + 'Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.' + ], + [ + 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_AND_PHASE', + 'Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.' + ], + [ + 'NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_DB_AND_PHASE', + 'Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'LinearInterpolationFormat', + 'name': 'format', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDeembeddingTableInterpolationNearest': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nSelects the nearest interpolation method.\n\nNI-RFSA uses the parameters of the table nearest to the carrier frequency for de-embedding.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDeembeddingTableInterpolationSpline': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nSelects the spline interpolation method.\n\nIf the carrier frequency does not match a row in the de-embedding table, NI-RFSA performs a spline interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDigitalEdgeAdvanceTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a digital edge Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the source of the digital edge for the Advance Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB (\'PXIE_DSTARB\') | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI0\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI1\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI2\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI3\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI4\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI5\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI6\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI7\') | The trigger is received on PFI 7 of the DIO Terminal. |', + }, + 'grpc_name': 'source_raw', + 'name': 'source', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + }, + 'enum': 'AdvanceTriggerDigitalEdgeEdge', + 'name': 'edge', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDigitalEdgeRefTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a digital edge Reference Trigger to mark a reference point within the record.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the source of the digital edge for the Reference trigger.\n\n|Value |Description |\n|:-------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB (\'PXIE_DSTARB\') | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI0\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI1\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI2\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI3\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI4\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI5\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI6\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI7\') | The trigger is received on PFI 7 of the DIO Terminal. |', + }, + 'grpc_name': 'source_raw', + 'name': 'source', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n|Value |Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + }, + 'enum': 'ReferenceTriggerDigitalEdgeEdge', + 'name': 'edge', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': '0', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + }, + 'name': 'pretriggerSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureDigitalEdgeStartTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a digital edge Start Trigger at the beginning of the acquisition.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the source of the digital edge for the Start Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB (\'PXIE_DSTARB\') | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI1\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI2\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI3\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI4\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI5\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI6\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI7\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI8\') | The trigger is received on PFI 7 of the DIO Terminal. |', + }, + 'grpc_name': 'source_raw', + 'name': 'source', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + }, + 'enum': 'StartTriggerDigitalEdgeEdge', + 'name': 'edge', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureIQPowerEdgeRefTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for the complex power of the I/Q data to cross the specified threshold to mark a reference point within the record.\n\nTo trigger on burst signals, add a minimum quiet time, configured with the NIRFSA_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME attribute, to ensure the trigger does not occur in the middle of a burst if the acquisition starts while a burst is being generated. The quiet time should be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'grpc_name': 'ConfigureIQPowerEdgeRefTrigger', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the source of the RF signal for the power edge Reference trigger. The only supported value is "0".', + }, + 'name': 'source', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the threshold, in dBm, above or below which the device triggers.', + }, + 'name': 'level', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies whether the device detects a positive or negative slope on the trigger signal. The default value is NIRFSA_VAL_RISING_SLOPE.\n\n| Value | Description |\n|:--------------------------------|:-------------------------------------------------|\n| NIRFSA_VAL_RISING_SLOPE (1000) | NI-RFSA detects a rising edge (positive slope). |\n| NIRFSA_VAL_FALLING_SLOPE (1001) | NI-RFSA detects a falling edge (negative slope). |', + }, + 'enum' : 'ReferenceTriggerIqPowerEdgeSlope', + 'name': 'slope', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': '0', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + }, + 'name': 'pretriggerSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureRefClock': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the NI-RFSA device Reference Clock.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXI-5661 Reference Clock `_\n\n`PXIe-5663 Timing Configurations `_\n\n`PXIe-5665 Timing Configurations `_\n\n`PXIe-5667 Timing Configurations `_\n\n`PXIe-5668 Timing Configurations `_\n\n`PXIe-5830 Timing Configurations `_\n\n`PXIe-5831 Timing Configurations `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'specifies the source of the Reference Clock signal.\n| Clock Source | Description |\n|-----------------------|-------------|\n| **Onboard Clock (default)** | Uses the onboard Reference Clock as the clock source.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to PXIe-5655 onboard clock. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to PXIe-5655 onboard clock. Use cables as shown in the Getting Started Guide. |\n| **RefIn** | Uses the signal at the front panel REF IN connector.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT; lock external signal to PXIe-3621 REF IN.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT; lock external signal to PXIe-3622 REF IN.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT; lock external signal to PXIe-3623 REF IN.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to signal at REF IN on PXIe-5655. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to signal at REF IN on PXIe-5655. Use cables as shown in the Getting Started Guide. |\n| **PXI Clock** | Uses the PXI_CLK signal present on the PXI backplane. |\n| **PXI_ClkMaster** | Valid only for PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.
**PXIe-5831 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3622 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN.
**PXIe-5832 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3623 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN. |', + }, + 'name': 'clockSource', + 'enum': 'ReferenceClockSource', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. This parameter is only valid when the **ref clock source** parameter is set to **RefIn**. The default value is Auto (-1.0), which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. Refer to the Reference Clock Rate property for possible values.', + }, + 'name': 'refClockRate', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSoftwareEdgeAdvanceTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a software Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins. The device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSoftwareEdgeRefTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a software Reference Trigger to mark a reference point within the record.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + }, + 'name': 'pretriggerSamples', + 'default_value': '0', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSoftwareEdgeStartTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to wait for a software Start Trigger at the beginning of the acquisition.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSpectrumFrequencyCenterSpan': { + 'codegen_method': 'private', + 'method_name_for_documentation': 'configure_spectrum_frequency', + 'documentation': { + 'description': 'Configures the span and center frequency of the spectrum read by NI-RFSA.\n\nA spectrum acquisition consists of data surrounding the center frequency.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). The NI-RFSA device you use determines the valid range. Refer to your device specifications document for more information about frequency range.', + }, + 'name': 'centerFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz).\n\n----\n\n*Note* For the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect your measurements. Refer to the NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED attribute for more information about dithering.\n\n----', + }, + 'name': 'span', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSpectrumFrequencyStartStop': { + 'codegen_method': 'private', + 'method_name_for_documentation': 'configure_spectrum_frequency', + 'documentation': { + 'description': 'Configures the start and stop frequencies of a spectrum read by NI-RFSA.\n\n----\n**Note**\nIf you configure the spectrum span (**NIRFSA_ATTR_STOP_FREQUENCY** **NIRFSA_ATTR_START_FREQUENCY**) to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you request.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the lower limit of a span of frequencies. This value is expressed in hertz (Hz).', + }, + 'name': 'startFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the upper limit of a span of frequencies. This value is expressed in hertz (Hz).', + }, + 'name': 'stopFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ConfigureSpectrumFrequencyDispatcher': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Configures the frequency range of a spectrum acquisition.\n\nYou can specify the frequency range using either center frequency and span, or start and stop frequencies.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': False, + 'is_error_handling': False, + 'method_name_for_documentation': 'configure_spectrum_frequency', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'configure_spectrum_frequency' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **span**.', + }, + 'name': 'centerFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **center_frequency**.', + }, + 'name': 'span', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the lower limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **stop_frequency**.', + }, + 'name': 'startFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the upper limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **start_frequency**.', + }, + 'name': 'stopFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'configure_spectrum_frequency', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'CreateDeembeddingSparameterTableS2PFile': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nCreates an S-parameter de-embedding table for the port based on the specified S2P file.\n\nIf you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`De-embedding Overview `_\n\n`S-parameters `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the path to the S2P file that contains de-embedding information for the specified port.', + }, + 'name': 's2pFilePath', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': ' Specifies the orientation of the data in the S2P file relative to the port on the DUT port. **Defined Values** :', + 'table_body': [ + [ + 'NIRFSA_VAL_PORT1_TOWARDS_DUT', + 'Port 1 of the S2P is oriented towards the DUT port.' + ], + [ + 'NIRFSA_VAL_PORT2_TOWARDS_DUT', + 'Port 2 of the S2P is oriented towards the DUT port.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SparameterOrientation', + 'name': 'sparameterOrientation', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'DeleteAllDeembeddingTables': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nDeletes all configured de-embedding tables for the session.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'DeleteDeembeddingTable': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nDeletes the selected de-embedding table for a given port.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'DisableAdvanceTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to not use an Advance Trigger.\n\nThis function is necessary only if you configured an Advance Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'DisableRefTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to not wait for a Reference Trigger to mark a reference point within a record.\n\nThis function is necessary only if you previously configured a Reference trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'DisableStartTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Configures the device to not wait for a Start Trigger at the beginning of the acquisition.\n\nThis function is necessary only if you previously configured a Start Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'EnableSessionAccess': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Enables or disables SFP session access for the specified instrument.\n\nSFP session access allows the NI-RFSA Soft Front Panel (SFP) to access a device with an existing open session and can help you debug your code. To enable session access, pass VI_TRUE to the **enabled** parameter. To disable session access, pass VI_FALSE to the **enabled** parameter.\n\nRefer to `Configuring SFP Session Access using LabWindows/CVI or C `_ for more information about SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n----\n**Note**\nNI-RFSA does not support NI-TClk when driver session debugging is enabled.\n\n----', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Enables or disables SFP session access for the specified device.\n\n| Value | Description |\n|:---------|:-------------------------|\n| VI_TRUE | Enables session access. |\n| VI_FALSE | Disables session access. |', + }, + 'name': 'enable', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ErrorMessage': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Converts an error code returned by an NI-RFSA function into a user-readable string.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840', + }, + 'included_in_proto': True, + 'is_error_handling': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'The ViSession handle that you obtain from nirfsa_Init or nirfsa_InitWithOptions. The handle identifies a particular instrument session.\n\nYou can pass VI_NULL for this parameter. Passing VI_NULL is useful when nirfsa_Init or nirfsa_InitWithOptions fails.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Passes the **errorCode** parameter that is returned from any NI-RFSA function.', + }, + 'grpc_name': 'status_code', + 'name': 'errorCode', + 'type': 'ViStatus', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the user-readable message string that corresponds to the error code you specify.\n\nYou must pass a ViChar array with 1024 bytes or more to this parameter. Only the first 1024 bytes of the array are used.', + }, + 'name': 'errorMessage', + 'size': { + 'mechanism': 'fixed', + 'value': 256 + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'CreateDeembeddingSparameterTableArray': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`De-embedding Overview `_', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_write_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_write_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.', + }, + 'name': 'frequencies', + 'numpy': True, + 'size': { + 'mechanism': 'len', + 'value': 'frequenciesSize' + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the frequency array.', + }, + 'name': 'frequenciesSize', + 'type': 'ViInt32', + 'use_array': False + }, + { + 'array_dimensions': 3, + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.', + }, + 'name': 'sparameterTable', + 'numpy': True, + 'size': { + 'mechanism': 'len', + 'value': 'sparameterTableSize' + }, + 'type': 'NIComplexNumber[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the S-parameter table array.', + }, + 'name': 'sparameterTableSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of DUT ports.', + }, + 'name': 'numberOfPorts', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the orientation of the input data relative to the port on the DUT port.\n\n**Defined Values** :', + 'table_body': [ + [ + 'NIRFSA_VAL_PORT1_TOWARDS_DUT', + 'Port 1 of the S2P is oriented towards the DUT port.' + ], + [ + 'NIRFSA_VAL_PORT2_TOWARDS_DUT', + 'Port 2 of the S2P is oriented towards the DUT port.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SparameterOrientation', + 'name': 'sparameterOrientation', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' + }, + 'FancyCreateDeembeddingSparameterTableArray': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`De-embedding Overview`_', + }, + 'included_in_proto': True, + 'method_name_for_documentation': 'create_deembedding_sparameter_table_array', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'create_deembedding_sparameter_table_array' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + }, + 'name': 'port', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', + }, + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.', + }, + 'name': 'frequencies', + 'numpy': True, + 'type': 'ViReal64[]', + 'type_in_documentation': 'numpy.array(dtype=numpy.float64)', + 'use_in_python_api': True + }, + { + 'array_dimensions': 3, + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.', + }, + 'name': 'sparameterTable', + 'numpy': True, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': 'numpy.array(dtype=numpy.complex128)', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the orientation of the input data relative to the port on the DUT port.\n\n**Defined Values** :', + 'table_body': [ + [ + 'NIRFSA_VAL_PORT1_TOWARDS_DUT', + 'Port 1 of the S2P is oriented towards the DUT port.' + ], + [ + 'NIRFSA_VAL_PORT2_TOWARDS_DUT', + 'Port 2 of the S2P is oriented towards the DUT port.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SparameterOrientation', + 'grpc_enum': None, + 'name': 'sparameterOrientation', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'create_deembedding_sparameter_table_array', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'GetDeembeddingSparameters': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns the S-parameters used for de-embedding a measurement on the selected port.\n\nThis includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is done.\n\nIf you want to call this function just to get the required buffer size, you can pass 0 for **S-parameter Size** and VI_NULL for the **S-parameters** buffer.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860', + 'note': 'The port orientation for the returned S-parameters is normalized to NIRFSA_VAL_PORT1_TOWARDS_DUT.' + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'get_deembedding_sparameter', + 'method_python_name_suffix': '', + 'session_filename': 'none' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'array_dimensions': 2, + 'complex_array_representation': 'complex_number_array', + 'direction': 'out', + 'documentation': { + 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.', + }, + 'name': 'sparameters', + 'numpy': True, + 'type': 'NIComplexNumber[]', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array that is returned by the NIRFSA_ATTR_SPARAMETERS output.', + }, + 'name': 'sparametersArraySize', + 'type': 'ViInt32', + 'use_array': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of S-parameters.', + }, + 'name': 'numberOfSparameters', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.', + }, + 'name': 'numberOfPorts', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' + }, + 'GetDeembeddingTableNumberOfPorts': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns the number of S-parameter ports.', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'none' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.', + }, + 'name': 'numberOfPorts', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'FancyGetDeembeddingSparameters': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nReturns the S-parameters used for de-embedding a measurement on the selected port.\n\nThis includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is done.\n\nIf you want to call this function just to get the required buffer size, you can pass 0 for **S-parameter Size** and VI_NULL for the **S-parameters** buffer.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860', + 'note': 'The port orientation for the returned S-parameters is normalized to NIRFSA_VAL_PORT1_TOWARDS_DUT.' + }, + 'included_in_proto': True, + 'method_name_for_documentation': 'get_deembedding_sparameters', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'array_dimensions': 2, + 'complex_array_representation': 'complex_number_array', + 'direction': 'out', + 'documentation': { + 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.', + }, + 'name': 'sparameters', + 'numpy': True, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': 'numpy.array(dtype=numpy.complex128)', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'get_deembedding_sparameters', + 'returns': None, + 'use_session_lock': False + }, + 'ReadIqSingleRecordDispatcher': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'included_in_proto': False, + 'is_error_handling': False, + 'method_name_for_documentation': 'read_iq_single_record', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '_into', + 'session_filename': 'read_iq_single_record' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True, + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'size': {'mechanism': 'fixed', 'value': 1}, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': 'numpy array of numpy.complex64, numpy array of numpy.complex128 or interleaved complex data in the form of numpy array of numpy.int16', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', + }, + 'name': 'dataArraySize', + 'size': {'mechanism': 'python-code', 'value': '0 if iq_data_array is None else len(iq_data_array)'}, + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'read_iq_single_record', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'ReadIQSingleRecordComplexF64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'ReadIQSingleRecordComplexF64', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'name': 'channelList', + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True, + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'size': {'mechanism': 'fixed', 'value': 1}, + 'type': 'NIComplexNumber[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', + }, + 'name': 'dataArraySize', + 'size': {'mechanism': 'python-code', 'value': '0 if iq_data_array is None else len(iq_data_array)'}, + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIQMultiRecordComplexF32': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQMultiRecordComplexF32', + 'included_in_proto': True, + 'method_name_for_documentation': 'fetch_iq_multi_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + }, + 'name': 'startingRecord', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of records to fetch.', + }, + 'name': 'numberOfRecords', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples per record.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + }, + 'name': 'iq_data_arrays', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexNumberF32[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIQMultiRecordComplexF64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQMultiRecordComplexF64', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_multi_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + }, + 'name': 'startingRecord', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of records to fetch.', + }, + 'name': 'numberOfRecords', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples per record.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + }, + 'name': 'iq_data_arrays', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexNumber[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIQMultiRecordComplexI16': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches binary I/Q data from multiple records in an acquisition.\n\nFetching transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQMultiRecordComplexI16', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_multi_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + }, + 'name': 'startingRecord', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of records to fetch.', + }, + 'name': 'numberOfRecords', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples per record.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'interleaved_real_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this interleaved data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + }, + 'name': 'iq_data_arrays', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexI16[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIqMultiRecordDispatcher': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'included_in_proto': False, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_multi_record', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '_into', + 'session_filename': 'fetch_iq_multi_record' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 0, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + }, + 'name': 'startingRecord', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': None, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of records to fetch.', + }, + 'name': 'numberOfRecords', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': None, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples per record.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q data. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + }, + 'name': 'iq_data_arrays', + 'numpy': True, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': '2D numpy.array of numpy.complex64, 2D numpy.array of numpy.complex128 or interleaved complex data in the form of 2D numpy.array of numpy.int16', + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'fetch_iq_multi_record', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'FetchIQSingleRecordComplexF32': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQSingleRecordComplexF32', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_single_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + }, + 'name': 'recordNumber', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumberF32 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexNumberF32[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIQSingleRecordComplexF64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQSingleRecordComplexF64', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_single_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + }, + 'name': 'recordNumber', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexNumber[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIQSingleRecordComplexI16': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Fetches binary I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'grpc_name': 'FetchIQSingleRecordComplexI16', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_single_record', + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + }, + 'name': 'recordNumber', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'interleaved_real_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Returns the acquired waveform. Allocate an NIComplexI16 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'type': 'NIComplexI16[]', + 'use_array': True, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + }, + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'FetchIqSingleRecordDispatcher': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + }, + 'included_in_proto': False, + 'is_error_handling': False, + 'method_name_for_documentation': 'fetch_iq_single_record', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '_into', + 'session_filename': 'fetch_iq_single_record' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 0, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + }, + 'name': 'recordNumber', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': None, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + }, + 'name': 'numberOfSamples', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the pre-allocated numpy array to be filled with the acquired I/Q data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + }, + 'name': 'iq_data_array', + 'numpy': True, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': 'numpy array of numpy.complex64, numpy array of numpy.complex128 or interleaved complex data in the form of numpy array of numpy.int16', + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'fetch_iq_single_record', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'GetAttributeViBoolean': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViBoolean attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the current value of the attribute. Pass the address of a ViBoolean variable.', + }, + 'name': 'value', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetAttributeViInt32': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViInt32 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the current value of the attribute. Pass the address of a ViInt32 variable.', + }, + 'name': 'value', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetAttributeViInt64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViInt64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the current value of the attribute. Pass the address of a ViInt64 variable.', + }, + 'name': 'value', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetAttributeViReal64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViReal64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the current value of the attribute. Pass the address of a ViReal64 variable.', + }, + 'name': 'value', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetAttributeViSession': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViSession attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the current value of the attribute. Pass the address of a ViSession variable.', + }, + 'name': 'value', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetAttributeViString': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Queries the value of a ViString attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\nYou must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the **NIRFSA_ATTR_BUF_SIZE** parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the **NIRFSA_ATTR_BUF_SIZE** parameter, the function copies buffer size 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.\n\nIf you want to call this function just to get the required buffer size, you can pass 0 for **NIRFSA_ATTR_BUF_SIZE** and VI_NULL for the **attributeValue** buffer.\n\n**Supported Devices:** PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the attribute value parameter.\n\nIf you pass 0, you can pass VI_NULL for the attribute value buffer parameter.', + }, + 'name': 'bufSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in **NIRFSA_ATTR_BUF_SIZE**.\n\nIf you specify 0 for the **NIRFSA_ATTR_BUF_SIZE** parameter, you can pass VI_NULL for this parameter.', + }, + 'name': 'value', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetError': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n----\n**Note**\nIf the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter is 0, this function does not clear the error information. By passing 0 to **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE**, you can determine the buffer size required to read the entire error description string. You can then call this function again with a sufficiently large buffer.\n\nIf you specify a valid IVI session for the NIRFSA_ATTR_VI parameter, this function retrieves and then clears the error information for the session. If you pass VI_NULL for NIRFSA_ATTR_VI, this function retrieves and then clears the error information for the current execution thread. If NIRFSA_ATTR_VI is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since you last called this function or the nirfsa_ClearError function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840', + }, + 'included_in_proto': True, + 'is_error_handling': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'none' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the error code for the session or execution thread. If you pass 0 for the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter, you can pass VI_NULL for this parameter.', + }, + 'name': 'errorCode', + 'type': 'ViStatus', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Passes the number of bytes in the ViChar array you specify in **description**.\n\nIf the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer that you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.\n\nIf you pass 0, you can pass VI_NULL for the **NIRFSA_ATTR_ERROR_DESCRIPTION** parameter.', + }, + 'name': 'errorDescriptionBufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the error description for the IVI session or execution thread. If there is no description, this function returns an empty string.\n\nThe buffer must contain at least as many elements as the value you specify with the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter. If the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer, in the **status** return value, that you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.\n\nIf you pass 0, you can pass VI_NULL for the this parameter.', + }, + 'name': 'errorDescription', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'errorDescriptionBufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'GetLastExtCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nReturns the date and time of the last successful external calibration.\n\nThe time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this function returns\n\n14 for the hours parameter and\n\n30 for the minutes parameter.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'lastCalDatetime', + 'type': 'hightime.datetime' + } + ], + 'python_name': 'get_ext_cal_last_date_and_time', + 'real_datetime_call': 'GetExtCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetLastSelfCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nReturns the date and time of the last successful self-calibration.\n\nThe time returned is 24-hour local time. For example, if the device was calibrated at 2:30PM, this function returns\n\n14 for the hours parameter and\n\n30 for the minutes parameter.\n\n**Supported Devices** : PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the self-calibration step to query for the last successful self-calibration date and time data.', + }, + 'enum': 'SelfCalibrationStep', + 'name': 'selfCalibrationStep', + 'type': 'ViInt64' + }, + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'lastCalDatetime', + 'type': 'hightime.datetime' + } + ], + 'python_name': 'get_self_cal_last_date_and_time', + 'real_datetime_call': 'GetSelfCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetExtCalLastDateAndTime': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Returns the date and time of the last successful external calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_name_for_documentation': 'get_ext_cal_last_date_and_time', + 'is_error_handling': False, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the year of the last external calibration.', + }, + 'name': 'year', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the month of the last external calibration.', + }, + 'name': 'month', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the day of the last external calibration.', + }, + 'name': 'day', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the hour of the last external calibration.', + }, + 'name': 'hour', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the minute of the last external calibration.', + }, + 'name': 'minute', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetExtCalRecommendedInterval': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the recommended interval between external calibrations, in months.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the recommended maximum interval between external calibrations, in months.', + }, + 'name': 'months', + 'python_api_converter_name': 'convert_month_to_timedelta', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or int in months', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetFetchBacklog': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the number of points acquired that have not yet been fetched.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the record from which to read the backlog. Record numbers are zero-based.', + }, + 'name': 'recordNumber', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of samples available to read for the requested record.', + }, + 'name': 'backlog', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetFrequencyResponse': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the requested device response type, based on current NI-RFSA settings. The PXI-5661 and PXIe-5663/5663E/5665/5667/5668 automatically corrects the IF and RF response when you set the Digital IF Equalization Enabled property to TRUE. If you are using external digitizer mode, you can use information returned from this VI to correct your measurement.\n\nRefer to the *Factory Calibration* topic for your device for more information about frequency-response calibration.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array you specify for the NIRFSA_ATTR_FREQUENCIES, **NIRFSA_ATTR_MAGNITUDE_RESPONSE**, and **NIRFSA_ATTR_PHASE_RESPONSE** parameters.', + }, + 'name': 'bufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns an array containing the frequencies, in hertz (Hz), that correspond to the response data.\n\nPass VI_NULL if you do not want to use this parameter.', + }, + 'name': 'frequencies', + 'size': { + 'mechanism': 'ivi-dance-with-a-twist', + 'value': 'bufferSize', + 'value_twist': 'numberOfFrequencies' + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns an array containing the magnitude of the requested response, in decibels (dB). The magnitude response is normalized to the center frequency at each frequency in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter.', + }, + 'name': 'magnitudeResponse', + 'size': { + 'mechanism': 'ivi-dance-with-a-twist', + 'value': 'bufferSize', + 'value_twist': 'numberOfFrequencies' + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns an array containing the phase of the requested response, in radians. The phase response is normalized to the center frequency at each frequency entry in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter. This array may contain zeros if the device does not contain a stored phase response in its calibration data.', + }, + 'name': 'phaseResponse', + 'size': { + 'mechanism': 'ivi-dance-with-a-twist', + 'value': 'bufferSize', + 'value_twist': 'numberOfFrequencies' + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the required number of elements in the NIRFSA_ATTR_FREQUENCIES array and the response arrays. If **NIRFSA_ATTR_BUFFER_SIZE** is 0, this parameter returns the expected array size. The expected array size depends on which NI-RFSA device you use (PXI-5661, PXIe-5663/5663E/5665) and on the current settings (PXIe-5663/5663E/5665 only).', + }, + 'name': 'numberOfFrequencies', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetSelfCalLastDateAndTime': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Returns the date and time of the last successful self-calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **NIRFSA_ATTR_SELF_CALIBRATION_STEP** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'grpc_name': 'GetSelfCalLastDateAndTime', + 'included_in_proto': True, + 'method_name_for_documentation': 'get_self_calibration_date_and_time', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the self-calibration step to query for the last successful self-calibration date and time data.', + 'table_body': [ + [ + 'SelfCalibrationStep.PRESELECTOR_ALIGNMENT', + 'Calls for preselector alignment.' + ], + [ + 'SelfCalibrationStep.GAIN_REFERENCE', + 'Measures the changes in gain since the last external calibration was run.' + ], + [ + 'SelfCalibrationStep.IF_FLATNESS', + 'Measures the IF response of the entire system for each of the supported IF filters' + ], + [ + 'SelfCalibrationStep.DIGITIZER_SELF_CAL', + 'Calls for digitizer self-calibration, if the digitizer is associated with the RF downconverter.' + ], + [ + 'SelfCalibrationStep.LO_SELF_CAL', + 'Calls for LO self-calibration, if the LO source module is associated with the RF downconverter.' + ], + [ + 'SelfCalibrationStep.AMPLITUDE_ACCURACY', + 'Selects the Amplitude Accuracy self-calibration step.' + ], + [ + 'SelfCalibrationStep.RESIDUAL_LO_POWER', + 'Selects the Residual LO Power self-calibration step.' + ], + [ + 'SelfCalibrationStep.IMAGE_SUPPRESSION', + 'Selects the Image Suppression self-calibration step.' + ], + [ + 'SelfCalibrationStep.SYNTHESIZER_ALIGNMENT', + 'Selects the Synthesizer Alignment self-calibration step.' + ], + [ + 'SelfCalibrationStep.DC_OFFSET', + 'Selects the DC Offset self-calibration step.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SelfCalibrationStep', + 'grpc_name': 'self_calibration_step', + 'name': 'selfCalibrationStep', + 'type': 'ViInt64', + 'type_in_documentation': 'Bitwise combination of enums.SelfCalibrationStep flags', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the year of the last external calibration.', + }, + 'name': 'year', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the month of the last external calibration.', + }, + 'name': 'month', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the day of the last external calibration.', + }, + 'name': 'day', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the year of the last external calibration. It is expressed as an integer.', + }, + 'name': 'hour', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the minute of the last external calibration.', + }, + 'name': 'minute', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetScalingCoefficients': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns coefficients you can use to convert unscaled data to scaled I/Q data.\n\nAcquired data may be unscaled when sent by a peer-to-peer stream or fetched as unscaled data. Use this function to obtain nirfsa_GetScalingCoefficients structures in the **NIRFSA_ATTR_COEFFICIENT_INFO** array that provide gain and offset values you can use to scale this data into the actual I/Q values. The **NIRFSA_ATTR_COEFFICIENT_INFO** array returns one element for each channel specified in the **NIRFSA_ATTR_CHANNEL_LIST** parameter. The element order matches the order specified by the **NIRFSA_ATTR_CHANNEL_LIST** parameter. To get the actual I/Q values, scale the unscaled data from an acquisition by multiplying it by the gain value of the appropriate **NIRFSA_ATTR_COEFFICIENT_INFO** element then adding the offset from the same element.\n\n----\n**Note**\nThe coefficients are calculated by NI-RFSA for the current configuration of the device, so they are only valid for acquisitions obtained with the same device configuration.\n\n----\n\nTo get the required size of the array, call this function with **NIRFSA_ATTR_ARRAY_SIZE** set to 0 and NULL for the **NIRFSA_ATTR_COEFFICIENT_INFO** array. This function returns the required size in the **NIRFSA_ATTR_NUMBER_OF_COEFFICIENT_SETS** parameter.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array you specify for the **NIRFSA_ATTR_COEFFICIENT_INFO** parameter.', + }, + 'name': 'arraySize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Specifies the array for storing the coefficient info.\n\n- **offset** is the number that should be added to the data from a peer-to-peer stream after the gain has been applied if you want to scale unscaled data.\n- **gain** returns the multiplier that you should use to scale data obtained from a peer-to-peer stream.', + }, + 'name': 'coefficientInfo', + 'size': { + 'mechanism': 'ivi-dance-with-a-twist', + 'value': 'arraySize', + 'value_twist': 'numberOfCoefficientSets' + }, + 'type': 'niRFSA_coefficientInfo[]', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of valid coefficient sets.', + }, + 'name': 'numberOfCoefficientSets', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetSelfCalLastTemp': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the temperature, in degrees Celsius, at the last successful self-calibration.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **selfCalibrationStep** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860', + }, + 'grpc_name': 'GetSelfCalLastTemp', + 'included_in_proto': True, + 'is_error_handling': False, + 'python_name': 'get_self_calibration_temperature', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the self-calibration step to query for the last successful self-calibration date and time data.', + 'table_body': [ + [ + 'SelfCalibrationStep.PRESELECTOR_ALIGNMENT', + 'Calls for preselector alignment.' + ], + [ + 'SelfCalibrationStep.GAIN_REFERENCE', + 'Measures the changes in gain since the last external calibration was run.' + ], + [ + 'SelfCalibrationStep.IF_FLATNESS', + 'Measures the IF response of the entire system for each of the supported IF filters' + ], + [ + 'SelfCalibrationStep.DIGITIZER_SELF_CAL', + 'Calls for digitizer self-calibration, if the digitizer is associated with the RF downconverter.' + ], + [ + 'SelfCalibrationStep.LO_SELF_CAL', + 'Calls for LO self-calibration, if the LO source module is associated with the RF downconverter.' + ], + [ + 'SelfCalibrationStep.AMPLITUDE_ACCURACY', + 'Selects the Amplitude Accuracy self-calibration step.' + ], + [ + 'SelfCalibrationStep.RESIDUAL_LO_POWER', + 'Selects the Residual LO Power self-calibration step.' + ], + [ + 'SelfCalibrationStep.IMAGE_SUPPRESSION', + 'Selects the Image Suppression self-calibration step.' + ], + [ + 'SelfCalibrationStep.SYNTHESIZER_ALIGNMENT', + 'Selects the Synthesizer Alignment self-calibration step.' + ], + [ + 'SelfCalibrationStep.DC_OFFSET', + 'Selects the DC Offset self-calibration step.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SelfCalibrationStep', + 'grpc_name': 'self_calibration_step', + 'name': 'selfCalibrationStep', + 'type': 'ViInt64', + 'type_in_documentation': 'Bitwise combination of enums.SelfCalibrationStep flags', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.', + }, + 'grpc_name': 'temp', + 'name': 'temperature', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetTerminalName': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns the fully qualified name of the signal being queried.\n\nSignals can be triggers, clocks, or events.\n\nYou can pass the **NIRFSA_ATTR_TERMINAL_NAME** parameter that is returned to the **source** parameter of a configure trigger function.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the signal for which you want to query the terminal.', + 'table_body': [ + [ + 'Signal.START_TRIGGER', + 'NI-RFSA routes a Start Trigger.' + ], + [ + 'Signal.REF_TRIGGER', + 'NI-RFSA routes a Reference' + ], + [ + 'Signal.ADVANCE_TRIGGER', + 'NI-RFSA routes an Advance' + ], + [ + 'Signal.READY_FOR_START_EVENT', + 'NI-RFSA routes a Ready for Start Event.' + ], + [ + 'Signal.READY_FOR_REF_EVENT', + 'NI-RFSA routes a Ready for Reference Event..' + ], + [ + 'Signal.END_OF_RECORD_EVENT', + 'NI-RFSA routes a End of Record Event.' + ], + [ + 'Signal.DONE_EVENT', + 'NI-RFSA routes a Done Event.' + ], + [ + 'Signal.REF_CLOCK', + 'NI-RFSA routes a Reference Clock.' + ], + [ + 'Signal.USER', + 'NI-RFSA routes a User Defined Signal.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'Signal', + 'name': 'signal', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not support this parameter.', + }, + 'default_value': '""', + 'name': 'signalIdentifier', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Passes the number of bytes in the ViChar buffer that you allocate for the **NIRFSA_ATTR_TERMINAL_NAME** parameter.', + }, + 'name': 'bufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the fully qualified name of the signal being queried.', + }, + 'name': 'terminalName', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'InitWithOptions': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Creates a new session for the device.\n\nThis function sets the initial value of certain attributes and sends initialization commands to reset all hardware modules to a known state necessary for NI-RFSA operation.\n\nTo create a new session, pass the downconverter resource name for the RF vector signal analyzer to the **resource name** parameter.\n\nYou can access the device session this VI creates using the NI-RFSA Soft Front Panel (SFP). Accessing the device session with the SFP can help you debug your code. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about accessing your session with the SFP.\n\n----\n**Note**\nBefore initializing your device, you must first associate the modules that comprise your device in MAX. After associating the modules, pass the resource name of the device to this function to initialize all the modules. Refer to `Associating NI-RFSA Modules `_ for information about MAX association.\n\n----\n\n----\n**Note**\nFor multichannel devices such as the PXIe-5860, the resource name must include the channel number to use. The channel number is specified by appending *ChannelNumber* to the device name, where *ChannelNumber* is the channel number (0, 1, etc.). For example, if the device name is PXI1Slot2 and you want to use channel 0, use the resource name PXI1Slot2/0.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Driver Setup Options `_', + }, + 'included_in_proto': True, + 'method_name_for_documentation': '__init__', + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'initialization_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the resource name of the device to initialize.\n\nFor NI-RFSA devices, the syntax is the device name specified in MAX. The typical default name for your device in MAX is PXI1Slot2. You can rename your device by right-clicking the name in MAX, selecting **Rename** from the drop-down menu, and entering a new name. You can also pass in the name of an IVI logical name configured with the IVI Configuration utility. For additional information, refer to the **Installed Devices IVI** topic of the *Measurement & Automation Explorer Help*.\n\nDevice names are not case-sensitive. However, IVI logical names are case-sensitive. If you use an IVI logical name, verify the name is identical to the name shown in the IVI Configuration Utility.', + }, + 'name': 'resourceName', + 'type': 'ViRsrc', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': False, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies whether you want NI-RFSA to perform an ID query.\n\n**Defined Values** :', + 'table_body': [ + [ + 'Perform ID query.' + ], + [ + 'Do not perform ID query.' + ] + ], + 'table_header': [ + 'Description' + ] + }, + 'name': 'idQuery', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': False, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies whether the NI-RFSA device is reset during the initialization procedure.\n\n**Defined Values** :', + 'table_body': [ + [ + 'Reset the device.' + ], + [ + 'Do not reset device.' + ] + ], + 'table_header': [ + 'Description' + ] + }, + 'grpc_name': 'reset', + 'name': 'resetDevice', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': '""', + 'direction': 'in', + 'documentation': { + 'description': 'Sets the initial value of certain attributes for the session. The attributes shown in the following table are used in this parameter.\n\n| Name | Attribute |\n|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------------------|\n| RangeCheck | NIRFSA_ATTR_RANGE_CHECK |\n| QueryInstrStatus | NIRFSA_ATTR_QUERY_INSTRUMENT_STATUS |\n| Cache | NIRFSA_ATTR_CACHE |\n| RecordCoercions | NIRFSA_ATTR_RECORD_COERCIONS |\n| DriverSetup | NIRFSA_ATTR_DRIVER_SETUP |\n| Simulate | NIRFSA_ATTR_SIMULATE |\n\nThe format of this string is *AttributeName=Value*, where *AttributeName* is the name of the attribute and *Value* is the value to which the attribute will be set. For example, you can simulate the PXIe-5663 using the following strings:\n\n*Simulate=1, DriverSetup=Model:5663\\E*.\n\n*Simulate=1, DriverSetup=Model:5601*; *Digitizer:5622; LO:5652; LOBoardType:PXIe*.\n\nTo set multiple attributes, separate their assignments with a comma.\n\nRefer to `Driver Setup Options `_ for more information about the driver setup string.\n\nNote: To simulate a device using the PXIe-5622 25 MHz digitizer, set the *Digitizer* field to 5622_25MHz_DDC and the *Simulate* field to 1. You can set the *Digitizer* field to 5622_25MHz_DDC only when using the PXIe-5665.', + }, + 'name': 'optionString', + 'python_api_converter_name': 'convert_init_with_options_dictionary', + 'type': 'ViConstString', + 'type_in_documentation': 'dict', + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Identifies your instrument session.', + }, + 'grpc_name': 'vi', + 'name': 'newVi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'Initiate': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Commits settings to hardware, waits for hardware settling, and starts an acquisition.\n\nYou can use this function in conjunction with one of the niRFSA fetch I/Q functions to retrieve acquired I/Q data, or you can use the read IQ single record complex F64 function to both initiate the acquisition and retrieve I/Q data at one time.\n\n----\n**Note**\nIf you are using external digitizer mode, this function commits settings and waits for settling, but it does not start an acquisition. Notice that using the nirfsa_Commit function on its own commits settings to hardware, but the device does not wait for hardware settling.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_\n\n`RF List Mode `_\n\n`NI RF Vector Signal Analyzer State Diagram `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + }, + 'IsSelfCalValid': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Indicates which calibration steps contain valid calibration data.\n\nTo omit steps with valid calibration data from self-calibration, you can pass the **NIRFSA_ATTR_VALID_STEPS** parameter to the **stepsToOmit** parameter of the nirfsa_SelfCalibrate function.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns VI_TRUE if all the calibration data is valid and VI_FALSE if any of the calibration data is invalid.', + }, + 'name': 'selfCalValid', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns valid steps.\n\n----\nIf two or more calibration steps are valid, this parameter returns a bitwise-OR combination of the calibration steps. For example, if both NIRFSA_VAL_SELF_CAL_IF_FLATNESS and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL steps are valid, NI-RFSA returns the following string:\n\nNIRFSA_VAL_SELF_CAL_IF_FLATNESS |\n\nNIRFSA_VAL_SELF_CAL_LO_SELF_CAL\n\n----', + 'table_body': [ + [ + 'SelfCalSteps.DIGITIZER_SELF_CAL', + 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' + ], + [ + 'SelfCalSteps.PRESELECTOR_ALIGNMENT', + 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' + ], + [ + 'SelfCalSteps.OMIT_NONE', + 'No calibration steps are omitted.' + ], + [ + 'SelfCalSteps.GAIN_REFERENCE', + 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' + ], + [ + 'SelfCalSteps.IF_FLATNESS', + 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' + ], + [ + 'SelfCalSteps.LO_SELF_CAL', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ], + [ + 'SelfCalSteps.AMPLITUDE_ACCURACY', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ], + [ + 'SelfCalSteps.RESIDUAL_LO_POWER', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ], + [ + 'SelfCalSteps.IMAGE_SUPPRESSION', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ], + [ + 'SelfCalSteps.SYNTHESIZER_ALIGNMENT', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ], + [ + 'SelfCalSteps.DC_OFFSET', + 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SelfCalSteps', + 'name': 'validSteps', + 'type': 'ViInt64', + 'type_in_documentation': 'Bitwise combination of enums.SelfCalSteps flags', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'LoadConfigurationsFromFile': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nLoads the configurations from the specified file to the NI-RFSA driver session.\n\nThe VI does an implicit reset before loading the configurations from the file.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the absolute path of the file from which the NI-RFSA loads the configurations.', + }, + 'name': 'filePath', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' + }, + 'LockSession': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Obtains a multithread lock on the instrument session.\n\nBefore doing so, this function waits until all other execution threads have released their locks on the instrument session.\n\nOther threads might have obtained a lock on this session in the following ways:\n\n- Your application already called this function.\n- A call to NI-RFSA locked the session.\n\nAfter the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsa_UnlockSession function. Use the nirfsa_LockSession function and the nirfsa_UnlockSession function around a sequence of calls to NI-RFSA functions if you require that the NI-RFSA device retain its settings through the end of the sequence.\n\nYou can safely make nested calls to the nirfsa_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsa_LockSession function with a call to the nirfsa_UnlockSession function. If, however, you use **NIRFSA_ATTR_CALLER_HAS_LOCK** in all calls to the nirfsa_LockSession function and the nirfsa_UnlockSession function within a function, the IVI Library locks the session only once within the function regardless of the number of calls you make to the nirfsa_LockSession function. Locking the session only once allows you to call the nirfsa_UnlockSession function just once at the end of the function.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'lock', + 'library_interpreter_filename': 'lock', + 'method_python_name_suffix': '', + 'session_filename': 'lock' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to this function or the nirfsa_UnlockSession function in the same function.\n\nThis parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\nThe nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.', + }, + 'name': 'callerHasLock', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'lock', + 'render_in_session_base': True, + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'PerformThermalCorrection': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Corrects for temperature variations while acquiring the same signal for an extended period of time in a continuous acquisition.\n\nNI-RFSA internally acquires the temperature every time you initiate an acquisition. If you are performing a continuous acquisition, National Instruments recommends calling this function once every 10 minutes in a stable temperature environment to periodically update temperature calibration. If the ambient temperature varies, call this function more frequently.\n\n----\n**Note**\nYou cannot call this function if your device is operating in `RF list mode `_.\n\n----\n\nRefer to the *Thermal Management* section for your device for more information about typical operating temperatures.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ReadPowerSpectrumF32': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_name_for_documentation': 'read_power_spectrum', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Returns power spectrum data. Allocate an array as large as **NIRFSA_ATTR_DATA_ARRAY_SIZE**.', + }, + 'name': 'powerSpectrumDataArray', + 'numpy': True, + 'size': {'mechanism': 'fixed', 'value': 1}, + 'type': 'ViReal32[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.', + }, + 'name': 'dataArraySize', + 'size': {'mechanism': 'python-code', 'value': 'len(power_spectrum_data_array)'}, + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.', + }, + 'name': 'spectrumInfo', + 'type': 'niRFSA_spectrumInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ReadPowerSpectrumF64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_name_for_documentation': 'read_power_spectrum', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.', + }, + 'name': 'powerSpectrumDataArray', + 'numpy': True, + 'size': {'mechanism': 'fixed', 'value': 1}, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.', + }, + 'name': 'dataArraySize', + 'size': {'mechanism': 'python-code', 'value': 'len(power_spectrum_data_array)'}, + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.', + }, + 'name': 'spectrumInfo', + 'type': 'niRFSA_spectrumInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ReadPowerSpectrumDispatcher': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': False, + 'is_error_handling': False, + 'method_name_for_documentation': 'read_power_spectrum', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '_into', + 'session_filename': 'read_power_spectrum' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + }, + 'is_repeated_capability': True, + 'repeated_capability_type': 'channels', + 'name': 'channelList', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. The dtype of this array determines the data format: numpy.float64 or numpy.float32. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.', + }, + 'name': 'powerSpectrumDataArray', + 'numpy': True, + 'type': 'ViReal64[]', + 'type_in_documentation': 'numpy.array of numpy.float64 or numpy.array of numpy.float32', + 'use_in_python_api': True + }, + { + 'default_value': None, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the expected number of spectral lines. If None, falls back to self.number_of_spectral_lines.', + }, + 'name': 'dataArraySize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'read_power_spectrum', + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'reset': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Resets all properties to default values, deletes all de-embedding tables, and stops the export of all external signals and events.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Trigger Controller Slot, also known as the System Timing Slot.\n\nThis function resets all configured routes for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 in NI-RFSA and NI-RFSG. To avoid resetting routes on the device that are in use by NI-RFSG sessions, NI recommends using the nirfsa_ResetWithOptions function, with **stepsToOmit** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_', + }, + 'grpc_name': 'Reset', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ResetDevice': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Performs a hard reset on the device.\n\nA hard reset consists of the following actions:\n\n- Signal acquisition is stopped.\n- All routes are released.\n- External bidirectional terminals are tristated.\n- FPGAs are reset.\n- Hardware is configured to its default state.\n- All session attributes are reset to their default states.\n\nDuring a device reset, routes of signals between this and other devices are released, regardless of which device created the route. For example, a trigger signal exported to a PXI trigger line that is used by another device is no longer exported.\n\nOn the PXI-5600, if you are driving the PXI_CLK10 line, you continue to drive the clock even after a device reset. To stop driving the PXI_CLK10 line, use the nirfsa_ConfigurePxiChassisClk10 function and set the **pxiClk10Source** parameter to NIRFSA_VAL_NONE or set the NIRFSA_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute to NIRFSA_VAL_NONE.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ResetWithOptions': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Star Trigger Controller Slot, also known as the System Timing Slot.\n\nBy default, this function resets all properties to their default values, deletes all de-embedding tables, aborts generation, clears all routes, and resets session properties to initial values. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES for the **NIRFSA_ATTR_STEPS_TO_OMIT** parameter, this function does not release signal routes during the reset process.\n\nWhen routes of signals between two devices are released, they are released regardless of which device created the route.\n\nTo avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSG sessions, NI recommends using this function instead of nirfsa_Reset, with **NIRFSA_ATTR_STEPS_TO_OMIT** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a list of steps to skip during the reset process. The default value is NIRFSA_VAL_RESET_WITH_OPTIONS_NONE, which specifies that no step is omitted during reset.\n\nNote:NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES is not supported in external calibration or alignment sessions.\n\nNote:NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES is not supported for the PXI-5600/5661.', + 'table_body': [ + [ + 'ResetWithOptionsStepsToOmit.DEEMBEDDING_TABLES', + 'Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.' + ], + [ + 'ResetWithOptionsStepsToOmit.NONE', + 'No step is omitted during reset.' + ], + [ + 'ResetWithOptionsStepsToOmit.ROUTES', + 'Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'ResetWithOptionsStepsToOmit', + 'name': 'stepsToOmit', + 'type': 'ViUInt64', + 'type_in_documentation': 'Bitwise combination of enums.ResetWithOptionsStepsToOmit flags', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SaveConfigurationsToFile': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\nSaves the configurations of the session to the specified file.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the absolute path of the file to which the NI-RFSA saves the configurations.', + }, + 'name': 'filePath', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' + }, + 'SelfCalibrateRange': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Self-calibrates all configurations within the specified frequency and reference level limits.\n\nSelf-calibration range data is valid until you restart the system or call the nirfsa_ClearSelfCalibrateRange function.\n\nNI recommends that no external signals are present on the RF In port while the calibration is taking place.\n\n----\n**Note**\nThis function does not update self-calibration date and temperature.\n\n----\n\nFor best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit that step for faster execution.\n\n----\n**Note**\nIf there is an existing NI-RFSG session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842/5860 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSG Commit or niRFSG Initiate.\n\n----\n\n----\n**Note**\nIf there is an existing NI-RFSG session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies all supported calibration steps are performed.\n\n----\n\nTo omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the nirfsa_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL\n\n----\n\n| Value | Description |\n|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_RESET_WITH_OPTIONS_NONE | No step is omitted during self-calibration. |\n| NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_IF_FLATNESS | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_LO_SELF_CAL | Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the nirfsa_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock. |\n| NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | Omits the Amplitude Accuracy step. If you omit this step, the absolute accuracy of the device is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER | Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. |\n|NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image Performance is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT | Omits the Synthesizer Alignment step. If you omit this step, the LO PLL is not adjusted. This step is not valid for the PXIe-5820. |\n| NIRFSA_VAL_SELF_CAL_DC_OFFSET | Omits the DC Offset step. This step applies only to the PXIe-5820. |', + }, + 'enum': 'SelfCalibrateRangeStepsToOmit', + 'name': 'stepsToOmit', + 'type': 'ViInt64', + 'type_in_documentation': 'Bitwise combination of enums.SelfCalibrateRangeStepsToOmit flags', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the minimum RF frequency in Hz.', + }, + 'grpc_name': 'min_frequency', + 'name': 'minimumFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the maximum RF frequency in Hz.', + }, + 'grpc_name': 'max_frequency', + 'name': 'maximumFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the minimum reference level in dBm.', + }, + 'grpc_name': 'min_reference_level', + 'name': 'minimumReferenceLevel', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the maximum reference level in dBm.', + }, + 'grpc_name': 'max_reference_level', + 'name': 'maximumReferenceLevel', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SendSoftwareEdgeTrigger': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Sends a trigger to the device when you use a software version of a supported trigger and the device is waiting for the trigger to be sent.\n\nYou can also use this function to override a hardware trigger.\n\nThis function returns an error in the following situations:\n\n- You configure an invalid trigger.\n- You set the **acquisitionType** to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function.\n- You have not previously called the nirfsa_Initiate function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Software Trigger `_\n\n`Triggers `_', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the trigger to send.\n\n**Default Value:** NIRFSA_VAL_START_TRIGGER\n\n**Defined Values:**', + 'table_body': [ + [ + 'NIRFSA_VAL_START_TRIGGER', + 'Specifies the Start Trigger.' + ], + [ + 'NIRFSA_VAL_SCRIPT_TRIGGER', + 'Specifies the Script Trigger.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SoftwareTriggerType', + 'name': 'trigger', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not currently support this parameter.', + }, + 'default_value': '""', + 'name': 'triggerIdentifier', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViBoolean': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViBoolean attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'name': 'value', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViInt32': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViInt32 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel-based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'grpc_enum': 'NiRFSAInt32AttributeValues', + 'grpc_mapped_enum': 'NiRFSAInt32AttributeValuesMapped', + 'name': 'value', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViInt64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViInt64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'grpc_name': 'value_raw', + 'name': 'value', + 'type': 'ViInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViReal64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViReal64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread-locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'grpc_enum': 'NiRFSAReal64AttributeValues', + 'name': 'value', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViSession': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViSession attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'name': 'value', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'SetAttributeViString': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Sets the value of a ViString attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + }, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + }, + 'name': 'channelName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the ID of an attribute.', + }, + 'name': 'attributeId', + 'type': 'ViAttr', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + }, + 'grpc_mapped_enum': 'NiRFSAStringAttributeValuesMapped', + 'name': 'value', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'UnlockSession': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Releases a lock obtained on an NI-RFSA device session by calling the nirfsa_LockSession function.\n\nRefer to the nirfsa_LockSession function for additional information on session locks.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'unlock', + 'library_interpreter_filename': 'unlock', + 'method_python_name_suffix': '', + 'session_filename': 'unlock' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to this function or the nirfsa_UnlockSession function in the same function.\n\nThis parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\nThe nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.', + }, + 'name': 'callerHasLock', + 'type': 'ViBoolean', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': 'unlock', + 'render_in_session_base': True, + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'fancy_self_test': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nPerforms a self-test on the NI-RFSA device and returns the test results.\n\nThis function performs a simple series of tests to ensure that the NI-RFSA device is powered up and responding.\n\nThis function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSA device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Device Warm-Up `_', + 'table_body': [ + [ + '0', + 'Passed self-test' + ], + [ + '1', + 'Self-test failed' + ] + ], + 'table_header': [ + 'Self-Test Code', + 'Description' + ] + }, + 'grpc_name': 'FancySelfTest', + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'fancy_self_test' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'python_name': 'self_test', + 'returns': 'ViStatus' + }, + 'self_test': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Performs a self-test on the NI-RFSA device and returns the test results.\n\nThis function performs a simple series of tests to ensure that the NI-RFSA device is powered up and responding.\n\nThis function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSA device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Device Warm-Up `_', + }, + 'grpc_name': 'SelfTest', + 'included_in_proto': True, + 'method_name_for_documentation': 'self_test', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'This parameter contains the value returned from the NI-RFSA device self test.', + 'table_body': [ + [ + '0', + 'Self test passed' + ], + [ + '1', + 'Self test failed' + ] + ], + 'table_header': [ + 'Self-Test Code', + 'Description' + ] + }, + 'grpc_name': 'test_result', + 'name': 'selfTestResult', + 'type': 'ViInt16' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the self-test response string from the NI-RFSA device. For an explanation of the string contents, refer to the **status** parameter of this function.\n\nYou must pass a ViChar array with at least 256 bytes.', + }, + 'grpc_name': 'test_message', + 'name': 'selfTestMessage', + 'size': { + 'mechanism': 'fixed', + 'value': 256 + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, +} diff --git a/src/nirfsa/metadata/functions_addon.py b/src/nirfsa/metadata/functions_addon.py new file mode 100644 index 000000000..48ebb0d5a --- /dev/null +++ b/src/nirfsa/metadata/functions_addon.py @@ -0,0 +1,124 @@ +# These dictionaries are merged with the extracted function metadata at build time. +# Changes to the metadata should be made here, because functions.py is generated thus any changes get overwritten. + +functions_override_metadata = { + 'GetError': { + 'codegen_method': 'private', + 'is_error_handling': True, + }, + 'FetchIQSingleRecordComplexF32': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'FetchIQSingleRecordComplexF64': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'FetchIQSingleRecordComplexI16': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'FetchIQMultiRecordComplexF32': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'FetchIQMultiRecordComplexF64': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'FetchIQMultiRecordComplexI16': { + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'fetch_iq_numpy_read_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_read_method', + } + ], + }, + 'ConfigureIQPowerEdgeRefTrigger': { + 'method_templates': [ + { + 'documentation_filename': '/default_method', + 'library_interpreter_filename': 'configure_iq_power_edge_ref_trigger', + 'method_python_name_suffix': '', + 'session_filename': '/default_method', + } + ], + }, + 'GetTerminalName': { + 'method_templates': [ + { + 'documentation_filename': '/default_method', + 'library_interpreter_filename': 'get_terminal_name', + 'method_python_name_suffix': '', + 'session_filename': '/default_method', + } + ], + }, + 'ReadPowerSpectrumF32': { + 'method_templates': [ + { + 'documentation_filename': '/default_method', + 'library_interpreter_filename': 'read_power_spectrum', + 'method_python_name_suffix': '', + 'session_filename': '/default_method', + } + ], + }, + 'ReadPowerSpectrumF64': { + 'method_templates': [ + { + 'documentation_filename': '/default_method', + 'library_interpreter_filename': 'read_power_spectrum', + 'method_python_name_suffix': '', + 'session_filename': '/default_method', + } + ], + }, + 'ReadIQSingleRecordComplexF64': { + 'method_templates': [ + { + 'documentation_filename': '/numpy_method', + 'library_interpreter_filename': 'read_iq_single_record', + 'method_python_name_suffix': '', + 'session_filename': '/numpy_read_method', + } + ], + }, +} +functions_additional_fetch_array_measurement = { +} + +functions_additional_fetch_array_measurement_stats = { +} diff --git a/src/nirfsa/templates/_library_interpreter.py/configure_iq_power_edge_ref_trigger.py.mako b/src/nirfsa/templates/_library_interpreter.py/configure_iq_power_edge_ref_trigger.py.mako new file mode 100644 index 000000000..5eff09e34 --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/configure_iq_power_edge_ref_trigger.py.mako @@ -0,0 +1,2 @@ +<%page args="f, config, method_template"/>\ +<%include file="/_library_interpreter.py/default_method.py.mako" args="f=f, config=config, method_template=method_template"/>\ diff --git a/src/nirfsa/templates/_library_interpreter.py/fetch_iq_numpy_read_method.py.mako b/src/nirfsa/templates/_library_interpreter.py/fetch_iq_numpy_read_method.py.mako new file mode 100644 index 000000000..0aa2dab2e --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/fetch_iq_numpy_read_method.py.mako @@ -0,0 +1,56 @@ +<%page args="f, config, method_template"/>\ +<% + '''Renders a NIRFSA-specific LibraryInterpreter method for reading into a numpy.array. + + This variant intentionally skips generating intermediate size assignments for passed-in + size parameters to avoid unused-variable lint errors in fetch_iq_single_record helpers. + ''' + + import build.helper as helper + + parameters = f['parameters'] + param_names_method = helper.get_params_snippet(f, helper.ParameterUsageOptions.INTERPRETER_NUMPY_INTO_METHOD_DECLARATION) + param_names_library = helper.get_params_snippet(f, helper.ParameterUsageOptions.LIBRARY_METHOD_CALL) + + full_func_name = f['interpreter_name'] + method_template['method_python_name_suffix'] + c_func_name = config['c_function_prefix'] + f['name'] + + multi_record_func_names = ('fetch_iq_multi_record_complex_f32', 'fetch_iq_multi_record_complex_f64', 'fetch_iq_multi_record_complex_i16') + is_multi_record = full_func_name in multi_record_func_names + + # For the multi-record fetches, the driver writes one wfmInfo struct per record. The default + # code generation allocates a single struct, which the driver overruns (heap corruption) whenever + # number_of_records > 1. Below we allocate an array of number_of_records structs and pass it + # directly (ctypes accepts an array instance where a POINTER(struct) argument is expected). + multi_record_library_call = param_names_library.replace( + 'None if wfm_info_ctype is None else (ctypes.pointer(wfm_info_ctype))', + 'wfm_info_ctype', + ) +%>\ + + def ${full_func_name}(${param_names_method}): # noqa: N802 + % if is_multi_record: + samples_per_record = 0 if iq_data_arrays is None else (iq_data_arrays.shape[1] if hasattr(iq_data_arrays, 'shape') and len(iq_data_arrays.shape) > 1 else len(iq_data_arrays)) + % endif +% for p in helper.filter_parameters(parameters, helper.ParameterUsageOptions.LIBRARY_METHOD_CALL): + % if full_func_name in ('fetch_iq_multi_record_complex_f32', 'fetch_iq_multi_record_complex_f64') and p['python_name'] == 'number_of_samples': + number_of_samples_ctype = _visatype.ViInt64(samples_per_record) # case S160 + % elif full_func_name == 'fetch_iq_multi_record_complex_i16' and p['python_name'] == 'number_of_samples': + number_of_samples_ctype = _visatype.ViInt64(samples_per_record // 2) # case S160 + % elif is_multi_record and p['python_name'] == 'wfm_info': + wfm_info_ctype = (waveform_info.struct_niRFSA_wfmInfo * number_of_records)() # case S220 + % else: + % for declaration in helper.get_ctype_variable_declaration_snippet(p, parameters, None, config, use_numpy_array=p['numpy']): + ${declaration} + % endfor + % endif +% endfor + % if is_multi_record: + error_code = self._library.${c_func_name}(${multi_record_library_call}) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=${f['is_error_handling']}) + return [waveform_info.WaveformInfo(wfm_info_ctype[i]) for i in range(number_of_records)] + % else: + error_code = self._library.${c_func_name}(${param_names_library}) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=${f['is_error_handling']}) + ${helper.get_library_interpreter_method_return_snippet(parameters, config, use_numpy_array=True)} + % endif diff --git a/src/nirfsa/templates/_library_interpreter.py/get_deembedding_sparameter.py.mako b/src/nirfsa/templates/_library_interpreter.py/get_deembedding_sparameter.py.mako new file mode 100644 index 000000000..d264919ba --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/get_deembedding_sparameter.py.mako @@ -0,0 +1,20 @@ +<%page args="f, config, method_template"/>\ +<% + '''Gets S-parameters from the driver. Queries the number of ports, retrieves the S-parameter data into a pre-allocated buffer, and reshapes it.''' + import build.helper as helper +%>\ + + def ${f['interpreter_name']}(self): + import numpy as np + number_of_ports = self.get_deembedding_table_number_of_ports() + sparameters_array_size = number_of_ports ** 2 + sparameters = np.full((number_of_ports, number_of_ports), 0 + 0j, dtype=np.complex128) + vi_ctype = _visatype.ViSession(self._vi) # case S110 + sparameters_ctype = _get_ctypes_pointer_for_buffer(value=sparameters, library_type=_complextype.NIComplexNumber) # case B510 + sparameters_array_size_ctype = _visatype.ViInt32(sparameters_array_size) # case S150 + number_of_sparameters_ctype = _visatype.ViInt32() # case S220 + number_of_ports_ctype = _visatype.ViInt32() # case S220 + error_code = self._library.niRFSA_GetDeembeddingSparameters(vi_ctype, sparameters_ctype, sparameters_array_size_ctype, None if number_of_sparameters_ctype is None else (ctypes.pointer(number_of_sparameters_ctype)), None if number_of_ports_ctype is None else (ctypes.pointer(number_of_ports_ctype))) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) + sparameters = sparameters.reshape((int(number_of_ports_ctype.value), int(number_of_ports_ctype.value))) + return sparameters diff --git a/src/nirfsa/templates/_library_interpreter.py/get_terminal_name.py.mako b/src/nirfsa/templates/_library_interpreter.py/get_terminal_name.py.mako new file mode 100644 index 000000000..5eff09e34 --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/get_terminal_name.py.mako @@ -0,0 +1,2 @@ +<%page args="f, config, method_template"/>\ +<%include file="/_library_interpreter.py/default_method.py.mako" args="f=f, config=config, method_template=method_template"/>\ diff --git a/src/nirfsa/templates/_library_interpreter.py/read_iq_single_record.py.mako b/src/nirfsa/templates/_library_interpreter.py/read_iq_single_record.py.mako new file mode 100644 index 000000000..6ab350026 --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/read_iq_single_record.py.mako @@ -0,0 +1,2 @@ +<%page args="f, config, method_template"/>\ +<%include file="/_library_interpreter.py/numpy_read_method.py.mako" args="f=f, config=config, method_template=method_template"/>\ diff --git a/src/nirfsa/templates/_library_interpreter.py/read_power_spectrum.py.mako b/src/nirfsa/templates/_library_interpreter.py/read_power_spectrum.py.mako new file mode 100644 index 000000000..5eff09e34 --- /dev/null +++ b/src/nirfsa/templates/_library_interpreter.py/read_power_spectrum.py.mako @@ -0,0 +1,2 @@ +<%page args="f, config, method_template"/>\ +<%include file="/_library_interpreter.py/default_method.py.mako" args="f=f, config=config, method_template=method_template"/>\ diff --git a/src/nirfsa/templates/session.py/configure_spectrum_frequency.py.mako b/src/nirfsa/templates/session.py/configure_spectrum_frequency.py.mako new file mode 100644 index 000000000..071da8702 --- /dev/null +++ b/src/nirfsa/templates/session.py/configure_spectrum_frequency.py.mako @@ -0,0 +1,19 @@ +<%page args="f, config, method_template"/>\ +<% + '''Dispatches to the appropriate configure spectrum frequency method based on provided parameters.''' + import build.helper as helper +%>\ + def ${f['python_name']}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + if center_frequency is not None and span is not None: + self._configure_spectrum_frequency_center_span(center_frequency, span) + elif start_frequency is not None and stop_frequency is not None: + self._configure_spectrum_frequency_start_stop(start_frequency, stop_frequency) + else: + raise ValueError( + "Provide either (center_frequency & span) " + "or (start_frequency & stop_frequency)" + ) diff --git a/src/nirfsa/templates/session.py/create_deembedding_sparameter_table_array.py.mako b/src/nirfsa/templates/session.py/create_deembedding_sparameter_table_array.py.mako new file mode 100644 index 000000000..c062ed3b2 --- /dev/null +++ b/src/nirfsa/templates/session.py/create_deembedding_sparameter_table_array.py.mako @@ -0,0 +1,24 @@ +<%page args="f, config, method_template"/>\ +<% + '''Ensures that incoming array has appropriate dimension sizes and calculates the number of ports and sparameter table size parameters based on array dimensions before calling into "create_deembedding_sparameter_table_array" method.''' + import build.helper as helper +%>\ + def ${f['python_name']}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + if (str(type(sparameter_table)).find("'numpy.ndarray'") != -1) or (str(type(frequencies)).find("'numpy.ndarray'") != -1): + if sparameter_table.ndim == 3: + if frequencies.size == sparameter_table.shape[0]: + if sparameter_table.shape[1] == sparameter_table.shape[2]: + number_of_ports = sparameter_table.shape[1] + return self._create_deembedding_sparameter_table_array(port, table_name, frequencies, sparameter_table, number_of_ports, sparameter_orientation) + else: + raise ValueError("Row and column count of sparameter table should be equal. Table row count is {} and column count is {}.".format(sparameter_table.shape[1], sparameter_table.shape[2])) + else: + raise ValueError("Frequencies count does not match the sparameter table count. Frequencies count is {} and sparameter table count is {}.".format(frequencies.size, sparameter_table.shape[0])) + else: + raise ValueError("Unsupported array dimension. Is {}, expected 3".format(sparameter_table.ndim)) + else: + raise TypeError("Unsupported datatype. Expected numpy array.") diff --git a/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako b/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako new file mode 100644 index 000000000..7f85f89f3 --- /dev/null +++ b/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako @@ -0,0 +1,53 @@ +<%page args="f, config, method_template"/>\ +<% + '''Dispatches to the appropriate "fetch IQ multi record" method based on the data type.''' + import build.helper as helper + suffix = method_template['method_python_name_suffix'] +%>\ + def ${f['python_name']}${suffix}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + import numpy + if str(type(iq_data_arrays)).find("'numpy.ndarray'") != -1: + if number_of_records is None: + number_of_records = self.number_of_records + + if number_of_samples is None: + number_of_samples = self.number_of_samples + + if iq_data_arrays.ndim != 2: + raise ValueError("iq_data_arrays must be a 2D numpy array (number_of_records x number_of_samples), but got {}D array".format(iq_data_arrays.ndim)) + if iq_data_arrays.shape[0] < number_of_records: + raise ValueError("iq_data_arrays must have at least {} rows (number_of_records), but has {}".format(number_of_records, iq_data_arrays.shape[0])) + if iq_data_arrays.dtype == numpy.int16: + expected_buffer_size = 2 * number_of_samples + else: + expected_buffer_size = number_of_samples + + if iq_data_arrays.shape[1] < expected_buffer_size: + try: + iq_data_arrays.resize((iq_data_arrays.shape[0], expected_buffer_size), refcheck=False) + except (MemoryError, ValueError) as e: + raise type(e)( + "Failed to resize iq_data_arrays from {} to {}: {}".format( + iq_data_arrays.shape, (iq_data_arrays.shape[0], expected_buffer_size), e + ) + ) from e + assert iq_data_arrays.shape[1] == expected_buffer_size, "iq_data_arrays width must match requested number_of_samples after resize" + + if iq_data_arrays.dtype == numpy.complex128: + wfm_info = self._fetch_iq_multi_record_complex_f64(starting_record, number_of_records, iq_data_arrays, timeout) + elif iq_data_arrays.dtype == numpy.complex64: + wfm_info = self._fetch_iq_multi_record_complex_f32(starting_record, number_of_records, iq_data_arrays, timeout) + elif iq_data_arrays.dtype == numpy.int16: + wfm_info = self._fetch_iq_multi_record_complex_i16(starting_record, number_of_records, iq_data_arrays, timeout) + else: + raise TypeError("Unsupported datatype. Is {}, expected {} or {} or {}".format(iq_data_arrays.dtype, numpy.complex128, numpy.complex64, numpy.int16)) + else: + raise TypeError("Unsupported datatype. Expected numpy array of {} or {} or {}".format(numpy.complex128, numpy.complex64, numpy.int16)) + + waveform_info._populate_samples_info(wfm_info, iq_data_arrays) + + return wfm_info \ No newline at end of file diff --git a/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako b/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako new file mode 100644 index 000000000..af52f767a --- /dev/null +++ b/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako @@ -0,0 +1,49 @@ +<%page args="f, config, method_template"/>\ +<% + '''Dispatches to the appropriate "fetch IQ single record" method based on the data type.''' + import build.helper as helper + suffix = method_template['method_python_name_suffix'] +%>\ + + def ${f['python_name']}${suffix}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + import numpy + if str(type(iq_data_array)).find("'numpy.ndarray'") != -1: + if number_of_samples is None: + number_of_samples = self.number_of_samples + + if iq_data_array.dtype == numpy.int16: + expected_buffer_size = 2 * number_of_samples + else: + expected_buffer_size = number_of_samples + + if len(iq_data_array) < expected_buffer_size: + try: + iq_data_array.resize(expected_buffer_size, refcheck=False) + except (MemoryError, ValueError) as e: + raise type(e)( + "Failed to resize iq_data_array from {} to {}: {}".format( + len(iq_data_array), expected_buffer_size, e + ) + ) from e + assert len(iq_data_array) == expected_buffer_size, "iq_data_array length must match requested number_of_samples after resize" + + if iq_data_array.dtype == numpy.complex128: + wfm_info = self._fetch_iq_single_record_complex_f64(record_number, iq_data_array, timeout) + elif iq_data_array.dtype == numpy.complex64: + wfm_info = self._fetch_iq_single_record_complex_f32(record_number, iq_data_array, timeout) + elif iq_data_array.dtype == numpy.int16: + wfm_info = self._fetch_iq_single_record_complex_i16(record_number, iq_data_array, timeout) + else: + raise TypeError("Unsupported datatype. Is {}, expected {} or {} or {}".format(iq_data_array.dtype, numpy.complex128, numpy.complex64, numpy.int16)) + else: + raise TypeError("Unsupported datatype. Expected numpy array of {} or {} or {}".format(numpy.complex128, numpy.complex64, numpy.int16)) + + mv = memoryview(iq_data_array) + + wfm_info.samples = mv[0:wfm_info.actual_samples] + + return wfm_info diff --git a/src/nirfsa/templates/session.py/read_iq_single_record.py.mako b/src/nirfsa/templates/session.py/read_iq_single_record.py.mako new file mode 100644 index 000000000..4b6143351 --- /dev/null +++ b/src/nirfsa/templates/session.py/read_iq_single_record.py.mako @@ -0,0 +1,37 @@ +<%page args="f, config, method_template"/>\ +<% + '''Dispatches to the appropriate "read IQ single record" method based on the data type.''' + import build.helper as helper + suffix = method_template['method_python_name_suffix'] +%>\ + def ${f['python_name']}${suffix}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + import numpy + if str(type(iq_data_array)).find("'numpy.ndarray'") != -1: + if iq_data_array.dtype != numpy.complex128: + raise TypeError("Unsupported dtype. Is {}, expected {}".format(iq_data_array.dtype, numpy.complex128)) + + expected_buffer_size = self.number_of_samples + if len(iq_data_array) < expected_buffer_size: + try: + iq_data_array.resize(expected_buffer_size, refcheck=False) + except (MemoryError, ValueError) as e: + raise type(e)( + "Failed to resize iq_data_array from {} to {}: {}".format( + len(iq_data_array), expected_buffer_size, e + ) + ) from e + assert len(iq_data_array) == expected_buffer_size, "iq_data_array length must match requested number_of_samples after resize" + + wfm_info = self._read_iq_single_record_complex_f64(iq_data_array, timeout) + else: + raise TypeError("Unsupported datatype. Expected numpy array of {}".format(numpy.complex128)) + + mv = memoryview(iq_data_array) + + wfm_info.samples = mv[0:self.number_of_samples] + + return wfm_info diff --git a/src/nirfsa/templates/session.py/read_power_spectrum.py.mako b/src/nirfsa/templates/session.py/read_power_spectrum.py.mako new file mode 100644 index 000000000..b06191695 --- /dev/null +++ b/src/nirfsa/templates/session.py/read_power_spectrum.py.mako @@ -0,0 +1,40 @@ +<%page args="f, config, method_template"/>\ +<% + '''Dispatches to the appropriate "read power spectrum" method based on the data type.''' + import build.helper as helper + suffix = method_template['method_python_name_suffix'] +%>\ + def ${f['python_name']}${suffix}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_METHOD_DECLARATION)}): + '''${f['python_name']} + + ${helper.get_function_docstring(f, False, config, indent=8)} + ''' + import numpy + if str(type(power_spectrum_data_array)).find("'numpy.ndarray'") != -1: + expected_buffer_size = self.number_of_spectral_lines + + if len(power_spectrum_data_array) < expected_buffer_size: + try: + power_spectrum_data_array.resize(expected_buffer_size, refcheck=False) + except (MemoryError, ValueError) as e: + raise type(e)( + "Failed to resize power_spectrum_data_array from {} to {}: {}".format( + len(power_spectrum_data_array), expected_buffer_size, e + ) + ) from e + assert len(power_spectrum_data_array) == expected_buffer_size, "power_spectrum_data_array length must match number_of_spectral_lines after resize" + + if power_spectrum_data_array.dtype == numpy.float64: + spectrum_info = self._read_power_spectrum_f64(power_spectrum_data_array, timeout) + elif power_spectrum_data_array.dtype == numpy.float32: + spectrum_info = self._read_power_spectrum_f32(power_spectrum_data_array, timeout) + else: + raise TypeError("Unsupported dtype. Is {}, expected {} or {}".format(power_spectrum_data_array.dtype, numpy.float64, numpy.float32)) + else: + raise TypeError("Unsupported datatype. Expected numpy array of {} or {}".format(numpy.float64, numpy.float32)) + + mv = memoryview(power_spectrum_data_array) + + spectrum_info_type._populate_samples_info(spectrum_info, mv) + + return spectrum_info