niRFSA_GetSpectralInfoForSMT
- Updated2024-05-08
- 1 minute(s) read
niRFSA_GetSpectralInfoForSMT
ViStatus niRFSA_GetSpectralInfoForSMT(ViSession vi, SmtSpectrumInfo* spectrumInfo);
Purpose
Returns information about the power spectrum NI-RFSA computes.
 |
Note The NI Spectral Measurements Toolkit (SMT) requires this information. |
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. |
| Output | ||
| Name | Type | Description |
| spectrumInfo | SmtSpectrumInfo* | Returns returns properties of the computed spectrum such as spectrum type, spectrum scale (linear or logarithmic), the window type the function used to compute the spectrum, window size, and FFT size. Pass this parameter to subsequent functions that contain the spectrumInfo parameter. |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | 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 NI-RFSA 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 niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||