niRFSA Properties

NI RF Vector Signal Analyzers (NI-RFSA 18.1) Help

Edition Date: June 2018

Part Number: 372058U-01

View Product Info

Download Help (Windows Only)


NI-RFSA 18.1 Help
NI-RFSA 18.2.1 Help
NI-RFSA 19.1 Help

June 2018, 372340U-01

Use the NI-RFSA properties to access advanced configuration options for NI-RFSA applications.

Property Description
Active Channel

Specifies the channel name used to access all subsequent properties in this instance of the property node. If the property you want to use is channel-based, you need to first select this property and then pass the name of the specific channel. If the property you specify is not channel-based, pass an empty string, or omit setting this property. Details

Acquisition Type

Configures the session to either acquire I/Q data or to compute a power spectrum over the specified frequency range. Details

Vertical:Reference Level (dBm)

Specifies the reference level, in dBm. The reference level represents the maximum expected power of an RF input signal. Details

Vertical:Mixer Level (dBm)

Specifies the mixer level, in dBm. The 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 property, NI-RFSA automatically selects an optimal mixer level value based on the reference level. The valid values for this property depend on your device configuration. Details

Vertical:Mixer Level Offset (dB)

Specifies the number of decibels by which to adjust the device mixer level. The default value is 0, which specifies device settings that are the best compromise between distortion and noise. Specifying a positive value for this property configures the device for moderate distortion and low noise, and specifying a negative value results in low distortion and higher noise. Details

Vertical:IF Output Power Level (dBm)

Specifies the level of the IF signal leaving the system, in dBm. Use this property to increase or decrease the nominal IF signal output level to achieve better measurement results. Details

Vertical:IF Output Power Level Offset (dB)

Specifies the number of decibels by which to adjust the default IF output power level. This property 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 property to increase or decrease the nominal output level to achieve better measurement results. The default value for the offset is 0 dB. Details

Vertical:Downconverter Gain (dB)

Returns the net signal gain for the NI-RFSA device at the current NI-RFSA settings and temperature. NI-RFSA scales the acquired I/Q and spectrum data from the digitizer using the value of this property. Details

Vertical:Digitizer Vertical Range

Specifies the vertical range of the digitizer. The 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 property to optimize performance if you know that the signal level at the digitizer input terminal is low. Details

Vertical:Advanced:External Gain (dB)

Specifies the gain, in decibels, of a switch (or cable) connected before the RF IN connector of an NI-RFSA system. When you set this property, NI-RFSA calculates appropriate attenuator settings based on the value of this property and the value of the Reference Level property. 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.

Note  For the PXIe-5820, this property specifies the gain, in decibels, of a switch (or cable) connected before the IQ IN connector.
Note  For the PXIe-5645, this property is ignored if you are using the I/Q ports.
Vertical:Advanced:RF Attenuation (dB)

Specifies the nominal attenuation setting, in decibels, for all attenuators before the first mixer in the RF signal chain. If you do not set this property, NI-RFSA automatically chooses an attenuation setting based on the reference level you configure. The valid values for this property depend on the device configuration. Details

Vertical:Advanced:Mechanical Attenuation (dB)

Specifies the level of mechanical attenuation for the RF path, in decibels. Details

Vertical:Advanced:Device Configuration Temperature (Degrees C)

Specifies the temperature, in degrees Celsius, that NI-RFSA uses to calculate the device configuration settings. Details

Vertical:Advanced:RF Attenuation Step Size (dB)

Specifies the step size, in decibels, for the RF attenuation level. The 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. Details

Vertical:Advanced:OSP Data Scaling Factor

Specifies the scaling factor applied to the time-domain voltage data in the IF digitizer. Use this property to maximize the dynamic range of the digitizer by increasing the maximum IF power the digitizer can measure without creating OSP overflows. Details

Vertical:Advanced:Overflow Error Reporting

Configures error reporting for ADC and onboard signal processing overflows. Overflows lead to clipping of the waveform. Details

Vertical:Advanced:Minimum Adjacent Channel Power Ratio (dB)

Specifies the minimum adjacent channel power ratio (ACPR), in decibels, relative to the main channel reference level. This property 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. Details

Vertical:Advanced:Preamp Enabled

Specifies whether the RF preamplifier is enabled in the system. Details

Vertical:Advanced:Amplitude Settling

Configures the amplitude settling accuracy in decibels. NI-RFSA waits until the RF power settles within the specified accuracy level after calling the niRFSA Initiate VI.

Any specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value.

Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5840 Details

Vertical:Advanced:Digital Gain (dB)

Specifies the scaling factor, in decibels, applied to the time-domain voltage data in the digitizer. NI-RFSA does not compensate for the specified digital gain. Details

Vertical:Advanced:Thermal Correction Temperature Resolution (Degrees C)

Specifies the temperature change, in degrees Celsius, required before NI-RFSA recalculates the thermal correction settings when entering the Generation state. Details

Vertical:Advanced:NI 5663:Mechanical Attenuator Enabled

Specifies whether the mechanical attenuator is enabled. Set this property to Enabled to allow NI-RFSA to use the mechanical attenuator. Details

Vertical:Advanced:NI 5665/5667/5668R:Channel Coupling

Specifies whether the RF IN connector is AC- or DC-coupled on the downconverter. Details

Vertical:Advanced:NI 5693:Cal Tone Power Referred to RF IN

Returns the power, in dBm, of a virtual signal connected to the RF IN connector on the PXIe-5693 front panel when the calibration tone is enabled. Details

Vertical:Advanced:NI 5694:Step Gain Enabled

Specifies whether to enable the step gain amplifier. Details

Signal Path:Digital IF Equalization Enabled

Enables use of the digital equalization filter for the RF downconverter. Details

Signal Path:LO Frequency

Specifies the LO signal frequency for the configured center frequency. Details

Signal Path:LO Source

Specifies the LO signal source used to downconvert the RF input signal. If this property is set to "" (empty string), NI-RFSA uses the internal LO source. Details

Signal Path:LO Export Enabled

Specifies whether to enable the LO OUT terminals on the installed devices. Details

Signal Path:LO2 Export Enabled

Specifies whether to enable the LO2 OUT terminal on the installed devices. Details

Signal Path:RF Out LO Export Enabled

Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840. Details

Signal Path:LO Out Export Configure From RFSG

Specifies whether to allow NI-RFSG to control the NI-RFSA LO out export. Details

Signal Path:Fractional Resample Enabled

Specifies whether fractional resampling is enabled on the digitizer. Fractional resampling allows the digitizer to achieve very fine resolution on the I/Q rate value. Setting this property to FALSE improves spectral performance. Details

Signal Path:Digitizer Dither Enabled

Specifies whether dithering is enabled on the digitizer. Details

Signal Path:IF Filter Bandwidth

Specifies the IF filter path bandwidth, in Hz, for your device configuration. Details

Signal Path:Advanced:Downconverter Loop Bandwidth

Configures the loop bandwidth of the RF downconverter tuning phase-locked loops (PLLs). To set this property, the NI-RFSA device must be in the Configuration state. Details

Signal Path:Advanced:Input Isolation Enabled

Specifies whether input isolation is enabled. Details

Signal Path:Advanced:LO Injection Side

Specifies the LO injection side. Details

Signal Path:Advanced:Frequency Settling Units

Specifies the delay duration units and interpretation for LO settling. Specify the actual settling value using the Frequency Settling property. This property is not supported if you are using an external LO. Details

Signal Path:Advanced:Frequency Settling

Specifies the value used for local oscillator (LO) frequency settling. The units and interpretation for this scalar value are specified using the Frequency Settling Units property. This property is not supported if you are using an external LO. Details

Signal Path:Advanced:LO YIG Main Coil Drive

Adjusts the dynamics of the current driving the YIG main coil. Details

Signal Path:Advanced:Downconverter Preselector Enabled

Specifies whether the tunable preselector is enabled on the downconverter. Details

Signal Path:Advanced:Notch Filter Enabled

Specifies whether the notch filter is enabled on the RF conditioning module. Details

Signal Path:Advanced:RF Preselector Filter

Specifies the RF preselector filter to use. Details

Signal Path:Advanced:Low Frequency Bypass Enabled

Specifies whether to use the low frequency bypass path for the incoming RF signal. Details

Signal Path:Advanced:IF Conditioning Downconversion Enabled

Specifies whether downconversion to 21.4 MHz is enabled for the IF conditioning module. The IF output frequency is 21.4 MHz when you enable this property, and it is 193.6 MHz when you disable this property. Details

Signal Path:Advanced:RF Highpass Filtering

Specifies the maximum corner frequency of the highpass filter in the RF signal path. The 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. Details

Signal Path:Advanced:NI 5663:IF Filter

Specifies the desired IF filter path, regardless of the RF band chosen by NI-RFSA. Details

Signal Path:Advanced:NI 5663:RF Attenuation Table

Specifies which RF attenuator table to use. Details

Signal Path:Advanced:NI 5663:IF Attenuation (dB)

Configures the device attenuation to a value that has the actual calibrated IF attenuation closest to the desired value. Details

Signal Path:Advanced:NI 5663:IF1 Attenuation (dB)

Specifies the IF1 attenuation, in decibels. The device IF1 attenuator is set to this nominal value. Use this property, along with the IF2 Attenuation property, when you set the IF Filter property to Bypass. Details

Signal Path:Advanced:NI 5663:IF2 Attenuation (dB)

Specifies the IF2 attenuation, in decibels. The device IF2 attenuator is set to this nominal value. Use this property, along with the IF1 Attenuation property, when you set the IF Filter property to Bypass. Details

Signal Path:Advanced:NI 5694:Signal Conditioning Enabled

Specifies whether all signal conditioning is enabled on the PXIe-5694. Details

Acquisition:Device Instantaneous Bandwidth (Hz)

Specifies the instantaneous bandwidth of the device in Hz. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration. Details

Acquisition:IQ:IQ Carrier Frequency

Specifies the expected carrier frequency of the incoming signal for demodulation, in Hz. The NI-RFSA device tunes to this frequency. NI-RFSA may coerce this value based on hardware settings and the RF downconverter specifications.

Note  For the PXIe-5645, this property is ignored if you are using the I/Q ports.
Acquisition:IQ:IQ Rate (S/s)

Specifies the I/Q rate for the acquisition. The value is expressed in samples per second (S/s). Details

Acquisition:IQ:Number Of Samples Is Finite

Specifies whether the device acquires a finite number of samples or acquires continuously. Details

Acquisition:IQ:Number Of Samples

Specifies the number of samples to acquire. This property is valid only if the Number Of Samples Is Finite property is set to TRUE. Details

Acquisition:IQ:Number Of Records Is Finite

Specifies whether the device stops after acquiring the specified number of records or acquires records continuously. Details

Acquisition:IQ:Allow More Records Than Memory

Specifies whether to allow the device to acquire more records than will fit in the device memory of the PXIe-5622/5624. Details

Acquisition:IQ:Number Of Records

Specifies the number of records to acquire if the Number of Records Is Finite property is set to TRUE. Details

Acquisition:IQ:Phase Offset

Specifies the offset to apply to the initial I and Q phases. Details

Acquisition:IQ:Advanced:Contiguous Multirecord

This property is not for customer use. Details

Acquisition:Spectrum:Center Frequency

Specifies the center frequency, in Hz, in a spectrum acquisition. An acquisition consists of a span of data surrounding the center frequency. Details

Acquisition:Spectrum:Span

Specifies the frequency range of the computed spectrum in Hz. For 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. Details

Acquisition:Spectrum:Power Spectrum Units

Specifies the units of the power spectrum. Details

Acquisition:Spectrum:Resolution Bandwidth (Hz)

Specifies the resolution along the x-axis of the spectrum, in Hz. NI-RFSA uses the resolution bandwidth value to determine the acquisition size. If specified, the Number of Spectral Lines property value overrides this value. Details

Acquisition:Spectrum:Resolution Bandwidth Type

Specifies how the Resolution Bandwidth property is expressed. Details

Acquisition:Spectrum:Number Of Spectral Lines

Specifies the number of spectral lines expected with the current power spectrum configuration. If you do not configure this property, NI-RFSA selects an appropriate value based on the Resolution Bandwidth property. If you configure this property, NI-RFSA coerces the value of the Resolution Bandwidth property based on the number of spectral lines requested and the value of the Spectrum Span property. Details

Acquisition:Spectrum:Averaging Mode

Specifies the averaging mode for the spectrum acquisition. Details

Acquisition:Spectrum:Number Of Averages

Specifies the number of acquisitions to average. The averaging process returns the final result after the number of averages is complete. Details

Acquisition:Spectrum:FFT Window Type

Specifies the time-domain window type. Details

Acquisition:Spectrum:FFT Window Shape Factor

Returns the shape factor of the window used in the fast Fourier transform (FFT). The window shape factor is defined as the ratio of the 60 dB to 6 dB bandwidths. Details

Acquisition:Spectrum:FFT Window Size

Returns the size of the window used in the fast Fourier transform (FFT), in terms of the number of samples in the window. Details

Acquisition:Spectrum:FFT Size

Returns the size of the fast Fourier transform (FFT). Details

Acquisition:Spectrum:Spectrum OSP Sampling Ratio

Specifies the oversampling ratio used by the digitizer onboard signal processing (OSP) when you are in spectrum acquisition mode. This property allows you to acquire a larger bandwidth in hardware and reduce that bandwidth in software, decreasing the possibility of hardware data path overflows.

PXIe-5644/5645/5646—The only valid value for this property is 1. Details

Acquisition:Spectrum:FFT Width

Specifies the FFT width of the device. The FFT width is the effective bandwidth of the signal path during each signal acquisition. Details

Acquisition:Spectrum:Smooth Spectrum Enabled

Specifies that an optimized IF filtering selection is made at different spectrum frequency ranges during spectrum acquisition. Details

Acquisition:Spectrum:Subspan Overlap

Specifies the amount of overlap between consecutive subspans in a multispan spectrum acquisition. Overlapping subspans can reduce the power level of spurs in acquired data. The value you specify determines the amount of shift as a percentage of subspan width. Details

Acquisition:Fetch:Fetch Relative To

Specifies the reference location within the acquired record from which to begin fetching. Details

Acquisition:Fetch:Fetch Offset

Specifies the offset relative to the position specified by the Fetch Relative To property from which to start fetching data. Offset can be a positive or negative value. Details

Acquisition:Fetch:Records Done

Returns the number of records the RF vector signal analyzer has acquired. Details

Acquisition:Fetch:Data Transfer:Data Transfer Maximum Bandwidth

Specifies the maximum bandwidth that the device can consume. Details

Acquisition:Fetch:Data Transfer:Data Transfer Block Size

Specifies the maximum number of samples to transfer at one time from the device to host memory. Increasing this number should result in better fetching performance because the driver does not need to restart the transfers as often. However, increasing this number may also increase the amount of page-locked memory required from the system. Details

Acquisition:Fetch:Data Transfer:Host DMA Buffer Size

Specifies the size of the DMA buffer in computer memory, in bytes. To set this property, the NI-RFSA device must be in the Configuration state. Details

Acquisition:Advanced:Downconverter Center Frequency

Enables in-band retuning and specifies the current frequency, in Hz, of the RF downconverter. If you set this property, any measurements outside the instantaneous bandwidth of the device are invalid. To disable in-band retuning, reset the property or call the niRFSA Reset VI. Details

Acquisition:Advanced:IF Output Frequency

Returns the center frequency of the IF output signal that corresponds to the configured RF center frequency. Details

Acquisition:Advanced:Allow Out Of Specification User Settings

Enables or disables warnings and errors when you set frequency, power, or bandwidth values beyond the limits of the NI-RFSA device specifications. When you enable this property, the driver does not report out-of-specification warnings and errors. Details

Clocking:Ref Clock Source

Specifies the Reference Clock source. Details

Clocking:Ref Clock Rate

Specifies the Reference Clock rate, in Hz, when the Ref Clock Source property is set to ClkIn or RefIn. Details

Clocking:Ref Clock Exported Terminal

Specifies a comma-separated list of the terminals at which to export the Reference Clock. Details

Clocking:Digitizer Sample Clock Timebase Source

Specifies the source of the Sample Clock timebase, which is the timebase used to control waveform sampling. Details

Clocking:Digitizer Sample Clock Timebase Rate

Specifies the frequency, in Hz, of the external clock used as the timebase source if you set the Digitizer Sample Clock Timebase Source property to an external source, such as ClkIn or LORefClk. Details

Clocking:Digitizer Sample Clock Exported Terminal

Specifies the terminal at which to export the Digitizer Sample Clock. Details

Clocking:Digitizer Sample Clock Rate

Specifies the frequency, in Hz, of the Sample Clock on the digitizer. Details

Clocking:PXI Chassis Clk10 Source

Specifies the signal to drive the 10 MHz Reference Clock on the PXI backplane. This option can be configured only when the PXI-5600 is installed in Slot 2 of the PXI chassis. Details

Triggers:Start:Type

Specifies whether you want the Start Trigger to be a digital edge or software trigger. Details

Triggers:Start:Digital Edge:Source

Specifies the source terminal for the Start Trigger. This property is used only when the Start Trigger Type property is set to Digital Edge. Details

Triggers:Start:Digital Edge:Edge

Specifies the active edge for the Start Trigger. This property is used only when the Start Trigger Type property is set to Digital Edge. Details

Triggers:Start:Export:Output Terminal

Specifies the destination terminal for the exported Start Trigger. Details

Triggers:Start:Terminal Name

Returns the fully qualified signal name as a string. Details

Triggers:Ref:Type

Specifies whether you want the Reference Trigger to be a digital edge, I/Q power edge, or software trigger. Details

Triggers:Ref:Pretrigger Samples

Specifies the number of pretrigger samples—the samples acquired before the Reference Trigger is received—to be acquired per record. Details

Triggers:Ref:Digital Edge:Source

Specifies the source terminal for the digital edge Reference Trigger. This property is used only when the Reference Trigger Type property is set to Digital Edge. Details

Triggers:Ref:Digital Edge:Edge

Specifies the active edge for the Reference Trigger. This property is used only when the Ref Trigger Type property is set to Digital Edge. Details

Triggers:Ref:IQ Power Edge:Source

Specifies the channel from which the device monitors the trigger. NI-RFSA currently supports only 0 as the value of this property. Details

Triggers:Ref:IQ Power Edge:Level

Specifies the power level, in dBm, at which the device triggers. The device asserts the trigger when the signal exceeds the level specified by the value of this property, taking into consideration the specified slope. If you are using external gain with your device, refer to the External Gain property for more information about how this property affects the I/Q power edge trigger level. Details

Triggers:Ref:IQ Power Edge:Slope

Specifies whether the device asserts the trigger when the signal power is rising or falling. When you set the Reference Trigger Type property to IQ Power Edge, the device asserts the trigger when the signal power exceeds the specified level with the slope you specify. Details

Triggers:Ref:Minimum Quiet Time

Specifies a time duration, in seconds, for which the signal must be quiet before the device arms the IQ Power Edge trigger. The signal is quiet when it is below the trigger level if the trigger slope, specified by the Reference Trigger IQ Power Edge Slope property, is set to Rising Slope or when it is above the trigger level if the trigger slope is set to Falling Slope. Details

Triggers:Ref:Export:Output Terminal

Specifies the destination terminal for the exported Reference Trigger. Details

Triggers:Ref:Terminal Name

Returns the fully qualified signal name as a string. Details

Triggers:Ref:Advanced:Ref Trigger Delay (s)

Specifies the trigger delay time, in seconds. The trigger delay time is the length of time the IF digitizer waits after it receives the trigger before it asserts the Reference Event. Details

Triggers:Ref:Advanced:Start To Ref Trigger Holdoff (s)

Specifies the minimum time, in seconds, that must elapse after the Start Trigger is received before the device recognizes a Reference Trigger. Details

Triggers:Ref:Advanced:Ref To Ref Trigger Holdoff (s)

Specifies the minimum time, in seconds, that must elapse between Reference Triggers of two records. The device does not recognize the Reference Trigger of the next record before this minimum time elapses. Details

Triggers:Ref:Advanced:OSP Delay Enabled

Specifies whether to enable the digitizer OSP block to delay Reference Triggers, along with the data samples, moving through the OSP block. If you set this property to Disabled, the Reference Triggers bypass the OSP block and are processed immediately. Details

Triggers:Advance:Type

Specifies whether you want the Advance Trigger to be a digital edge or software trigger. Details

Triggers:Advance:Digital Edge:Source

Specifies the source terminal for the Advance Trigger. This property is used only when the Advance Trigger Type property is set to Digital Edge. Details

Triggers:Advance:Export:Output Terminal

Specifies the destination terminal for the exported Advance Trigger. Details

Triggers:Advance:Terminal Name

Returns the fully qualified signal name as a string. Details

Triggers:Arm Ref:Type

Specifies whether the Arm Reference Trigger uses a digital edge or software trigger. Details

Triggers:Arm Ref:Digital Edge:Source

Specifies the source terminal for the digital edge Arm Reference Trigger. This property is used only when the Arm Reference Trigger Type property is set to Digital Edge. Details

Triggers:Configuration List Step:Digital Edge:Source

This property is not for customer use. Details

Triggers:Advanced:DDC Reference Trigger Override

This property is not for customer use. Details

Triggers:Advanced:Start Trigger Delay

This property is not for customer use. Details

Events:Ready For Start:Output Terminal

Specifies the destination terminal for the Ready for Start Event. Details

Events:Ready For Start:Terminal Name

Returns the fully qualified signal name as a string. Details

Events:Ready For Advance:Output Terminal

Specifies the destination terminal for the Ready for Advance Event. Details

Events:Ready For Advance:Terminal Name

Returns the fully qualified signal name as a string. Details

Events:Ready For Ref:Output Terminal

Specifies the destination terminal for the Ready for Reference Event. Details

Events:Ready For Ref:Terminal Name

Returns the fully qualified signal name as a string. Details

Events:End Of Record:Output Terminal

Specifies the destination terminal for the End of Record Event. Details

Events:End Of Record:Terminal Name

Returns the fully qualified signal name as a string. Details

Events:Done:Output Terminal

Specifies the destination terminal for the Done Event. Details

Events:Done:Terminal Name

Returns the fully qualified signal name as a string. Details

Device Characteristics:Serial Number

Returns the serial number of the RF downconverter module.

Note  For the PXIe-5644/5645/5646 and PXIe-5820/5840, this property returns the serial number of the VST module.
Device Characteristics:Module Revision

Returns the revision of the RF downconverter module. Details

Device Characteristics:Device Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the module.

PXIe-5644/5645/5646, PXIe-5820/5840—If you query this property during RF list mode, list steps may take longer to complete during list execution. Details

Device Characteristics:LO Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the LO module associated with the NI-RFSA device.

PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode) PXI-5661, PXIe-5663/5663E/5665/5667/5668—This property is not supported if you are using an external LO.

PXIe-5840—If you query this property during RF list mode, list steps may take longer to complete during list execution. Details

Device Characteristics:Digitizer Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the digitizer module.

PXIe-5820/5840—If you query this property during RF list mode, list steps may take longer to complete during list execution. Details

Device Characteristics:FPGA Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the FPGA.

Note  If you query this property during RF list mode, list steps may take longer to complete during list execution.
Device Characteristics:RF Conditioning Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the RF conditioning module associated with the NI-RFSA device. Details

Device Characteristics:IF Conditioning Temperature (Degrees C)

Returns the current temperature, in degrees Celsius, of the IF conditioning module associated with the NI-RFSA device. Details

Device Characteristics:Temperature Read Interval

Indicates the minimum time between temperature sensor readings in seconds. When you call the niRFSA Read Power Spectrum VI, niRFSA Read IQ VI, or niRFSA Initiate VI, NI-RFSA checks if at least the amount of time specified by this property has elapsed before reading the hardware temperature. Details

Device Characteristics:Memory Size

Returns the digitizer onboard memory size, in bytes. Details

Device Characteristics:RF Preamp Present

Returns whether an RF preamplifier is available on the RF downconverter module. Details

Device Characteristics:Preselector Present

Returns whether a preselector is available on the RF downconverter module. Details

Device Characteristics:FPGA Bitfile Path

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. You can specify the bitfile location using the Driver Setup string in the option string property of the niRFSA Initialize With Options VI. Details

Device Characteristics:FPGA Target Name

Returns a string containing the name of the FPGA target being used. This name can be used with the RIO open session to open a reference to the FPGA. Details

Peer-to-Peer:Enabled

Specifies whether peer-to-peer streaming is enabled for the active stream endpoint. Details

Peer-to-Peer:FIFO Endpoint Count

Returns the number of peer-to-peer streams supported by the device. Details

Peer-to-Peer:Samples Transferred

Returns the number of complex samples transferred through the peer-to-peer stream endpoint since the endpoint was last reset. Details

Peer-to-Peer:Samples in P2P Endpoint

Returns the current number of complex samples available in the peer-to-peer endpoint. Details

Peer-to-Peer:Most Samples in P2P Endpoint

Returns the largest number of complex samples available in the peer-to-peer endpoint since this property was last read. Details

Peer-to-Peer:Endpoint Size

Returns the size, in samples, of the peer-to-peer endpoint. Details

Peer-to-Peer:Endpoint Overflow

Indicates whether the endpoint has overflowed. An overflow condition occurs when data is written to the endpoint faster than it can be streamed from it. During an overflow, data in the endpoint begins to be overwritten. Reset the device or close the session to reset the overflow condition. Details

Peer-to-Peer:Onboard Memory Enabled

Specifies whether a limit is placed on the number of records and the size of the records by the size of the device onboard memory. When a peer-to-peer stream is enabled and onboard memory is disabled, any fetch calls result in an error. Details

Configuration List:Active List

Specifies the configuration list for RF list mode to make active for configuration or initiation. Details

Configuration List:Active Step

Specifies the step in the configuration list for RF list mode to make active for configuration or initiation. Details

Configuration List:Step In Progress

Returns the configuration list step that is currently programmed to the hardware. The list is zero-indexed. You can query this property only when a list is executed. Details

Configuration List:Timer Event Interval

Specifies the time, in seconds, that the timer counts before generating a Timer Event. Details

Configuration List:Advanced:Minimum Reconfiguration Time

This property is not for customer use. Details

Configuration List:Advanced:Timer Start Source

This property is not for customer use. Details

Inherent IVI Attributes:User Options:Cache

Specifies whether to cache the value of properties. If you set this property to TRUE, NI-RFSA tracks the current NI-RFSA device settings and avoids sending redundant commands to the device. Details

Inherent IVI Attributes:User Options:Interchange Check

Specifies whether to perform interchangeability checking and retrieve interchangeability warnings. Details

Inherent IVI Attributes:User Options:Driver Setup

The Driver Setup property returns, as a string, the initial values for properties that are specific to NI-RFSA. Details

Inherent IVI Attributes:User Options:Query Instrument Status

Specifies whether NI-RFSA queries the NI-RFSA device status after each operation. Querying the device status is useful for debugging. After you validate your program, you can set this property to FALSE to disable status checking and maximize performance. Details

Inherent IVI Attributes:User Options:Range Check

Specifies whether to validate property values and VI parameters. If enabled, NI-RFSA validates the parameter values that you pass to NI-RFSA VIs. Range-checking parameters is very useful for debugging. After you validate your program, you can set this property to FALSE to disable range checking and maximize performance. Details

Inherent IVI Attributes:User Options:Record Value Coercions

Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type properties. Details

Inherent IVI Attributes:User Options:Simulate

Specifies whether NI-RFSA simulates I/O operations. This property is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the niRFSA Initialize with Options VI to enable simulation. Details

Inherent IVI Attributes:Driver Identification:Description

Returns a string that contains a brief description of NI-RFSA. This property returns RF Signal Analyzer Instrument Driver. Details

Inherent IVI Attributes:Driver Identification:Driver Prefix

Returns a string that contains the prefix for NI-RFSA. The name of each user-callable VI in NI-RFSA starts with this prefix. This property returns niRFSA. Details

Inherent IVI Attributes:Driver Identification:Driver Vendor

Returns a string that contains the name of the vendor that supplies NI-RFSA. This property returns National Instruments. Details

Inherent IVI Attributes:Driver Identification:Revision

Returns a string that contains additional version information about NI-RFSA. For example, NI-RFSA can return Driver: NI-RFSA 2.9, Compiler: MSVC 7.10, Components: IVI Engine 4.00, VISA-Spec 4.00 as the value of this property. Details

Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models

Returns a comma-separated list of supported devices. Details

Inherent IVI Attributes:Instrument Identification:Manufacturer

Returns a string that contains the name of the manufacturer for the NI-RFSA device you are currently using. Details

Inherent IVI Attributes:Instrument Identification:Model

Returns a string that contains the model number or name of the NI-RFSA device that you are currently using. Details

Inherent IVI Attributes:Instrument Identification:Firmware Revision

Returns a string containing the firmware revision information for the NI-RFSA downconverter for the composite device you are currently using. Details

Inherent IVI Attributes:Advanced Session Information:Logical Name

Contains the logical name you specified when opening the current IVI session. You may pass a logical name to the niRFSA Initialize VI or the niRFSA Initialize with Options VI. 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. Details

Inherent IVI Attributes:Advanced Session Information:Resource Descriptor

Indicates the resource descriptor NI-RFSA uses to identify the physical device. If you initialize NI-RFSA with a logical name, this property contains the resource name that corresponds to the entry in the IVI Configuration Utility. Details

Self Calibration:NI 5665/5667/5668R:Downconverter Cal Tone Mode

Specifies the location in a signal path where an RF downconverter calibration tone is injected or whether the tone is disabled. Details

Self Calibration:NI 5665/5667/5668R:Downconverter Cal Tone Frequency

Specifies the frequency of the RF downconverter calibration tone, in Hz. Details

Self Calibration:NI 5665/5668R:Calibration Correction for Through Filter

Sets the internal gain self-calibration correction, in decibels, for the IF filter through path. The value you set for this property overrides any previously-set value. Details

Self Calibration:NI 5665/5668R:Calibration Correction for 300 kHz Filter

Sets the internal gain self-calibration correction, in decibels, for the 300 kHz IF filter path. The value you set for this property overrides any previously-set value. Details

Self Calibration:NI 5665/5668R:Calibration Correction for 5 MHz Filter

Sets the internal gain self-calibration correction, in decibels, for the 5 MHz IF filter path. The value you set for this property overrides any previously-set value. Details

Self Calibration:NI 5665/5668R:Calibration Correction for 100 MHz Filter

Sets the internal gain self-calibration correction, in decibels, for the 100 MHz IF filter path. The value you set for this property overrides any previously-set value. Details

Self Calibration:NI 5665/5668R:Calibration Correction for 320 MHz Filter

Sets the internal gain self-calibration correction, decibels, for the 320 MHz IF filter path. The value you set for this property overrides any previously-set value. Details

Self Calibration:NI 5665/5668R:Calibration Correction for 765 MHz Filter

Sets the internal gain self-calibration correction, in decibels, for the 765 MHz IF filter path. The value you set for this property overrides any previously-set value. Details

Self Calibration:RF Conditioning Cal Tone Mode

Specifies the location in a signal path where an RF conditioning calibration tone is injected or whether the tone is disabled. Details

Self Calibration:RF Conditioning Cal Tone Frequency

Specifies the frequency of the RF conditioning calibration tone, in Hz. Details

Self Calibration:Digitizer ID

Returns the currently associated digitizer ID. Allows the use of self calibration data when configured in external digitizer mode. Details

Factory Calibration:NI 5665/5668R:RF Path Selection

Specifies the RF path to use during calibration. This property is valid only during a calibration session. When you set this property, NI-RFSA does not select the RF path based on the downconverter center frequency. Details

Factory Calibration:NI 5665/5668R:RF Lowband Signal Conditioning Path Selection

Specifies the RF lowband signal conditioning path. Details

Factory Calibration:NI 5665/5668R:RF Electronic Attenuation Table Index

Selects the value of the RF electronic attenuation from a table of valid configurations. This property is valid only during a calibration session and when you set the RF Path Selection property to RF band 1. Details

Factory Calibration:NI 5665/5668R:RF Mechanical Attenuation Table Index

Selects the value of the RF mechanical attenuation configuration from a table of valid configurations. This property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:IF Filter Selection

Specifies the IF filter path used during calibration. The property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:IF Attenuation Table Selection

Specifies the IF attenuation table to use for external calibration. This property is valid only in a calibration session. Details

Factory Calibration:NI 5665/5668R:IF Attenuation Table Index

Specifies the IF attenuation index from a table of valid settings. This property is valid only during a calibration session.

PXIe-5603/5605/5606: To select a correct attenuation table, set this property in conjunction with the IF Filter Selection and IF Attenuation Table Selection properties.

PXIe-5694: To select correct attenuation settings, set this property in conjunction with the PXIe-5694 IF Filter Selection property. Details

Factory Calibration:NI 5665/5668R:IF Attenuation Table Size

Queries the size of the selected IF attenuation table. Details

Factory Calibration:NI 5665/5668R:LO Path Selection

Selects the LO signal path used during calibration. During non-calibration sessions, NI-RFSA implicitly derives the LO signal path from the center frequency. During calibration sessions, you must explicitly specify the LO signal path. This property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:LO1 Attenuation

Specifies the LO1 attenuation, in decibels, during a calibration session. This property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:LO2 Attenuation

Specifies the LO2 attenuation, in decibels, during a calibration session. This property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:LO3 Attenuation

Specifies the LO3 attenuation, in decibels, during a calibration session. This property is valid only during a calibration session. Details

Factory Calibration:NI 5665/5668R:Cal Tone Step Attenuation

Specifies the step attenuator, in decibels, to engage in the calibration tone path. This property is valid only during a calibration session. Details

Factory Calibration:NI 5693:RF Attenuation Index

Specifies the value of the RF attenuation from a table of valid configurations.

PXIe-5693: This property is valid only during a calibration session and when you set the Low Frequency Bypass Enabled property to Disabled

PXIe-5601/5603/5605, (external digitizer mode), PXIe-5663/5663E/5665/5667: This property is specified by the RF Attenuation Table property. Details

External Alignment:NI 5665/5668R:Preselector Tuning DAC Value

Specifies the preselector tuning DAC value during the preselector external alignment step. This value is valid only during a external alignment session. Details

Device Specific:Vector Signal Transceiver:Signal Path:Input Port

Specifies the connector(s) to use to acquire the signal. To set this property, the NI-RFSA device must be in the Configuration state. Details

Device Specific:Vector Signal Transceiver:Signal Path:LO In Power (dBm)

Returns the power level expected, in dBm, at the LO IN terminal when the LO Source property is set to LO In.

Note  For the PXIe-5644/5645/5646, this property is always read-only.
Device Specific:Vector Signal Transceiver:Signal Path:LO Out Power (dBm)

Specifies the power level, in dBm, of the signal at the LO OUT terminal when the LO Export Enabled property is set to TRUE. Details

Device Specific:Vector Signal Transceiver:Signal Path:Absolute Delay

Specifies the sub-sample clock delay, in seconds, to apply to the acquired signal. Use this property to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This property can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session.

To set this property, the NI-RFSA device must be in the Configuration state.

Note  If this property is set, NI-TClk cannot do any sub-sample clock adjustment.
Device Specific:Vector Signal Transceiver:Signal Path:Decimation Delay

Specifies the sub-sample delay, in seconds, to apply to the acquired signal. To set this property, the NI-RFSA device must be in the Configuration state. Details

Device Specific:Vector Signal Transceiver:Signal Path:LO Frequency Step Size (Hz)

Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL).

You can only tune the LO frequency by multiples of the LO Frequency Step Size property. The LO frequency can therefore be offset from the requested center frequency by as much as half of the LO Frequency Step Size property. This offset is corrected by digitally frequency shifting the LO frequency to the value requested in either the IQ Carrier Frequency property or the Spectrum Center Frequency property.

Note  For the PXIe-5840 with PXIe-5653, this property is ignored if the PXIe-5653 is used as the LO source.
Device Specific:Vector Signal Transceiver:Signal Path:LO PLL Fractional Mode Enabled

Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). Fractional mode gives a finer frequency step resolution, but it may result in non harmonic spurs. Refer to the specifications document for your device for more information about fractional mode and non harmonic spurs.

Note  The LO PLL Fractional Mode Enabled property is applicable only when using the internal LO.
Note  For the PXIe-5840 with PXIe-5653, this property is ignored if the PXIe-5653 is used as the LO source.
Device Specific:Vector Signal Transceiver:Acquisition:Advanced:Downconverter Frequency Offset

Specifies an offset from the I/Q carrier frequency for the downconverter. If you set this property, any measurements outside the instantaneous bandwidth of the device are invalid. After you set this property, the RF downconverter is locked to that frequency offset until the value is changed or the property is reset. Details

Device Specific:Vector Signal Transceiver:Triggers:Ref:IQ Analog Edge:Source

Specifies the channel from which the device monitors the trigger. Use a value of "I" to monitor the I channel. Use a value of "Q" to monitor the Q channel. Use a value of "I,Q" to monitor both I and Q channels. This property affects the device operation only when the Reference Trigger Type property is set to IQ Analog Edge. Details

Device Specific:Vector Signal Transceiver:Triggers:Ref:IQ Analog Edge:Hysteresis

Specifies the size of the hysteresis window on either side of the trigger level. The device triggers when the signal passes through the threshold you specify with the IQ Analog Edge Trigger Level property, has the slope you specify with the IQ Analog Edge Trigger Slope property, and passes through the hysteresis window that you specify with this property. This property affects the device operation only when the Reference Trigger Type property is set to IQ Analog Edge. Details

Device Specific:Vector Signal Transceiver:Triggers:Ref:IQ Analog Edge:Slope

Specifies whether the device asserts the trigger when the voltage level is rising or falling. When you set the Reference Trigger Type property to IQ Analog Edge, the device asserts the trigger when the signal level exceeds the specified level with the slope you specify. This property affects the device operation only when the Reference Trigger Type property is set to IQ Analog Edge. Details

Device Specific:Vector Signal Transceiver:Triggers:Ref:IQ Analog Edge:Level

Specifies the analog level, in volts, at which the device triggers. The device asserts the trigger when the signal exceeds the level specified by the value of this property, taking into consideration the specified slope. This property affects the device operation only when the Reference Trigger Type property is set to IQ Analog Edge. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Start Trigger Master

Specifies whether the device is the master for synchronizing the shared Start Trigger between multiple devices. The master device distributes the synchronized Start Trigger to all devices in the system through the Start Trigger distribution line.

When synchronizing the Start Trigger, one device must always be designated as the master. When the device is configured as a master, it actively drives the Start Trigger distribution line. When the device is configured as a slave, set the Start Trigger Type property to Digital Edge, and the Start Trigger Digital Edge Source property to Sync_Start.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Start Trigger Dist Line

Specifies which external trigger line distributes the synchronized Start Trigger signal. When synchronizing the Start Trigger, configure all devices to use the same Start Trigger distribution line.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Ref Trigger Master

Specifies whether the device is the master for synchronizing the shared Reference Trigger between multiple devices. The master device distributes the synchronized Reference Trigger to all devices in the system through the Reference Trigger distribution line.

When synchronizing the Reference Trigger, one device must always be designated as the master. When the device is configured as a master, it actively drives the Reference Trigger distribution line. When the device is configured as a slave, set the Reference Trigger Type property to Digital Edge, and the Reference Trigger Digital Edge Source property to Sync_Ref.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Ref Trigger Dist Line

Specifies which external trigger line distributes the synchronized Reference Trigger signal. When synchronizing the Reference Trigger, configure all devices to use the same Reference Trigger distribution line.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Advance Trigger Master

Specifies whether the device is the master for synchronizing the shared Advance Trigger between multiple devices. The master device distributes the synchronized Advance Trigger to all devices in the system through the Advance Trigger distribution line.

When synchronizing the Advance Trigger, one device must always be designated as the master. When the device is configured as a master, it actively drives the Advance Trigger distribution line. When the device is configured as a slave, set the Advance Trigger Type property to Digital Edge, and the Advance Trigger Digital Edge Source property to Sync_Advance.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Advance Trigger Dist Line

Specifies which external trigger line distributes the synchronized Advance Trigger signal. When synchronizing the Advance Trigger, configure all devices to use the same Advance Trigger distribution line.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Sample Clock Master

Specifies whether the device is the master when synchronizing the Sample Clock between multiple devices. The master device distributes the Sample Clock sync signal to all devices in the system through the Sample Clock sync distribution line.

When synchronizing the Sample Clock, one device must always be designated as the master. The master device actively drives the Sample Clock sync distribution line.

Refer to Synchronization Using NI-RFSA and NI-RFSG for more information about device synchronization for the PXIe-5646. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Sample Clock Dist Line

Specifies which external trigger line distributes the Sample Clock Sync signal. When synchronizing the Sample Clock between multiple devices, configure all devices to use the same Sync Sample Clock distribution line.

To set this property, the NI-RFSA device must be in the Configuration state. Refer to Synchronization Using NI-RFSA and NI-RFSG for more information about device synchronization for the PXIe-5646. Details

Device Specific:Vector Signal Transceiver:Triggers:Synchronization:Sync Ref Trigger Delay Enabled

Specifies whether the Reference Trigger is delayed with the data. Set this property to Disabled when the Reference Trigger Type property is set to IQ Power Edge or IQ Analog Edge.

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device in the NI RF Vector Signal Analyzers Help for more information about device synchronization for vector signal transceivers. Details

Device Specific:Vector Signal Transceiver:IQ In Port:Carrier Frequency

Configures the frequency of the signal. The onboard signal processing (OSP) frequency shifts the signal at this frequency to baseband prior to acquiring it. Details

Device Specific:Vector Signal Transceiver:IQ In Port:Vertical Range

Specifies the voltage range for the I/Q terminals.

To use this property, you must use the Active Channel property 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). Details

Device Specific:Vector Signal Transceiver:IQ In Port:Terminal Configuration

Configures the terminal configuration of the I/Q IN port.

To use this property, you must use the Active Channel property 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). Details

Device Specific:Vector Signal Transceiver:IQ In Port:Common Mode Level

Specifies the common-mode level, in volts, presented at each differential input terminal. Common-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). Details

Device Specific:Vector Signal Transceiver:IQ In Port:Temperature (Degrees C)

Returns the temperature, in degrees Celsius, of the I/Q IN circuitry on the device. Details

Device Specific:5606:Noise Source Power Enabled

Enables the 28 V DC source on the device front panel. Details

Device Characteristics:Max Device Instantaneous Bandwidth

Returns the maximum instantaneous bandwidth of the device. Details

Device Characteristics:Max IQ Rate

Returns the maximum I/Q rate. Details

Device Characteristics:Module Power Consumption (W)

Returns the module power consumption, in watts.

Note  If you query this property during RF list mode, list steps may take longer to complete during list execution.

WAS THIS ARTICLE HELPFUL?

Not Helpful