RFmx SpecAn DOTNET

Table of Contents

RFmxSpecAnMXIMConfiguration Class

  • Updated2024-07-17
  • 12 minute(s) read
RFmxSpecAnMXIMConfiguration Class

RFmxSpecAnMXIMConfiguration Class

Provides methods to configure the IM measurement

Inheritance Hierarchy

SystemObject
  RFmxSpecAnMXSubObject
    NationalInstruments.RFmx.SpecAnMXRFmxSpecAnMXIMConfiguration

Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)

Syntax

public sealed class RFmxSpecAnMXIMConfiguration : RFmxSpecAnMXSubObject
Public NotInheritable Class RFmxSpecAnMXIMConfiguration
	Inherits RFmxSpecAnMXSubObject

The RFmxSpecAnMXIMConfiguration type exposes the following members.

Methods

 NameDescription
Public methodConfigureAutoIntermodsSetup Configures whether the measurement computes the intermod frequencies or uses manually specified frequencies.
Public methodConfigureAveraging Configures averaging for the IM measurement.
Public methodConfigureFft Configures the window and FFT to obtain a spectrum for the IM measurement.
Public methodConfigureFrequencyDefinition Configures whether you can specify the tones and intermod frequencies as either relative to the RF center frequency or as absolute frequencies.
Public methodConfigureFundamentalTones Configures the upper and lower frequencies in a two-tone input signal.
Public methodConfigureIntermod Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to False.
Use "intermod(n)" as the selector string to configure this method.
Public methodConfigureIntermodArray Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to False.
Public methodConfigureMeasurementMethod Configures the method for performing the IM measurement.
Public methodConfigureNumberOfIntermods Configures the number of intermods to measure when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to False.
Public methodConfigureRbwFilter Configures the RBW filter.
Public methodConfigureSweepTime Configures the sweep time.
Public methodEqualsDetermines whether the specified Object is equal to the current Object.
(Inherited from Object)
Public methodGetAllTracesEnabled Gets whether to enable the traces to be stored and retrieved after performing the IM measurement.
Public methodGetAmplitudeCorrectionType Gets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the _RFmxInstrCfgExternalAttenuationTable function to configure the external attenuation table.
Public methodGetAutoIntermodsSetupEnabled Gets whether the measurement computes the intermod frequencies or uses user-specified frequencies.
Public methodGetAveragingCount Gets the number of acquisitions used for averaging when you set the SetAveragingEnabled(String, RFmxSpecAnMXIMAveragingEnabled) method to True.
Public methodGetAveragingEnabled Gets whether to enable averaging for the IM measurement.
Public methodGetAveragingType Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.
Public methodGetFarIFOutputPowerOffset Gets the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange and the SetIFOutputPowerOffsetAuto(String, RFmxSpecAnMXIMIFOutputPowerOffsetAuto) method to False.
Public methodGetFftPadding Gets the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula: FFT size = waveform size * padding This method is used only when the acquisition span is less than the device instantaneous bandwidth.
Public methodGetFftWindow Gets the FFT window type to use to reduce spectral leakage.
Public methodGetFrequencyDefinition Gets whether the tones and intermod frequencies are relative to the RF center frequency, or are absolute frequencies.
Public methodGetFundamentalLowerToneFrequency Gets the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.
Public methodGetFundamentalUpperToneFrequency Gets the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.
Public methodGetHashCodeServes as a hash function for a particular type.
(Inherited from Object)
Public methodGetIFOutputPowerOffsetAuto Gets whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange.
Public methodGetIntermodEnabled Gets whether to enable an intermod for the IM measurement. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodGetIntermodOrder Gets the order of the intermod. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodGetIntermodSide Gets whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodGetLocalPeakSearchEnabled Gets whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.
Public methodGetLowerIntermodFrequency Gets the frequency of the lower intermodulation product. This value is expressed in Hz. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodGetMaximumIntermodOrder Gets the order up to which the RFmx driver measures odd order intermodulation products when you set the Auto Intermods Setup Enabled method to True. The lower and upper intermodulation products are measured for each order.
Public methodGetMeasurementEnabled Gets whether to enable the IM measurement.
Public methodGetMeasurementMethod Gets the method used to perform the IM measurement.
Public methodGetNearIFOutputPowerOffset Gets the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange and the SetIFOutputPowerOffsetAuto(String, RFmxSpecAnMXIMIFOutputPowerOffsetAuto) method to False.
Public methodGetNumberOfAnalysisThreads Gets the maximum number of threads used for parallelism for the IM measurement. The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.
Public methodGetNumberOfIntermods Gets the number of intermods to measure when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to False.
Public methodGetRbwFilterAutoBandwidth Gets whether the measurement computes the RBW.
Public methodGetRbwFilterBandwidth Gets the bandwidth of the RBW filter used to sweep the acquired signal, when you set the SetRbwFilterAutoBandwidth(String, RFmxSpecAnMXIMRbwFilterAutoBandwidth) method to False. This value is expressed in Hz.
Public methodGetRbwFilterType Gets the response of the digital RBW filter.
Public methodGetSweepTimeAuto Gets whether the measurement computes the sweep time.
Public methodGetSweepTimeInterval Gets the sweep time when you set the SetSweepTimeAuto(String, RFmxSpecAnMXIMSweepTimeAuto) method to False. This value is expressed in seconds.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetUpperIntermodFrequency Gets the frequency of the upper intermodulation product. This value is expressed in Hz. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodSetAllTracesEnabled Sets whether to enable the traces to be stored and retrieved after performing the IM measurement.
Public methodSetAmplitudeCorrectionType Sets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the _RFmxInstrCfgExternalAttenuationTable function to configure the external attenuation table.
Public methodSetAutoIntermodsSetupEnabled Sets whether the measurement computes the intermod frequencies or uses user-specified frequencies.
Public methodSetAveragingCount Sets the number of acquisitions used for averaging when you set the SetAveragingEnabled(String, RFmxSpecAnMXIMAveragingEnabled) method to True.
Public methodSetAveragingEnabled Sets whether to enable averaging for the IM measurement.
Public methodSetAveragingType Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.
Public methodSetFarIFOutputPowerOffset Sets the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange and the SetIFOutputPowerOffsetAuto(String, RFmxSpecAnMXIMIFOutputPowerOffsetAuto) method to False.
Public methodSetFftPadding Sets the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula: FFT size = waveform size * padding This method is used only when the acquisition span is less than the device instantaneous bandwidth.
Public methodSetFftWindow Sets the FFT window type to use to reduce spectral leakage.
Public methodSetFrequencyDefinition Sets whether the tones and intermod frequencies are relative to the RF center frequency, or are absolute frequencies.
Public methodSetFundamentalLowerToneFrequency Sets the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.
Public methodSetFundamentalUpperToneFrequency Sets the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.
Public methodSetIFOutputPowerOffsetAuto Sets whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange.
Public methodSetIntermodEnabled Sets whether to enable an intermod for the IM measurement. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodSetIntermodOrder Sets the order of the intermod. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodSetIntermodSide Sets whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodSetLocalPeakSearchEnabled Sets whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.
Public methodSetLowerIntermodFrequency Sets the frequency of the lower intermodulation product. This value is expressed in Hz. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodSetMaximumIntermodOrder Sets the order up to which the RFmx driver measures odd order intermodulation products when you set the Auto Intermods Setup Enabled method to True. The lower and upper intermodulation products are measured for each order.
Public methodSetMeasurementEnabled Sets whether to enable the IM measurement.
Public methodSetMeasurementMethod Sets the method used to perform the IM measurement.
Public methodSetNearIFOutputPowerOffset Sets the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This method is used only if you set the SetMeasurementMethod(String, RFmxSpecAnMXIMMeasurementMethod) method to DynamicRange and the SetIFOutputPowerOffsetAuto(String, RFmxSpecAnMXIMIFOutputPowerOffsetAuto) method to False.
Public methodSetNumberOfAnalysisThreads Sets the maximum number of threads used for parallelism for the IM measurement. The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.
Public methodSetNumberOfIntermods Sets the number of intermods to measure when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to False.
Public methodSetRbwFilterAutoBandwidth Sets whether the measurement computes the RBW.
Public methodSetRbwFilterBandwidth Sets the bandwidth of the RBW filter used to sweep the acquired signal, when you set the SetRbwFilterAutoBandwidth(String, RFmxSpecAnMXIMRbwFilterAutoBandwidth) method to False. This value is expressed in Hz.
Public methodSetRbwFilterType Sets the response of the digital RBW filter.
Public methodSetSweepTimeAuto Sets whether the measurement computes the sweep time.
Public methodSetSweepTimeInterval Sets the sweep time when you set the SetSweepTimeAuto(String, RFmxSpecAnMXIMSweepTimeAuto) method to False. This value is expressed in seconds.
Public methodSetUpperIntermodFrequency Sets the frequency of the upper intermodulation product. This value is expressed in Hz. This method is not used when you set the GetAutoIntermodsSetupEnabled(String, RFmxSpecAnMXIMAutoIntermodsSetupEnabled) method to True.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

See Also

Log in to get a better experience