FetchLowerOffsetMargin(string, double, out RFmxSpecAnMXSemLowerOffsetMeasurementStatus, out double, out double, out double, out double)
- Updated2025-10-13
- 2 minute(s) read
Fetches the measurement status and margin from the limit line measured in the lower offset segment.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int FetchLowerOffsetMargin(string selectorString, double timeout, out RFmxSpecAnMXSemLowerOffsetMeasurementStatus measurementStatus, out double margin, out double marginFrequency, out double marginAbsolutePower, out double marginRelativePower)
Remarks
This method maps to the RFmxSpecAn_SEMFetchLowerOffsetMargin() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies the result name and offset number. Example: "offset0", "result::r1/offset0". You can use the BuildOffsetString2(string, int) method to build the selector string. |
| timeout | double | Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. |
| measurementStatus | out RFmxSpecAnMXSemLowerOffsetMeasurementStatus | Indicates the lower offset measurement status based on measurement limits and the fail criteria that you specify in the SetOffsetLimitFailMask(string, RFmxSpecAnMXSemOffsetLimitFailMask) method. |
| margin | out double | Upon return, contains the margin, in dB, from the limit mask value that you set in the SetOffsetLimitFailMask(string, RFmxSpecAnMXSemOffsetLimitFailMask) method. Margin is defined as the maximum difference between the spectrum and the limit mask. |
| marginFrequency | out double | Upon return, contains the frequency, in hertz (Hz), at which the margin occurred in the lower (negative) offset. |
| marginAbsolutePower | out double | Upon return, contains the power, in dBm or dBm/Hz, at which the margin occurred in the lower (negative) offset segment. The power is measured in dBm when you set the SetPowerUnits(string, RFmxSpecAnMXSemPowerUnits) method to dBm, and in dBm/Hz when you set the SetPowerUnits(string, RFmxSpecAnMXSemPowerUnits) method to dBmPerHertz. |
| marginRelativePower | out double | Upon return, contains the power, in dB, at which the margin occurred in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.