Simon Ford / dsp

CMSIS DSP Library from CMSIS 2.0. See http://www.onarm.com/cmsis/ for full details

Dependents:   K22F_DSP_Matrix_least_square BNO055-ELEC3810 1BNO055 ECE4180Project--Slave2 ... more

Embed: (wiki syntax)

« Back to documentation index

Complex Magnitude
Functions

Complex Magnitude
[Complex Math Functions]

Computes the magnitude of the elements of a complex data vector. More...

Functions

void arm_cmplx_mag_f32 (float32_t *pSrc, float32_t *pDst, uint32_t numSamples)
 Floating-point complex magnitude.
void arm_cmplx_mag_q15 (q15_t *pSrc, q15_t *pDst, uint32_t numSamples)
 Q15 complex magnitude.
void arm_cmplx_mag_q31 (q31_t *pSrc, q31_t *pDst, uint32_t numSamples)
 Q31 complex magnitude.

Detailed Description

Computes the magnitude of the elements of a complex data vector.

The pSrc points to the source data and pDst points to the where the result should be written. numSamples specifies the number of complex samples in the input array and the data is stored in an interleaved fashion (real, imag, real, imag, ...). The input array has a total of 2*numSamples values; the output array has a total of numSamples values. The underlying algorithm is used:

  
 for(n=0; n<numSamples; n++) {  
     pDst[n] = sqrt(pSrc[(2*n)+0]^2 + pSrc[(2*n)+1]^2);  
 }

There are separate functions for floating-point, Q15, and Q31 data types.

Function Documentation

void arm_cmplx_mag_f32 ( float32_t *  pSrc,
float32_t *  pDst,
uint32_t  numSamples 
)

Floating-point complex magnitude.

Parameters:
[in]*pSrcpoints to complex input buffer
[out]*pDstpoints to real output buffer
[in]numSamplesnumber of complex samples in the input vector
Returns:
none.

Definition at line 70 of file arm_cmplx_mag_f32.c.

void arm_cmplx_mag_q15 ( q15_t *  pSrc,
q15_t *  pDst,
uint32_t  numSamples 
)

Q15 complex magnitude.

Parameters:
*pSrcpoints to the complex input vector
*pDstpoints to the real output vector
numSamplesnumber of complex samples in the input vector
Returns:
none.

Scaling and Overflow Behavior:

The function implements 1.15 by 1.15 multiplications and finally output is converted into 2.14 format.

Definition at line 51 of file arm_cmplx_mag_q15.c.

void arm_cmplx_mag_q31 ( q31_t *  pSrc,
q31_t *  pDst,
uint32_t  numSamples 
)

Q31 complex magnitude.

Parameters:
*pSrcpoints to the complex input vector
*pDstpoints to the real output vector
numSamplesnumber of complex samples in the input vector
Returns:
none.

Scaling and Overflow Behavior:

The function implements 1.31 by 1.31 multiplications and finally output is converted into 2.30 format. Input down scaling is not required.

Definition at line 51 of file arm_cmplx_mag_q31.c.

Generated on Tue Jul 12 2022 14:13:55 by  doxygen 1.7.2