MinMaxLoc

Find in an image the minimum and maximum value locations. More...

Functions
VPIStatus	vpiCreateMinMaxLoc (uint64_t backends, int32_t imageWidth, int32_t imageHeight, VPIImageFormat imageFormat, VPIPayload *payload)
	Creates payload for vpiSubmitMinMaxLoc. More...
VPIStatus	vpiSubmitMinMaxLoc (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIArray minCoords, VPIArray maxCoords)
	Finds minimum and maximum value locations in an image. More...

Detailed Description

Find in an image the minimum and maximum value locations.

The function vpiCreateMinMaxLoc is used to create the payload for the algorithm. The function vpiSubmitMinMaxLoc is used to find minimum and maximum locations in an image.

Function Documentation

vpiCreateMinMaxLoc()

VPIStatus vpiCreateMinMaxLoc	(	uint64_t	backends,
		int32_t	imageWidth,
		int32_t	imageHeight,
		VPIImageFormat	imageFormat,
		VPIPayload *	payload
	)

#include </opt/nvidia/vpi2/include/vpi/algo/MinMaxLoc.h>

Creates payload for vpiSubmitMinMaxLoc.

Parameters

[in]	backends	VPI backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA Backend must be enabled in current context.
[in]	imageWidth,imageHeight	Input image dimensions. Must be >= 1x1.
[in]	imageFormat	Input image format. Supported formats: VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_S8 VPI_IMAGE_FORMAT_U16 VPI_IMAGE_FORMAT_S16 VPI_IMAGE_FORMAT_U32 VPI_IMAGE_FORMAT_S32 VPI_IMAGE_FORMAT_F32 VPI_IMAGE_FORMAT_F64
[out]	payload	Pointer to the payload variable that receives the created handle.

Return values

VPI_ERROR_INVALID_ARGUMENT	payload is NULL.
VPI_ERROR_INVALID_ARGUMENT	imageWidth or imageHeight outside valid range.
VPI_ERROR_INVALID_ARGUMENT	backend refers to an invalid backend.
VPI_ERROR_NOT_IMPLEMENTED	MinMaxLoc algorithm is not supported by given backend.
VPI_ERROR_INVALID_CONTEXT	Current context is destroyed.
VPI_IMAGE_FORMAT_INVALID	imageFormat is not supported.
VPI_ERROR_OUT_OF_MEMORY	Cannot allocate required resources.
VPI_ERROR_INVALID_OPERATION	Backend isn't enabled in current context.
VPI_SUCCESS	Operation executed successfully.

vpiSubmitMinMaxLoc()

VPIStatus vpiSubmitMinMaxLoc	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage	input,
		VPIArray	minCoords,
		VPIArray	maxCoords
	)

#include </opt/nvidia/vpi2/include/vpi/algo/MinMaxLoc.h>

Finds minimum and maximum value locations in an image.

Note

The MinMaxLoc algorithm does not guarantee deterministic output. Each array capacity (minCoords and maxCoords in vpiSubmitMinMaxLoc) limit the number of locations found by the algorithm, that is the total number may be greater than this limitation and the set of locations returned might differ from one backend to another and in different runs on the same backend. Additionally, there is no strict ordering imposed to each array of locations and might also differ on different backends and runs.

Parameters

[in]	stream	The stream handle where the operation will be queued in. Must not be NULL. Stream must have enabled the backends that will execute the algorithm.
[in]	backend	Backend that will execute the algorithm. Must be the backend specified during payload creation or 0 as a shorthand to use this backend.
[in]	payload	Payload as created by vpiCreateMinMaxLoc.
[in]	input	Input image where minimum and/or maximum are to be found. Must not be NULL. Input image size and format must match the ones defined in vpiCreateMinMaxLoc. Input image pitch must be a multiple of its pixels if using VPI_BACKEND_CUDA. Image must have enabled the backends that will execute the algorithm.
[out]	minCoords	Output array that stores pixel coordinates with minimum value. If not needed, pass NULL. Number of coordinates returned is limited by array capacity. Array type must be VPI_ARRAY_TYPE_KEYPOINT_F32. Array must have enabled the backends that will execute the algorithm.
[out]	maxCoords	Output array that stores pixel coordinates with maximum value. If not needed, pass NULL. Number of coordinates returned is limited by array capacity. Array type must be VPI_ARRAY_TYPE_KEYPOINT_F32. Array must have enabled the backends that will execute the algorithm.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input is NULL.
VPI_ERROR_INVALID_ARGUMENT	payload is not created using vpiCreateMinMaxLoc.
VPI_ERROR_INVALID_ARGUMENT	input image dimension and format does not match the ones associated with payload.
VPI_ERROR_INVALID_ARRAY_TYPE	minCoords or maxCoords array type not accepted.
VPI_ERROR_INVALID_PAYLOAD_TYPE	payload is invalid.
VPI_ERROR_INVALID_OPERATION	The given backend isn't enabled in stream.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input, minCoords or maxCoords.
VPI_SUCCESS	Operation executed successfully.