RFmxSpecAn_PhaseNoiseCfgAutoRange

RFmx SpecAn 19.1 Help

Edition Date: October 2019

Part Number: 374264N-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgAutoRange (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, float64 RBWPercentage);

Purpose

Configures the offset range and the RBW percentage when you set the RFMXSpecAn_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString function to build the selector string.
startFrequency float64 Specifies the start frequency of the offset frequency when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed in Hz.
stopFrequency float64 Specifies the stop frequency of the offset frequency range when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed in Hz.
RBWPercentage float64 Specifies the RBW as a percentage of the start frequencyof each sub-range when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed as a percentage.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful