vftr_aroi.h File Reference

Core feature-lib for automatic region of interest (AROI) More...

#include "mpi_base_types.h"
#include "mpi_index.h"
#include "mpi_iva.h"

Data Structures
struct	VFTR_AROI_PARAM_S
	Struct for automatic region of interest parameter. More...
struct	VFTR_AROI_STATUS_S
	Struct for aroi status. More...
struct	VFTR_AROI_INSTANCE_S
	Struct for AROI instance status. More...

Macros
#define	VFTR_AROI_MIN_UPDATE_RATIO   (0)
#define	VFTR_AROI_MAX_UPDATE_RATIO   (64)
#define	VFTR_AROI_AR_FRACTIONAL_BIT   (13)
#define	VFTR_AROI_MIN_TRACK_DELTA   (1)
#define	VFTR_AROI_MAX_TRACK_DELTA   (255)
#define	VFTR_AROI_MIN_WAIT_TIME   (0)
#define	VFTR_AROI_MAX_WAIT_TIME   (1023)
#define	VFTR_AROI_MIN_RETURN_DELTA   (1)
#define	VFTR_AROI_MAX_RETURN_DELTA   (255)
#define	VFTR_AROI_MIN_OBJ_LIFE_TH   (0)
#define	VFTR_AROI_MAX_OBJ_LIFE_TH   (MPI_IVA_OD_MAX_LIFE)

Functions
VFTR_AROI_INSTANCE_S *	VFTR_AROI_newInstance ()
	Create AROI (automatic region of interest) instance. More...
INT32	VFTR_AROI_deleteInstance (VFTR_AROI_INSTANCE_S **instance)
	Delete AROI instance. More...
INT32	VFTR_AROI_setParam (VFTR_AROI_INSTANCE_S *instance, const MPI_SIZE_S *res, const VFTR_AROI_PARAM_S *param)
	Set AROI (automatic region of interest) parameters. More...
INT32	VFTR_AROI_checkParam (const VFTR_AROI_PARAM_S *param, const MPI_SIZE_S *res)
	Check AROI parameters. More...
INT32	VFTR_AROI_getParam (const VFTR_AROI_INSTANCE_S *instance, VFTR_AROI_PARAM_S *param)
	Get AROI parameters. More...
INT32	VFTR_AROI_detectRoi (VFTR_AROI_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_AROI_STATUS_S *status)
	Detect AROI (automatic region of interest) result. More...
INT32	VFTR_AROI_getStat (const VFTR_AROI_INSTANCE_S *instance, VFTR_AROI_STATUS_S *status)
	Get AROI status. More...
INT32	VFTR_AROI_getTarget (const VFTR_AROI_INSTANCE_S *instance, MPI_RECT_POINT_S *target)
	Get AROI target. More...

Detailed Description

Core feature-lib for automatic region of interest (AROI)

Macro Definition Documentation

#define VFTR_AROI_AR_FRACTIONAL_BIT   (13)

Fraction bit of AROI

#define VFTR_AROI_MAX_OBJ_LIFE_TH   (MPI_IVA_OD_MAX_LIFE)

Max object life threshold of AROI .

#define VFTR_AROI_MAX_RETURN_DELTA   (255)

Max return delta of AROI.

#define VFTR_AROI_MAX_TRACK_DELTA   (255)

Max track delta of AROI.

#define VFTR_AROI_MAX_UPDATE_RATIO   (64)

Max update ratio of AROI.

#define VFTR_AROI_MAX_WAIT_TIME   (1023)

Max wait time of AROI.

#define VFTR_AROI_MIN_OBJ_LIFE_TH   (0)

Min object life threshold of AROI .

#define VFTR_AROI_MIN_RETURN_DELTA   (1)

Min return delta of AROI.

#define VFTR_AROI_MIN_TRACK_DELTA   (1)

Min track delta of AROI.

#define VFTR_AROI_MIN_UPDATE_RATIO   (0)

Min update ratio of AROI.

#define VFTR_AROI_MIN_WAIT_TIME   (0)

Min wait time of AROI.

Function Documentation

INT32 VFTR_AROI_checkParam	(	const VFTR_AROI_PARAM_S *	param,
		const MPI_SIZE_S *	res
	)

Check AROI parameters.

Parameters

[in]

param

AROI parameters.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_setParam()

VFTR_AROI_getParam()

INT32 VFTR_AROI_deleteInstance

(

VFTR_AROI_INSTANCE_S **

instance

)

Delete AROI instance.

Parameters

[in]

instance

AROI instance.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_newInstance()

INT32 VFTR_AROI_detectRoi	(	VFTR_AROI_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_AROI_STATUS_S *	status
	)

Detect AROI (automatic region of interest) result.

Parameters

[in]	instance	AROI instance.
[in]	obj_list	OD object list.
[out]	status	AROI detected result.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_getStat()

VFTR_AROI_getTarget()

INT32 VFTR_AROI_getParam	(	const VFTR_AROI_INSTANCE_S *	instance,
		VFTR_AROI_PARAM_S *	param
	)

Get AROI parameters.

Parameters

[in]	instance	AROI instance.
[out]	param	AROI parameters.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_setParam()

VFTR_AROI_checkParam()

INT32 VFTR_AROI_getStat	(	const VFTR_AROI_INSTANCE_S *	instance,
		VFTR_AROI_STATUS_S *	status
	)

Get AROI status.

Parameters

[in]	instance	AROI instance.
[out]	status	AROI detected result.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_detectRoi()

VFTR_AROI_getTarget()

INT32 VFTR_AROI_getTarget	(	const VFTR_AROI_INSTANCE_S *	instance,
		MPI_RECT_POINT_S *	target
	)

Get AROI target.

Parameters

[in]	instance	AROI instance.
[out]	target	AROI detected target.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_detectRoi()

VFTR_AROI_getStat()

VFTR_AROI_INSTANCE_S* VFTR_AROI_newInstance

(

)

Create AROI (automatic region of interest) instance.

Returns

The pointer to AROI instance.

Return values

Not NULL	success to create instance
NULL	fail to create instance

See also

VFTR_AROI_deleteInstance()

INT32 VFTR_AROI_setParam	(	VFTR_AROI_INSTANCE_S *	instance,
		const MPI_SIZE_S *	res,
		const VFTR_AROI_PARAM_S *	param
	)

Set AROI (automatic region of interest) parameters.

Parameters

[in]	instance	AROI instance.
[in]	param	AROI parameters.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_AROI_checkParam()

VFTR_AROI_getParam()