NationalInstruments.ModularInstruments.NIRfsa Namespace

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


The NI-RFSA .NET class library can be used to control NI RF signal analyzers through the NI-RFSA instrument driver. This library includes methods and properties that exercise the functionality of the NI-RFSA hardware, including configuration and acquisition of waveforms.

Refer to Using the NI-RFSA .NET Library, Basic Usage, or Mapping the NI-RFSA .NET API to the NI-RFSA C API for more information.

Note:Integrated help for IVI Foundation interfaces is not provided. You must use the IntelliSense help.

Classes

ClassDescription
NIRfsa Defines a root class that is used to identify and control the instrument session.
RfsaAcquisition Provides the objects of specific acquisition classes.
RfsaAdvancedAcquisition Represents the properties to access the advanced features related to acquisition.
RfsaAdvancedConfigurationList Represents the advanced methods and properties used to work with configuration list and its related steps.
RfsaAdvancedIQAcquisitionConfiguration Represents the advanced properties used to configure the RF vector analyzer for an IQ acquisition.
RfsaAdvancedReferenceTrigger Provides properties to configure the Advanced Reference trigger.
RfsaAdvancedSignalPath Provides advanced properties related to signal path.
RfsaAdvancedTrigger Represents the advanced properties related to triggers.
RfsaAdvancedVertical Represents the advanced properties related to vertical.
RfsaAdvanceTrigger Represents the properties used to configure the Advance trigger for NI-RFSA.
RfsaAdvanceTriggerSynchronization Represents the properties used to synchronize the Advance Trigger.
RfsaAdvanceTriggerSynchronizationDistributionLine Specifies which external trigger line distributes the NIRfsa.RfsaAdvanceTriggerSynchronization signal. When synchronizing the NIRfsa.RfsaAdvanceTrigger, configure all devices to use the same Advance Trigger distribution line.
RfsaArmReferenceTrigger Represents the methods and properties used to configure the Arm Reference trigger for NI-RFSA.
RfsaBasicConfigurationList Represents the methods and properties to work with configuration list and its related steps.
RfsaCalibration Provides objects of specific types to calibrate NI-RFSA.
RfsaConfiguration Provides objects of specific types used to configure the NI-RFSA.
RfsaConfigurationListStepTrigger Represents the properties used to configure the Configuration List Step trigger.
RfsaDeviceCharacteristics Represents the methods and properties related to device information.
RfsaDigitalEdgeAdvanceTrigger Represents the properties used to configure the digital edge for Advance trigger.
RfsaDigitalEdgeAdvanceTriggerSource Represents the source terminal for RfsaDigitalEdgeAdvanceTrigger.
RfsaDigitalEdgeArmReferenceTrigger Represents the properties used to configure digital edge for RfsaArmReferenceTrigger.
RfsaDigitalEdgeArmReferenceTriggerSource Represents the source terminal for RfsaDigitalEdgeArmReferenceTrigger.
RfsaDigitalEdgeConfigurationListStepTrigger Represents the methods and properties used to configure digital edge for the Configuration List Step trigger.
RfsaDigitalEdgeConfigurationListStepTriggerSource Represents the source terminal for RfsaDigitalEdgeConfigurationListStepTrigger.
RfsaDigitalEdgeReferenceTrigger Represents the methods and properties used to configure digital edge for the Reference trigger.
RfsaDigitalEdgeReferenceTriggerSource Represents the source terminal for RfsaDigitalEdgeReferenceTrigger.
RfsaDigitalEdgeStartTrigger Represents the properties used to configure RfsaDigitalEdgeStartTrigger.
RfsaDigitalEdgeStartTriggerSource Represents the source terminal for RfsaDigitalEdgeStartTrigger.
RfsaDigitizerSampleClock Represents the properties used to configure Digitizer Sample Clock.
RfsaDigitizerSampleClockSynchronizationDistributionLine Specifies which external trigger line distributes the NIRfsa.RfsaDigitizerSampleClockSynchronizationDistributionLine signal. When synchronizing the NIRfsa.RfsaDigitizerSampleClock, configure all devices to use the same Digitizer Sample Clock distribution line.
RfsaDigitizerSampleClockTimebaseSource Represents the source of the Sample clock timebase, which is the timebase used to control waveform sampling.
RfsaDoneEvent Represents the properties used to configure Done event.
RfsaDoneEventExportedOutputTerminal Represents the destination terminal for RfsaDoneEvent.
RfsaDriverIdentity Provides the methods and properties that provide information about the instrument and the NI-RFSA driver.
RfsaDriverLock Provides synchronization locks obtained on the driver session.
RfsaDriverOperation Provides properties that affect the operation of the instrument driver.
RfsaDriverUtility Represents the methods that provide a basic set of utility operations.
RfsaEndOfRecordEvent Represents the properties used to configure the underlying hardware End of Record event.
RfsaEndOfRecordEventExportedOutputTerminal Represents the destination terminal for RfsaEndOfRecordEvent.
RfsaEvents Provides underlying hardware events of specific types.
RfsaExportAdvanceTrigger Represents the properties used to export Advance triggers.
RfsaExportAdvanceTriggerExportedOutputTerminal Represents the destination terminal for RfsaExportAdvanceTrigger.
RfsaExportDigitizerSampleClock Represents properties used to export Reference clock.
RfsaExportDigitizerSampleClockExportedOutputTerminal Represents the destination terminal for RfsaDigitizerSampleClock.
RfsaExportReferenceClock Represents properties used to export Reference clock.
RfsaExportReferenceClockExportedOutputTerminal Represents a destination terminal to which a Reference clock is exported.
RfsaExportReferenceTrigger Represents the properties used to export Reference trigger.
RfsaExportReferenceTriggerExportedOutputTerminal Represents the destination terminal for RfsaExportReferenceTrigger.
RfsaExportStartTrigger Represents the properties used to export Start trigger.
RfsaExportStartTriggerExportedOutputTerminal Represents the destination terminal for RfsaExportStartTrigger.
RfsaExternalCalibration Provides the properties used to perform external calibration.
RfsaIQAcquisition Represents the properties and methods used to configure and acquire I/Q signals.
RfsaIQAcquisitionConfiguration Represents the properties used to configure the RF vector analyzer for an IQ acquisition.
RfsaIQAnalogEdge Represents the properties to configure the I/Q analog edge specific to 5644R and 5645R.
RfsaIQAnalogEdgeSource Specifies the the channel from which the device monitors the trigger.
RfsaIQInPortChannel Represents the properties to configure I/Q In port terminals specific to 5644R and 5645R.
RfsaIQInPortChannelCollection Represents the properties to configure the I/Q port specific for the 5644R and 5645R devices.
RfsaIQPowerEdge Represents the properties and method used to configure the I/Q power edge.
RfsaIQPowerEdgeReferenceTriggerSource Represents the source terminal for RfsaIQPowerEdge.
RfsaLOSource Represents the source for RfsaSignalPath.LOSource.
RfsaNI5663AdvancedVertical Defines the advanced vertical methods and properties that are applicable to NI 5663 specifically.
RfsaNI5663SignalPath Defines the properties related to NI 5663-specific signal path features.
RfsaNI5665AdvancedVertical Defines the advance vertical methods and properties applicable to NI 5665 specifically.
RfsaNI5665SignalPath Defines the properties related to NI 5665-specific signal path features.
RfsaNI5693AdvancedVertical Defines the advanced vertical methods and properties that are applicable to NI 5693 specifically.
RfsaNI5693SelfCalibration Defines properties used to self calibrate the NI5693.
RfsaNI5694AdvancedVertical Defines the advanced vertical methods and properties that are applicable to NI 5694 specifically.
RfsaNI5694SignalPath Defines the properties related to NI 5694-specific signal path features.
RfsaPxiChassisClk10Source Represents the properties used to configure the signal to drive the 10 MHz Reference clock on the PXI backplane.
RfsaReadyForAdvanceEvent Represents the properties related to Ready for Advance event of the hardware.
RfsaReadyForAdvanceEventExportedOutputTerminal Represents the destination terminal for RfsaReadyForAdvanceEvent.
RfsaReadyForReferenceEvent Represents the properties related to Ready for Reference event of the hardware.
RfsaReadyForReferenceEventExportedOutputTerminal Represents the destination terminal for RfsaReadyForReferenceEvent.
RfsaReadyForStartEvent Represents the properties related to Ready for Start event of the hardware.
RfsaReadyForStartEventExportedOutputTerminal Represents the destination terminal of the RfsaReadyForStartEvent.
RfsaReferenceClock Represents the methods and properties used to configure the Reference clock.
RfsaReferenceClockSource Represents the source of RfsaReferenceClock.
RfsaReferenceTrigger Represents the properties used to configure the Reference trigger for NI-RFSA.
RfsaReferenceTriggerSynchronization Represents the properties to synchronize the Reference Trigger.
RfsaReferenceTriggerSynchronizationDistributionLine Specifies the external trigger line that distributes the NIRfsa.RfsaReferenceTriggerSynchronization signal. When synchronizing the NIRfsa.RfsaReferenceTrigger, configure all devices to use the same Reference Trigger distribution line.
RfsaSelfCalibration Defines methods and properties used to perform self calibration and query data related to self calibration.
RfsaSignalPath Represents the signal path properties.
RfsaSpectrumAcquisition Represents the methods used to configure and acquire data in the spectrum mode.
RfsaSpectrumAcquisitionConfiguration Represents the properties used to configure the hardware when acquiring in I/Q mode.
RfsaStartTrigger Represents the properties used to configure the Start trigger for NI-RFSA.
RfsaStartTriggerSynchronization Represents various Synchronization Triggers specific to the 5644R and 5645R devices.
RfsaStartTriggerSynchronizationDistributionLine Specifies the external trigger line that distributes the NIRfsa.RfsaStartTriggerSynchronization signal. When synchronizing the NIRfsa.RfsaStartTrigger, configure all devices to use the same Start Trigger distribution line.
RfsaSubObject Represents members that are common to all sub-object NI-Rfsa classes.
RfsaTimerStartSource Represents the source for TimerStartSource.
RfsaTriggers Provides triggers of specific types.
RfsaVertical Represents the properties related to vertical.
RfsaWarning Provides warning codes for the warnings raised by the underlying driver.
RfsaWarningEventArgs Represents the properties under the Warning Event Args raised incase of a driver warning.

Structures

StructureDescription
RfsaCoefficientInfo Represents the coefficient info struct of the underlying driver.
RfsaErrorQueryResult Represents the the result of an error query.
RfsaRevisionQueryResult Represents the result of the revision query operation.
RfsaSelfTestResult Represents the result of the RfsaDriverUtility.SelfTest method.
RfsaSpectrumInfo Provides methods and properties associated with power spectrum information.
RfsaWaveformInfo Provides methods and properties associated with waveform information.

Enumerations

EnumerationDescription
MechanicalAttenuatorEnabled Specifies whether the mechanical attenuator is enabled or disabled.
RfsaAcquisitionStatus Defines constants for the different of acquisition status supported by NI-RFSA.
RfsaAcquisitionType Specifies whether the session acquires I/Q data or computes a power spectrum over the specified frequency range.
RfsaAdvanceTriggerType Specifies whether you want the Advance trigger to be a digital edge or software trigger.
RfsaAllowOutOfSpecificationUserSettingsEnabled Specifies where to enable or disable warnings and errors when you set frequency and power values beyond the limits of the NI-RFSA device specifications.
RfsaArmReferenceTriggerType Specifies whether you want the Arm Reference trigger to be digital edge or software trigger.
RfsaChannelCoupling Specifies whether the RF input channel is AC-coupled or DC-coupled on a downconverter.
RfsaConfigurationListProperties Specifies the configuration list properties that the user can change between configuration list steps.
RfsaContiguousMultiRecordEnabled Specifies whether to enable contiguous multirecord acquisition.
RfsaDeviceResponseType Specifies the requested response type, based on current NI-RFSA settings.
RfsaDigitizerDitherEnabled Specifies whether dithering is enabled on the digitizer.
RfsaDownconverterLoopBandwidth Specifies the bandwidth that the downconverter module uses.
RfsaDownconverterPreselectorEnabled Specifies options which indicate whether the tunable preselector is enabled on the downconverter.
RfsaFetchRelativeTo Specifies the reference location within the acquired record from which to begin fetching.
RfsaFftWindowType Specifies the time-domain window type.
RfsaFrequencySettlingUnits Specifies the delay duration units and interpretation for LO settling.
RfsaIFConditioningDownconversionEnabled Specifies whether to enable IF conditioning down conversion.
RfsaIFFilter Specifies the desired IF filter path, regardless of the RF band chosen by NI-RFSA.
RfsaInputIsolationEnabled Specifies whether input isolation is enabled.
RfsaInputPort Specifies the connector(s) to use to acquire the signal.
RfsaIQAnalogEdgeReferenceTriggerSlope Specifies whether the device asserts the trigger when the voltage level is rising or falling.
RfsaIQInPortTerminalConfiguration Specifies the terminal configuration of the I/Q port.
RfsaIQPowerEdgeReferenceTriggerSlope Specifies whether the device asserts the trigger when the signal power is rising or falling.
RfsaLOInjectionSide Specifies the LO injection side.
RfsaLOOutExportConfigureFromRfsg Specifies whether to allow NI-RFSG to control the NI-RFSA local oscillator export.
RfsaLOPllFractionalModeEnabled Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL).
RfsaLowFrequencyBypassEnabled Specifies whether to use the low-frequency bypass path for the incoming RF signal.
RfsaLOYigMainCoilDrive Adjusts the dynamics of the current driving the YIG main coil.
RfsaNI5693RFConditioningCalibrationToneMode Specifies the location in a signal path where an RF conditioning calibration tone is injected or whether the tone is disabled.
RfsaNI5693RFPreselectorCalibrationToneMode Obsolete. Specifies the location in a signal path where an RF preselector calibration tone is injected or whether the tone is disabled.
RfsaNISelfCalibrationToneMode Obsolete. Specifies the location in a path where a calibration tone is injected or whether the tone is disabled.
RfsaNoiseSourcePowerEnabled Specifies whether to enable the noise source power.
RfsaNotchFilterEnabled Specifies whether the notch filter is enabled on the RF conditioning module.
RfsaOspDelayEnabled Specifies whether the digitizer onboard signal processing (OSP) block delays the Reference triggers and the data samples moving through the OSP block, or if the Reference triggers bypass the OSP block and are processed immediately.
RfsaOverflowErrorReporting Configures error reporting for ADC and onboard signal processing overflows.
RfsaPowerSpectrumUnits Specifies the units of the power spectrum.
RfsaPreselectorEnabled Obsolete. Specifies the different options of enabling or disabling the preselector.
RfsaReferenceTriggerSynchronizationDelayEnabled Specifies whether Reference Trigger is delayed with the data.
RfsaReferenceTriggerType Specifies whether you want the Reference trigger to be a digital edge, I/Q power edge, or software trigger.
RfsaResetStepsToOmit Specifies a list of steps to skip during the reset process.
RfsaResolutionBandwidthType Specifies how the ResolutionBandwidth property is expressed.
RfsaRFOutLOExportEnabled Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840.
RfsaRFPreamplifierEnabled Specifies whether to enable the RF preamplifier on the downconverter.
RfsaRFPreselectorFilter Specifies the RF preselector filter to use.
RfsaSelfCalibrationDownconverterToneMode Specifies the location in a path where a calibration tone is injected or whether the tone is disabled.
RfsaSelfCalibrationSteps Specifies the various steps involved in self calibration of NI-RFSA.
RfsaSignalConditioningEnabled Specifies whether signal conditioning is enabled on the NI 5694.
RfsaSmoothSpectrumEnabled Specifies whether an optimized IF filtering selection is made at different spectrum frequency ranges during spectrum acquisition.
RfsaSpectrumAveragingMode Specifies the averaging mode for the spectrum acquisition.
RfsaStartTriggerType Specifies constants for different types of Start trigger.
RfsaStepGainEnabled Specifies whether to enable the step gain amplifier.
RfsaTriggerEdge Specifies the transitions of the signal from one discrete level to another.

WAS THIS ARTICLE HELPFUL?

Not Helpful