vftr_dk.h File Reference

Core feature-lib for door keeper. More...

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

Data Structures
struct	VFTR_DK_PARAM_S
	Struct for door keeper parameter. More...
struct	VFTR_DK_INSTANCE_STATUS_S
	Struct for door keeper status of each object. More...
struct	VFTR_DK_STATUS_S
	Struct for door keeper status. More...
struct	VFTR_DK_INSTANCE_S
	Struct for door keeper instance. More...

Macros
#define	IVA_JIF_HZ   (100)
#define	VFTR_DK_OVERLAP_FRACTION   8
#define	VFTR_DK_OVERLAP_WEIGHT_MAX   (1 << (VFTR_DK_OVERLAP_FRACTION))

Enumerations
enum	VFTR_DK_DET_RESULT_E {   VFTR_DK_DET_UNKNOWN = 0, VFTR_DK_DET_APPEAR = 1, VFTR_DK_DET_PASSBY = 2, VFTR_DK_DET_APPROACH = 3,   VFTR_DK_DET_LOITER = 4, VFTR_DK_DET_VISIT = 5, VFTR_DK_DET_NUM = 6 }
	Enumeration of door keeper detection status. More...

Functions
VFTR_DK_INSTANCE_S *	VFTR_DK_newInstance ()
	Create door keeper instance. More...
INT32	VFTR_DK_deleteInstance (VFTR_DK_INSTANCE_S **instance)
	Delete door keeper instance. More...
INT32	VFTR_DK_setParam (VFTR_DK_INSTANCE_S *instance, const MPI_SIZE_S *res, const VFTR_DK_PARAM_S *param)
	Set door keeper parameters. More...
INT32	VFTR_DK_checkParam (const VFTR_DK_PARAM_S *param)
	Check door keeper parameters is valid or not. More...
INT32	VFTR_DK_getParam (const VFTR_DK_INSTANCE_S *instance, VFTR_DK_PARAM_S *param)
	Get door keeper parameters. More...
INT32	_VFTR_DK_dump (VFTR_DK_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_DK_STATUS_S *status)
	Dump DK debuging info. More...
INT32	_VFTR_DK_detect (VFTR_DK_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_DK_STATUS_S *status)
	Detect door keeper. More...
INT32	VFTR_DK_getStat (const VFTR_DK_INSTANCE_S *instance, VFTR_DK_STATUS_S *stat)
	Get door keeper detected result. More...
FORCE_INLINE INT32	VFTR_DK_detect (VFTR_DK_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_DK_STATUS_S *status)
	An inline function. If variable vftr_dump_en is true, then call dump function for debugging. More...

Detailed Description

Core feature-lib for door keeper.

Macro Definition Documentation

#define IVA_JIF_HZ   (100)

IVA jiffer time (in Hz)

Enumeration Type Documentation

enum VFTR_DK_DET_RESULT_E

Enumeration of door keeper detection status.

Enumerator
VFTR_DK_DET_UNKNOWN	Object init in the scence
VFTR_DK_DET_APPEAR	Object appear in the scence
VFTR_DK_DET_PASSBY	Object pass through the roi
VFTR_DK_DET_APPROACH	Object approach in the scence
VFTR_DK_DET_LOITER	Object loiter in the scence
VFTR_DK_DET_VISIT	Object visit in the roi

Function Documentation

INT32 _VFTR_DK_detect	(	VFTR_DK_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_DK_STATUS_S *	status
	)

Detect door keeper.

Parameters

[in]	instance	Pointer to door keeper instance.
[in]	obj_list	Pointer to object list.
[out]	status	Pointer to door keeper detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

none

INT32 _VFTR_DK_dump	(	VFTR_DK_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_DK_STATUS_S *	status
	)

Dump DK debuging info.

Parameters

[in]	instance	The pointer to door keeper parameters instance.
[in]	obj_list	The pointer to object list.
[out]	status	The pointer to door keeper parameters result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

none

INT32 VFTR_DK_checkParam

(

const VFTR_DK_PARAM_S *

param

)

Check door keeper parameters is valid or not.

Parameters

[in]

param

Pointer to door keeper parameters.

Returns

The execution result.

Return values

0	success.
-EINVAL	door keeper parameters is invalid.

See also

VFTR_DK_setParam()

VFTR_DK_getParam()

INT32 VFTR_DK_deleteInstance

(

VFTR_DK_INSTANCE_S **

instance

)

Delete door keeper instance.

Parameters

[in]

instance

Pointer to pointer to door keeper instance.

Returns

The execution result.

Return values

0	success.
-EFAULT	pointer of door keeper instance is NULL.

See also

VFTR_DK_newInstance()

FORCE_INLINE INT32 VFTR_DK_detect	(	VFTR_DK_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_DK_STATUS_S *	status
	)

An inline function. If variable vftr_dump_en is true, then call dump function for debugging.

See also

_VFTR_DK_dump()

_VFTR_DK_detectMotion()

INT32 VFTR_DK_getParam	(	const VFTR_DK_INSTANCE_S *	instance,
		VFTR_DK_PARAM_S *	param
	)

Get door keeper parameters.

Parameters

[in]	instance	Pointer to door keeper instance.
[out]	param	Pointer to door keeper parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_DK_setParam()

VFTR_DK_checkParam()

INT32 VFTR_DK_getStat	(	const VFTR_DK_INSTANCE_S *	instance,
		VFTR_DK_STATUS_S *	status
	)

Get door keeper detected result.

Parameters

[in]	instance	Pointer to door keeper instance.
[out]	status	Pointer to door keeper detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

None.

VFTR_DK_INSTANCE_S* VFTR_DK_newInstance

(

)

Create door keeper instance.

Returns

The pointer of door keeper instance.

Return values

NULL	fail to create instance
Not NULL	success to create instance

See also

VFTR_DK_deleteInstance()

INT32 VFTR_DK_setParam	(	VFTR_DK_INSTANCE_S *	instance,
		const MPI_SIZE_S *	res,
		const VFTR_DK_PARAM_S *	param
	)

Set door keeper parameters.

Parameters

[in]	instance	Pointer to door keeper instance.
[in]	res	Pointer to mpi resolution.
[in]	param	Pointer to door keeper parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_DK_checkParam()

VFTR_DK_getParam()