Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public
Document Table of Contents

PowerSpectr

Computes the power spectrum of a complex vector.

Syntax

IppStatus ippsPowerSpectr_64fc(const Ipp64fc* pSrc, Ipp64f* pDst, int len);

IppStatus ippsPowerSpectr_32fc(const Ipp32fc* pSrc, Ipp32f* pDst, int len);

IppStatus ippsPowerSpectr_16sc_Sfs(const Ipp16sc* pSrc, Ipp16s* pDst, int len, int scaleFactor);

IppStatus ippsPowerSpectr_64f(const Ipp64f* pSrcRe, const Ipp64f* pSrcIm, Ipp64f* pDst, int len);

IppStatus ippsPowerSpectr_32f(const Ipp32f* pSrcRe, const Ipp32f* pSrcIm, Ipp32f* pDst, int len);

IppStatus ippsPowerSpectr_16s_Sfs(const Ipp16s* pSrcRe, const Ipp16s* pSrcIm, Ipp16s* pDst, int len, int scaleFactor);

IppStatus ippsPowerSpectr_16s32f(const Ipp16s* pSrcRe, const Ipp16s* pSrcIm, Ipp32f* pDst, int len);

IppStatus ippsPowerSpectr_16sc32f(const Ipp16sc* pSrc, Ipp32f* pDst, int len);

Include Files

ipps.h

Domain Dependencies

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Parameters

pSrc

Pointer to the source vector.

pSrcRe

Pointer to the source vector which stores the real components.

pSrcIm

Pointer to the source vector which stores the imaginary components.

pDst

Pointer to the vector which stores the spectrum components of the elements.

len

Number of elements in the vector

scaleFactor

Scale factor, refer to Integer Scaling.

Description

This function returns the power spectrum of the complex input vector pSrc, or the complex input vector whose real and imaginary components are specified in the vectors pSrcRe and pSrcIm, respectively, and stores the results in the vector pDst. The power spectrum elements are squares of the magnitudes of the complex input vector elements:

pDst[n] = ( pSrc[n].re)2 + (pSrc[n].im)2 , or pDst[n] = ( pSrcRe[n])2 + (pSrcIm[n])2 .

To compute magnitudes, use the function ippsMagnitude.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when at least one of the specified pointers is NULL.

ippStsSizeErr

Indicates an error when len is less than or equal to 0.