Image Statistics

Returns various image statistics of the input image. More...

Functions
VPIStatus	vpiSubmitImageStats (VPIStream stream, uint64_t backend, VPIImage input, VPIArray statistics, VPIImage mask, uint32_t flags)
	Returns various image statistics of the input image. More...

Detailed Description

Returns various image statistics of the input image.

Function Documentation

vpiSubmitImageStats()

VPIStatus vpiSubmitImageStats	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage	input,
		VPIArray	statistics,
		VPIImage	mask,
		uint32_t	flags
	)

#include </opt/nvidia/vpi3/include/vpi/algo/ImageStats.h>

Returns various image statistics of the input image.

Parameters

[in]	stream	A stream handle where the operation will be queued into.
[in]	backend	Backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA
[in]	input	Input image. Valid Image formats: Formats CPU CUDA VPI_IMAGE_FORMAT_U8 * * VPI_IMAGE_FORMAT_S8 * * VPI_IMAGE_FORMAT_U16 * * VPI_IMAGE_FORMAT_S16 * * VPI_IMAGE_FORMAT_Y8 * * VPI_IMAGE_FORMAT_Y8_ER * * VPI_IMAGE_FORMAT_Y16 * * VPI_IMAGE_FORMAT_Y16_ER * * VPI_IMAGE_FORMAT_U32 * * VPI_IMAGE_FORMAT_S32 * * VPI_IMAGE_FORMAT_RGB8 * * VPI_IMAGE_FORMAT_RGBA8 * * VPI_IMAGE_FORMAT_BGR8 * * VPI_IMAGE_FORMAT_BGRA8 * * VPI_IMAGE_FORMAT_NV12 * * VPI_IMAGE_FORMAT_NV12_ER * * VPI_IMAGE_FORMAT_NV24 * * VPI_IMAGE_FORMAT_NV24_ER * * VPI_IMAGE_FORMAT_2S16 * * VPI_IMAGE_FORMAT_F32 * * VPI_IMAGE_FORMAT_F64 * * VPI_IMAGE_FORMAT_2F32 * * VPI_IMAGE_FORMAT_RGB8p * VPI_IMAGE_FORMAT_RGBA8p * VPI_IMAGE_FORMAT_BGR8p * VPI_IMAGE_FORMAT_BGRA8p *
[out]	statistics	Output array. Must be of type VPI_ARRAY_TYPE_STATISTICS Must not be NULL.
[in]	mask	Image statistics kernel binary image mask. It defines the pixels that will be used for the image statistics calculation. The pixel under a non-zero mask element will be used in image statistics calculation. Use NULL for all elements in statistics calculation, i.e. all mask pixels considered to be non-zero. If not NULL, it must be of image format VPI_IMAGE_FORMAT_U8 and same size as input image.
[in]	flags	Statistics calculation flags. Flags determine which image statistics will be calculated. The accepted flags are: VPI_STAT_PIXEL_COUNT VPI_STAT_SUM VPI_STAT_MEAN (also triggers the VPI_STAT_PIXEL_COUNT and VPI_STAT_SUM flags) VPI_STAT_VARIANCE (also triggers the VPI_STAT_MEAN flag) VPI_STAT_COVARIANCE (also triggers the VPI_STAT_VARIANCE flag) flags can be a combination of the accepted flags.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or statistics are NULL.
VPI_ERROR_INVALID_ARGUMENT	input and mask image dimensions do not match.
VPI_ERROR_INVALID_ARGUMENT	flags not supported.
VPI_ERROR_INVALID_ARGUMENT	backend is invalid or unknown.
VPI_ERROR_INVALID_IMAGE_FORMAT	input and mask formats aren't supported
VPI_ERROR_NOT_IMPLEMENTED	Image Stats algorithm is not supported by given backend.
VPI_ERROR_INVALID_OPERATION	Backend hardware not available.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or statistics.
VPI_SUCCESS	Operation executed successfully.