HistogramGetBufferSize
Computes the size of the specification structure and work
buffer for the
ippiHistogram
function.Syntax
IppStatus
ippiHistogramGetBufferSize(IppDataType
dataType
, IppiSize
roiSize
, const int
nLevels[]
, int
numChannels
, int
uniform
, int*
pSpecSize
, int*
pBufferSize
);
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, andipp32f.
- roiSize
- Size of the source image ROI, in pixels.
- 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.
- uniform
- Type of levels distribution: 0 - with random step, 1 - with uniform step.
- pSpecSize
- Pointer to the computed value of the specification structure size, in bytes.
- pBufferSize
- Pointer to the computed value of the external buffer size.
Description
The
ippiHistogramGetBufferSize
function computes the size of the histogram
specification structure and the size of the external work buffer (in bytes) needed
for the Histogram
function. For an example on how to use this function, 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 isNULL.
- ippStsSizeErr
- Indicates an error whenroiSizeis less than, or equal to zero.
- ippStsHistoNofLevelsErr
- Indicates an error when the number of levels is less than 2.
- ippStsNumChannelsErr
- Indicates an error when thenumChannelsvalue differs from 1, 3, or 4.
- ippStsDataTypeErr
- Indicates an error when thedataTypevalue differs fromipp8u,ipp16u,ipp16s, oripp32f.