Crop Scaler

Crops rectangular regions from the input image, rescale them to uniform dimensions and writes them in a single image to be used in further batched image processing. More...

Functions
VPIStatus	vpiCreateCropScaler (uint64_t backends, int maxFrames, int maxObjects, VPIPayload *payload)
	Creates payload instance for the Crop Scale algorithm. More...
VPIStatus	vpiSubmitCropScalerBatch (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage *frameList, int32_t numFrames, VPIArray objects, int32_t patchWidth, int32_t patchHeight, VPIImage outPatches)
	Crops rectangular regions from the input frames and rescale them all to the same dimensions. More...

Detailed Description

Crops rectangular regions from the input image, rescale them to uniform dimensions and writes them in a single image to be used in further batched image processing.

Function Documentation

vpiCreateCropScaler()

VPIStatus vpiCreateCropScaler	(	uint64_t	backends,
		int	maxFrames,
		int	maxObjects,
		VPIPayload *	payload
	)

#include <vpi/algo/CropScaler.h>

Creates payload instance for the Crop Scale algorithm.

Parameters

[in]	backends	VPI backends that are eligible to execute the algorithm. Valid values: VPI_BACKEND_CUDA Backend must be enabled in current context.
[in]	maxFrames	Maximum number of frames. Must be >= 1 and <= 128.
[in]	maxObjects	Maximum number of objects. Must be >= 1.
[out]	payload	Pointer to the payload variable that receives the created handle.

Return values

VPI_ERROR_INVALID_OPERATION	Backend isn't enabled in current context.
VPI_ERROR_NOT_IMPLEMENTED	Crop Scaler algorithm is not supported by given backend.
VPI_ERROR_INVALID_CONTEXT	Current context is destroyed.
VPI_ERROR_OUT_OF_MEMORY	Cannot allocate required resources.
VPI_SUCCESS	Operation executed successfully.

vpiSubmitCropScalerBatch()

VPIStatus vpiSubmitCropScalerBatch	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage *	frameList,
		int32_t	numFrames,
		VPIArray	objects,
		int32_t	patchWidth,
		int32_t	patchHeight,
		VPIImage	outPatches
	)

#include <vpi/algo/CropScaler.h>

Crops rectangular regions from the input frames and rescale them all to the same dimensions.

Parameters

[in]	stream	The stream 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 created by vpiCreateCropScaler.
[in]	frameList	List of image frames. If an image within frameList is NULL, its correponding objects won't be processed. Must not be NULL. Must point to an array of at least numFrames images. Each image must have enabled the backends that will execute the algorithm. All frames must have the same image format, size, and pitch. The pitch must be a multiple of the element size. Valid image formats: Formats CUDA VPI_IMAGE_FORMAT_RGBA8 * VPI_IMAGE_FORMAT_NV12_ER * VPI_IMAGE_FORMAT_NV12 *
[in]	numFrames	Number of input frames in the batch. Must be >= 1 and <= maxFrames estipulated in vpiCreateCropScaler.
[in]	objects	Input array with bounding boxes associated with each input frame via its index. Must not be NULL. Must have enabled the backends that will execute the algorithm. The index of the input frame for each object must be >= 0 and < numFrames. An out-of-bounds index is undefined behavior. Valid array types: VPI_ARRAY_TYPE_DCF_TRACKED_BOUNDING_BOX Objects with state VPI_TRACKING_STATE_LOST won't be processed, as well as objects whose frame in frameList is NULL.
[in]	patchWidth	The width of the patch to be written to outPatches. Must be positive.
[in]	patchHeight	The height of the patch to be written to outPatches. Must be positive.
[out]	outPatches	Image where the cropped and rescale patches will be written to. The width of each patch will be equal to patchWidth. The height of each patch will be equal to patchHeight. The patch for an object 'o' will then start at row o * patchHeight and have height 'patchHeight'. If image format is different from input frame's, an image format conversion will be performed on the fly. Image height must be at least patchHeight * numObjects, where 'numObjects' is the size of inObjects. Image width must be at least patchWidth. Valid image formats: Formats CUDA VPI_IMAGE_FORMAT_RGB8p * VPI_IMAGE_FORMAT_BGR8p * VPI_IMAGE_FORMAT_RGBA8p * VPI_IMAGE_FORMAT_RGBA8 * VPI_IMAGE_FORMAT_RGB8 * VPI_IMAGE_FORMAT_BGR8 *

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	frameList, objects or outPatches are NULL.
VPI_ERROR_INVALID_ARGUMENT	payload not created by vpiCreateCropScaler.
VPI_ERROR_INVALID_ARGUMENT	outPatches' height not divisible by the number of objects.
VPI_ERROR_INVALID_ARGUMENT	Input frames have different image size.
VPI_ERROR_INVALID_IMAGE_FORMAT	Input frames have different image format.
VPI_ERROR_INVALID_ARRAY_TYPE	Unsupported array type in objects.
VPI_ERROR_INVALID_PAYLOAD_TYPE	payload is invalid.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, some image in frameList, outPatches or objects.
VPI_SUCCESS	Operation executed successfully.