niBTSA_CFOGetCurrentIterationPacketFrequencyDeviationTrace
- Updated2023-02-21
- 2 minute(s) read
int32 __stdcall niBTSA_CFOGetCurrentIterationPacketFrequencyDeviationTrace( niBTSASession session, char channelString[], float64 *t0, float64 *dt, float64 packetFrequencyDeviationTrace[], int32 dataArraySize, int32 *actualArraySize);
Purpose
Returns the block frequency offset trace. The toolkit averages the trace over the number of acquisitions specified by the NIBTSA_CFO_NUMBER_OF_AVERAGES attribute. The toolkit uses peak hold averaging for this trace. The absolute values of the trace are used for peak hold averaging.
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. |
| channelString | char[] | Set this parameter to "" (empty string) or NULL. |
| dataArraySize | int32 | Specifies the number of elements in the CFOBlockFrequencyOffset array. |
| Output | ||
| Name | Type | Description |
| t0 | float64* | Returns the starting time of the unprocessed I/Q trace, where the start of packet corresponds to 0 seconds. This value is expressed in seconds. |
| dt | float64* | Returns the time interval between data points in the frequency deviation trace. This value is expressed in seconds. |
| packetFrequencyDeviationTrace | float64[] | Returns the array of block frequency offsets of the signal. This value is expressed in Hz. The toolkit integrates the frequency deviation of every 10 symbols in the payload starting from the second payload symbol until the end of the payload duration. The integral sums are recorded as fn. The toolkit calculates the block frequency offset as the difference between the initial carrier frequency tolerance and fn. |
| actualArraySize | int32* | Returns the actual number of elements populated in the CFOBlockFrequencyOffset array. If the array is not large enough to hold all the samples, the function returns an error and the actualArraySize parameter returns the minimum expected size of the output 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:
|
||||||||