ni.com is currently undergoing scheduled maintenance.

Some services may be unavailable at this time. Please contact us for help or try again later.

RFmx CDMA2K CVI

RFmxCDMA2k_AnalyzeSpectrum1Waveform

  • Updated2024-10-14
  • 2 minute(s) read

RFmxCDMA2k_AnalyzeSpectrum1Waveform

int32 __stdcall RFmxCDMA2k_AnalyzeSpectrum1Waveform (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[], float64 x0, float64 dx, float32 spectrum[], int32 arraySize, int32 reset, int64 reserved);

Purpose

Performs the enabled measurements on the spectrum waveform that you specify in spectrum parameter. Call this function after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. Use this function only if the RFMXINSTR_ATTR_RECOMMENDED_ACQUISITION_TYPE attribute value is either spectral or IQorSpectral.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxCDMA2k_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this input, either the result name specified by resultName parameter or the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxCDMA2k_BuildSignalString function to build the selector string.
resultName char[] Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix.
Example:
"result::r1"
"r1"
x0 float64 Specifies the start frequency of the spectrum. This value is expressed in Hz.
dx float64 Specifies the frequency interval between data points in the spectrum.
spectrum float32[] Contains the real-value power spectrum.
arraySize int32 Specifies the size of the array.
reset int32 Resets measurement averaging. If you enable averaging, set this parameter to TRUE for first record and FALSE for subsequent records.
reserved int64 Reserved for future use. Any value passed to this parameter will be ignored.

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 RFmxCDMA2k_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience