niBTSA_AnalyzePowerSpectrum

NI Bluetooth Analysis Toolkit 19.1 Help

Edition Date: October 2019

Part Number: 373431L-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niBTSA_AnalyzePowerSpectrum (niBTSASession session, float64 f0, float64 df, float64 spectrum[], int32 powerSpectrumArraySize);

Purpose

Performs spectral measurements on the input power spectrum. Pass the powerSpectrum parameter of the niBTSA_RFSAReadPowerSpectrum function to this function. Use the niBTSA_AnalyzePowerSpectrum function only if the NIBTSA_RECOMMENDED_ACQUISITION_TYPE attribute is set to NIBTSA_VAL_RECOMMENDED_ACQUISITION_TYPE_SPECTRUM.

Parameters

Input
Name Type Description
session niBTSASession Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input.
f0 float64 Specifies the start frequency of the spectrum. This value is expressed in Hz.
df float64 Specifies the frequency interval between data points in the spectrum. This value is expressed in Hz.
spectrum float64[] Specifies the acquired waveform as an array. If averaging is enabled, this function returns the averaged power spectrum.
powerSpectrumArraySize int32 Specifies the size of the spectrum array.

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. Examine the status code from each call to an niBT SA 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 niBTSA_GetErrorString 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