RFmxSpecAnMX Class
- Updated2025-10-13
- 11 minute(s) read
Defines a root class which is used to identify and control SpecAn signal configuration.
Derives from
- ISignalConfiguration
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public class RFmxSpecAnMX : ISignalConfiguration, IDisposable
Remarks
To create a SpecAn signal configuration, instantiate a RFmxInstrMX instance and invoke GetSpecAnSignalConfiguration which returns a SpecAn signal configuration. For more information about RFmx SpecAn, refer to the RFmx SpecAn Help.
Thread Safety
Any public static members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Properties
| Name | Description |
|---|---|
| Acp | Gets the RFmxSpecAnMXAcp instance that represents the ACP measurement. |
| Ampm | Gets the RFmxSpecAnMXAmpm instance that represents the AMPM measurement. |
| Ccdf | Gets the RFmxSpecAnMXCcdf instance that represents the CCDF measurement. |
| Chp | Gets the RFmxSpecAnMXChp instance that represents the CHP measurement. |
| Dpd | Gets the RFmxSpecAnMXDpd instance that represents the DPD measurement. |
| Fcnt | Gets the RFmxSpecAnMXFcnt instance that represents the frequency count (Fcnt) measurement. |
| Harm | Gets the RFmxSpecAnMXHarm instance that represents the Harmonics measurement. |
| Idpd | Gets the RFmxSpecAnMXIdpd instance that represents the IDPD measurement. |
| IM | Gets the RFmxSpecAnMXIM instance that represents the IM measurement. |
| IQ | Gets the RFmxSpecAnMXIQ instance that represents the I/Q measurement. |
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| Marker | Gets the RFmxSpecAnMXMarker instance that represents the Marker measurement. |
| NF | Gets the RFmxSpecAnMXNF instance that represents the NF measurement. |
| Obw | Gets the RFmxSpecAnMXObw instance that represents the OBW measurement. |
| Pavt | Gets the RFmxSpecAnMXPavt instance that represents the PAVT measurement. |
| PhaseNoise | Gets the RFmxSpecAnMXPhaseNoise instance that represents the PhaseNoise measurement. |
| PowerList | |
| Sem | Gets the RFmxSpecAnMXSem instance that represents the SEM measurement. |
| SignalConfigurationName | Gets the signal configuration name. |
| SignalConfigurationType | Gets the Type object for RFmxSpecAnMX. |
| Spectrum | Gets the RFmxSpecAnMXSpectrum instance that represents the Spectrum measurement. |
| Spur | Gets the RFmxSpecAnMXSpur instance that represents the Spur measurement. |
| Txp | Gets the RFmxSpecAnMXTxp instance that represents the TXP measurement. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | Stops acquisition and measurements associated with signal instance, which were previously initiated by the Initiate or measurement read methods. |
| AnalyzeIQ1Waveform(string, string, ComplexWaveform< ComplexSingle >, bool, long) | Performs the enabled measurements on the I/Q complex waveform that you specify in the iq parameter. Call this method after you configure the signal and measurement properties. You can fetch measurement results using the Fetch methods. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionType method value is either IQ or IQ or Spectral. This method is supported only when the RFmxInstr session is created with option string "AnalysisOnly=1". Note Query the RFmxInstrMX.GetRecommendedAcquisitionType method after calling the Commit(string) method. |
| AnalyzeSpectrum1Waveform(string, string, Spectrum< float >, bool, long) | Performs the enabled measurements on the spectrum that you specify in the spectrum parameter. Call this method after you configure the signal and measurement properties. You can fetch measurement results using the Fetch methods. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionType method value is either Spectral or IQ or Spectral. This method is supported only when the RFmxInstr session is created with option string "AnalysisOnly=1". Note Query the RFmxInstrMX.GetRecommendedAcquisitionType method after calling the Commit(string) method. |
| AutoLevel(string, double, double, out double) | Examines the incoming signal to calculate the peak power level and sets it as the value of the GetReferenceLevel(string, out double) method. Use this method to help calculate an approximate setting for the power level for measurements. When using PXIe-5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the AutoLevel(string, double, double, out double) method. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this method, thus reducing wear and tear, and maximizing the life time of the attenuator. |
| CheckMeasurementStatus(string, out bool) | Checks the status of the measurement. |
| ClearAllNamedResults(string) | Clears all results for the current signal instance. |
| ClearNamedResult(string) | Clears a result instance specified by the result name in the selectorString parameter. |
| CloneSignalConfiguration(string, out RFmxSpecAnMX) | Creates a new instance of a signal by copying all the properties from an existing signal instance. |
| Commit(string) | Commits settings to the hardware. Calling this method is optional. RFmxSpecAn commits settings to the hardware when you call the RFmxInstrMX Initiate or any of the measurement Read methods. |
| ConfigureDigitalEdgeTrigger(string, string, RFmxSpecAnMXDigitalEdgeTriggerEdge, double, bool) | Configures the device to wait for a digital edge trigger and then marks a reference point within the record. |
| ConfigureExternalAttenuation(string, double) | Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. |
| ConfigureFrequency(string, double) | Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. |
| ConfigureIQPowerEdgeTrigger(string, string, double, RFmxSpecAnMXIQPowerEdgeTriggerSlope, double, RFmxSpecAnMXTriggerMinimumQuietTimeMode, double, bool) | Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a reference point within the record. |
| ConfigureReferenceLevel(string, double) | Configures the reference level, which represents the maximum expected power of an RF input signal. |
| ConfigureRF(string, double, double, double) | Configures the RF properties of the signal specified by the selector string. |
| ConfigureSoftwareEdgeTrigger(string, double, bool) | Configures the device to wait for a Software Trigger and then marks a reference point within the record. |
| DeleteSignalConfiguration() | Deletes the current instance of a signal. |
| DisableTrigger(string) | Configures the device to not wait for a trigger to mark a reference point within a record. This method defines the signal triggering as immediate. |
| Dispose() | Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any. This method does not do anything if it is called by using list step instance. |
| GetAllNamedResultNames(string, out string[], out bool) | Returns all the named result names of the current signal instance. |
| GetAttributeBool(string, int, out bool) | Gets the value of a Bool attribute. |
| GetAttributeDouble(string, int, out double) | Gets the value of a Double attribute. |
| GetAttributeDoubleArray(string, int, ref double[]) | Gets the value of a double array attribute. |
| GetAttributeInt(string, int, out int) | Gets the value of an RFmx 32-bit integer (int32) attribute. |
| GetAttributeIntArray(string, int, ref int[]) | |
| GetAttributeSingleArray(string, int, ref float[]) | Gets the value of a single array attribute. |
| GetAttributeString(string, int, out string) | Gets the value of a of an RFmx string. |
| GetAutoLevelInitialReferenceLevel(string, out double) | Gets the initial reference level, in dBm, which the auto level function uses to estimate the peak power of the input signal. |
| GetCenterFrequency(string, out double) | Gets the expected carrier frequency, in hertz (Hz), of the RF signal that needs to be acquires. The signal analyzer tunes to this frequency. |
| GetDigitalEdgeTriggerEdge(string, out RFmxSpecAnMXDigitalEdgeTriggerEdge) | Gets whether the RF vector signal analyzer detects a Rising or Falling on the RFmxSpecAnMXDigitalEdgeTriggerEdge signal. |
| GetDigitalEdgeTriggerSource(string, out string) | Returns the source terminal for the digital-edge trigger. |
| GetErrorString(int, out string) | Converts the status code returned by an RFmxSpecAn function into a string. |
| GetExternalAttenuation(string, out double) | Gets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the RF signal analyzer. |
| GetIQPowerEdgeTriggerLevel(string, out double) | Gets the power level at which the device triggers. The value is expressed in dB when this parameter is set to Relative. The value is expressed in dBm when this parameter is set to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. |
| GetIQPowerEdgeTriggerLevelType(string, out RFmxSpecAnMXIQPowerEdgeTriggerLevelType) | Gets the reference for the GetIQPowerEdgeTriggerLevel method. |
| GetIQPowerEdgeTriggerSlope(string, out RFmxSpecAnMXIQPowerEdgeTriggerSlope) | Gets whether the device asserts the trigger when the signal power is rising or falling. |
| GetIQPowerEdgeTriggerSource(string, out string) | Gets the channel from which the device monitors the trigger. |
| GetLimitedConfigurationChange(string, out RFmxSpecAnMXLimitedConfigurationChange) | Gets the set of properties that are considered by RFmx in the locked signal configuration state. |
| GetListStepTimerDuration(string, out double) | Gets the duration of a given list step. This value is expressed in seconds. |
| GetListStepTimerOffset(string, out double) | Gets the time offset from the start of the step for which the measurements are computed. This value is expressed in seconds. This method is valid only when you set the SetDigitalEdgeTriggerSource(string, string) method to NationalInstruments.RFmx.SpecAnMX.RFmxSpecAnMXConstants.TimerEvent. |
| GetReferenceLevel(string, out double) | Gets the reference level which represents the maximum expected power of the RF input signal. |
| GetReferenceLevelHeadroom(string, out double) | Gets the margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided 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 previously included the margin in the reference level, you could improve the signal-to-noise ratio by reducing the reference level headroom. Default values |
| GetResultFetchTimeout(string, out double) | Gets the time, in seconds, to wait before results are available. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx driver waits until the measurement is complete. |
| GetSelectedPorts(string, out string) | Gets the instrument port to be configured to acquire a signal. Valid values |
| GetTriggerDelay(string, out double) | Gets the trigger delay time, in seconds. |
| GetTriggerMinimumQuietTimeDuration(string, out double) | Gets a time duration, in seconds, for which the signal must be quiet before the RF signal analyzer arms the I/Q Power Edge trigger. |
| GetTriggerMinimumQuietTimeMode(string, out RFmxSpecAnMXTriggerMinimumQuietTimeMode) | Gets whether the measurement computes the minimum quiet time used for triggering. |
| GetTriggerType(string, out RFmxSpecAnMXTriggerType) | Gets the type of reference trigger to use for signal acquisition. |
| GetWarning(out int, out string) | Retrieves and then clears the warning information for the session. |
| Initiate(string, string) | Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. To get the status of measurements, you can use the CheckMeasurementStatus(string, out bool) method. |
| ResetAttribute(string, RFmxSpecAnMXPropertyId) | Resets the attribute to its default value. |
| ResetToDefault(string) | Resets a signal to the default values. |
| SelectMeasurements(string, RFmxSpecAnMXMeasurementTypes, bool) | Specifies the measurements that you want to enable. |
| SendSoftwareEdgeTrigger() | Sends a trigger to the device when you configure to choose a software version of a trigger and the device is waiting for the trigger to be sent. You can also use this method to override a hardware trigger. |
| SetAttributeBool(string, int, bool) | Sets the value of a Bool attribute. |
| SetAttributeDouble(string, int, double) | Sets the value of a Double attribute. |
| SetAttributeDoubleArray(string, int, double[]) | Set the value of a double array attribute. |
| SetAttributeInt(string, int, int) | Sets the value of a Int attribute. |
| SetAttributeIntArray(string, int, int[]) | |
| SetAttributeSingleArray(string, int, float[]) | Set the value of a single array attribute. |
| SetAttributeString(string, int, string) | Sets the value of a String attribute. |
| SetAutoLevelInitialReferenceLevel(string, double) | Sets the initial reference level, in dBm, which the auto level function uses to estimate the peak power of the input signal. |
| SetCenterFrequency(string, double) | Sets the expected carrier frequency, in hertz (Hz), of the RF signal that needs to be acquired. The signal analyzer tunes to this frequency. |
| SetDigitalEdgeTriggerEdge(string, RFmxSpecAnMXDigitalEdgeTriggerEdge) | Sets whether the RF vector signal analyzer detects a Rising or Falling on the RFmxSpecAnMXDigitalEdgeTriggerEdge signal. This is used only when you set the SetTriggerType(string, RFmxSpecAnMXTriggerType) method to DigitalEdge. |
| SetDigitalEdgeTriggerSource(string, string) | Sets the source terminal for the RFmxSpecAnMXDigitalEdgeTriggerEdge. This method is used only when you set the SetTriggerType(string, RFmxSpecAnMXTriggerType) method to DigitalEdge. |
| SetExternalAttenuation(string, double) | Sets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the RF signal analyzer. |
| SetIQPowerEdgeTriggerLevel(string, double) | Sets the power level at which the device triggers. This value is expressed in dB when you set the SetIQPowerEdgeTriggerLevelType(string, RFmxSpecAnMXIQPowerEdgeTriggerLevelType) method to Relative; and in units specified by the value of the RFmxSpecAnMX.ConfigureReferenceLevelUnits method when you set the SetIQPowerEdgeTriggerLevelType(string, RFmxSpecAnMXIQPowerEdgeTriggerLevelType) method to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. |
| SetIQPowerEdgeTriggerLevelType(string, RFmxSpecAnMXIQPowerEdgeTriggerLevelType) | Sets the reference for the SetIQPowerEdgeTriggerLevel(string, double) method. |
| SetIQPowerEdgeTriggerSlope(string, RFmxSpecAnMXIQPowerEdgeTriggerSlope) | Sets whether the device asserts the Trigger when the signal power is rising or falling. When you set the SetTriggerType(string, RFmxSpecAnMXTriggerType) to IQPowerEdge, the device asserts the trigger when the signal power exceeds the specified level with the slope you specify. |
| SetIQPowerEdgeTriggerSource(string, string) | Sets the channel from which the device monitors the trigger. This is used only when you set the SetTriggerType(string, RFmxSpecAnMXTriggerType) to IQPowerEdge. |
| SetLimitedConfigurationChange(string, RFmxSpecAnMXLimitedConfigurationChange) | Sets the set of properties that are considered by RFmx in the locked signal configuration state. |
| SetListStepTimerDuration(string, double) | Sets the duration of a given list step. This value is expressed in seconds. |
| SetListStepTimerOffset(string, double) | Sets the time offset from the start of the step for which the measurements are computed. This value is expressed in seconds. This method is valid only when you set the SetDigitalEdgeTriggerSource(string, string) method to NationalInstruments.RFmx.SpecAnMX.RFmxSpecAnMXConstants.TimerEvent. |
| SetReferenceLevel(string, double) | Sets the reference level which represents the maximum expected power of the RF input signal. |
| SetReferenceLevelHeadroom(string, double) | Sets the margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided 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 previously included the margin in the reference level, you could improve the signal-to-noise ratio by reducing the reference level headroom. Default values |
| SetResultFetchTimeout(string, double) | Sets the time, in seconds, to wait before results are available. Set this value to a time longer than expected for fetching the measurement. |
| SetSelectedPorts(string, string) | Sets the instrument port to be configured to acquire a signal. Valid values |
| SetTriggerDelay(string, double) | Sets the trigger delay time, in seconds. |
| SetTriggerMinimumQuietTimeDuration(string, double) | Sets a time duration, in seconds, for which the signal must be quiet before the RF signal analyzer arms the ConfigureIQPowerEdgeTrigger(string, string, double, RFmxSpecAnMXIQPowerEdgeTriggerSlope, double, RFmxSpecAnMXTriggerMinimumQuietTimeMode, double, bool). |
| SetTriggerMinimumQuietTimeMode(string, RFmxSpecAnMXTriggerMinimumQuietTimeMode) | Sets whether the measurement computes the minimum quiet time used for triggering. |
| SetTriggerType(string, RFmxSpecAnMXTriggerType) | Sets the type of reference trigger to use for signal acquisition. |
| WaitForMeasurementComplete(string, double) | Waits for the specified number for seconds for all the measurements to complete. |
| BuildCarrierString(string, int) | Creates the carrier string to use as the selector string with the SEM, ACP, and CHP carrier configuration or fetch properties and methods. |
| BuildCarrierString2(string, int) | Creates the carrier string to use as the selector string with the SEM, ACP, and CHP carrier configuration or fetch properties and methods. |
| BuildHarmonicString(string, int) | Creates the selector string to use with Harmonics configuration or fetch methods. |
| BuildHarmonicString2(string, int) | Creates the selector string to use with Harmonics configuration or fetch methods. |
| BuildIntermodString(string, int) | Creates the intermod string to use as the selector string with the IM configuration or fetch methods and methods. |
| BuildListStepString(string, string, int) | Creates the list step string. |
| BuildListString(string, string) | Creates the list string. |
| BuildMarkerString(string, int) | Creates a selector string for use with marker configuration or fetch methods. |
| BuildMarkerString2(string, int) | Creates a selector string for use with marker configuration or fetch methods. |
| BuildOffsetString(string, int) | Creates the offset string to use as the selector string with SEM and ACP offset configuration or fetch methods. |
| BuildOffsetString2(string, int) | Creates the offset string to use as the selector string with SEM and ACP offset configuration or fetch methods. |
| BuildRangeSpurString(string, int, int) | Creates the selector string for use with Spurious emissions (Spur) measurement results or fetch methods. |
| BuildRangeString(string, int) | Creates a selector string for use with Spurious emissions (Spur) configuration or fetch methods. |
| BuildRangeString2(string, int) | Creates a selector string for use with spurious emissions (Spur) configuration or fetch methods. |
| BuildResultString(string) | Creates selector string for use with configuration or fetch. |
| BuildSegmentString(string, int) | Creates a selector string for use with the PAVT configuration or fetch methods and methods. |
| BuildSpurString2(string, int) | Creates the selector string for use with Spurious emissions (Spur) measurement results or fetch methods. |