niRFSA_ConfigureResolutionBandwidth
ViStatus = niRFSA_ConfigureResolutionBandwidth( ViSession vi, ViConstString channelList, ViReal64 resolutionBandwidth);
Purpose
Configures the resolution bandwidth of a spectrum acquisition. The resolution bandwidth controls the width of the frequency bins in the power spectrum computed by NI-RFSA. A larger value for resolution bandwidth means the frequency bins are wider, and hence you get fewer bins or spectral lines.
By default, the resolution bandwidth value corresponds to the 3 dB bandwidth of the window type NI-RFSA uses to compute the spectrum. To specify the frequency bin width directly, change the resolution bandwidth type attribute to bin width. Refer to the NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE attribute for more information.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. |
| channelList | ViConstString | Identifies channels to apply settings. Use "" or VI_NULL to specify all channels. |
| resolutionBandwidth | ViReal64 | Specifies the resolution bandwidth of a spectrum acquisition. The value is expressed in Hertz. Configure the type of resolution bandwidth with the NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE attribute. |
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. You examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the status code, call the niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
|---|---|---|---|---|
| 0 | Success | |||
| Positive Values | Warnings | |||
| Negative Values | Errors |