Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

WinHamming, WinHammingSep

MODIFIED API. Apply Hamming window function to the image.

Syntax

Case 1: Not-in-place operation

IppStatus ippiWinHamming_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R

16u_C1R

32f_C1R

IppStatus ippiWinHammingSep_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R

16u_C1R

32f_C1R

Case 2: In-place operation

IppStatus ippiWinHamming_<mod>(Ipp<datatype>* pSrcDst, int srcDstStep, IppiSize roiSize, Ipp8u* pBuffer);

Supported values for mod:

8u_C1IR

16u_C1IR

32f_C1IR

IppStatus ippiWinHammingSep_<mod>(Ipp<datatype>* pSrcDst, int srcDstStep, IppiSize roiSize, Ipp8u* pBuffer);

Supported values for mod:

8u_C1IR

16u_C1IR

32f_C1IR

Include Files

ippi.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib

Parameters

pSrc

Pointer to the source image ROI.

srcStep

Distance, in bytes, between the starting points of consecutive lines in the source image.

pDst

Pointer to the destination image ROI.

dstStep

Distance, in bytes, between the starting points of consecutive lines in the destination image.

pSrcDst

Pointer to the source and destination image ROI for the in-place operation.

srcDstStep

Distance, in bytes, between the starting points of consecutive lines in the source and destination image for the in-place operation.

roiSize

Size of the source and destination ROI, in pixels.

pBuffer

Pointer to the work buffer. To compute the size of the buffer, use the ippiWinHammingGetBufferSize or ippiWinHammingSepGetBufferSize function.

Description

These functions operate with ROI (see Regions of Interest in Intel IPP).

These functions compute the Hamming (triangle) window samples, multiply pixel values of the source image pSrc (pSrcDst for in-place flavors) with these samples, and store results in the destination image pDst ( pSrcDst for in-place flavors).

The Hamming window function for one-dimensional case with M elements is defined as follows:


The ippiWinHammingSep flavor applies the window function successively to the rows and then to the columns of the image.

Return Values

ippStsNoErr

Indicates no error. Any other value indicates an error or a warning.

ippStsNullPtrErr

Indicates an error when pSrc or pDst pointer is NULL.

ippStsStepErr

Indicates an error when srcStep or dstStep value is zero or negative.

ippStsSizeErr

Indicates an error when width or height of images is less than, or equal to zero.

See Also