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

ID 790148
Date 3/22/2024
Public

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

Document Table of Contents

HistogramInit, HistogramUniformInit

Initializes the specification structure for the ippiHistogram function.

Syntax

IppStatus ippiHistogramInit(IppDataType dataType, const Ipp32f* pLevels[], int nLevels[], int numChannels, IppiHistogramSpec* pSpec);

IppStatus ippiHistogramUniformInit(IppDataType dataType, Ipp32f lowerLevel[], Ipp32f upperLevel[], int nLevels[], int numChannels, IppiHistogramSpec* pSpec);

Include Files

ippi.h

Domain Dependencies

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

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

Parameters

dataType

Data type of the source image. Supported values are: ipp8u, ipp16u, ipp16s, and ipp32f.

pLevels

Pointer to the array of pointers to the level values vectors for each channel.

lowerLevel

Lower levels for uniform histogram, separate for each channel.

upperLevel

Upper levels for uniform histogram, separate for each channel.

nLevels

Number of level values. Each channel has a separate number of levels.

numChannels

Number of image channels. Supported values are: 1, 3, and 4.

pSpec

Pointer to the specification structure.

Description

The ippiHistogramInit function initializes the specification structure for the Histogram function.

For an example on how to use these functions, refer to the example provided with the Histogram function description.

Return Values

ippStsNoErr

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

ippStsNullPtrErr

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

ippStsSizeErr

Indicates an error when roiSize is less than, or equal to zero.

ippStsHistoNofLevelsErr

Indicates an error when the number of levels is less than 2.

ippStsNumChannelsErr

Indicates an error when the numChannels value differs from 1, 3, or 4.

ippStsDataTypeErr

Indicates an error when the dataType value differs from ipp8u, ipp16u, ipp16s, or ipp32f.

See Also