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

Descriptor

The optional descriptor element describes the data associated with the operation. Descriptors are individual characters that indicate additional details of the operation.

The Intel IPP functions use the following descriptors:

Descriptor Description Example

A

Image data contains an alpha channel as the last channel, requires C4, alpha-channel is not processed.

ippiFilterMax_8u_AC4R

Axx

Advanced arithmetic operations with xx bits of accuracy.

ippsPowx_32f_A11

C

The function operates on a specified channel of interest (COI) for each source image.

ippiSet_8u_C3CR

Cn

Image data consists of n channels. Possible values for n: 1, 2, 3, 4.

ippiFilterBorder_32f_C1R

Dx

D

Signal is x-dimensional (default is D1).

ippsConcat_8u_D2

I

Operation is in-place (default is not-in-place).

ippsAdd_16s_I

L

Platform-aware functions (see Using Intel IPP Platform-Aware Functions for details).

ippiAdd_8u_C1RSfs_L

TL

Threading layer functions (see Using Intel IPP Threading Layer Functions for details).

ippiAdd_8u_C1RSfs_LT

M

Operation uses a mask to determine pixels to be processed.

ippiCopy_8u_C1MR

Pn

Image data consists of n discrete planar (not-interleaved) channels with a separate pointer to each plane. Possible values for n: 1, 2, 3, 4.

ippiAlphaPremul_8u_AP4R

R

Function operates on a defined region of interest (ROI) for each source image.

ippiMean_8u_C4R

s

Saturation and no scaling (default).

ippiConvert_16s16u_C1Rs

Sfs

Saturation and fixed scaling mode (default is saturation and no scaling).

ippsConvert_16s8s_Sfs

The descriptors in function names are presented in the function name in alphabetical order.

Some data descriptors are default for certain operations and not added to the function names. For example, the image processing functions always operate on a two-dimensional image and saturate the results without scaling them. In these cases, the implied descriptors D2 (two-dimensional signal) and s (saturation and no scaling) are not included in the function name.