vftr_shd.c File Reference

Interface of shaking object detection module. More...

Functions
VFTR_SHD_INSTANCE_S *	VFTR_SHD_newInstance (void)
	Create shaking object detector instance. More...
INT32	VFTR_SHD_deleteInstance (VFTR_SHD_INSTANCE_S **instance)
	Delete shaking object detector instance. More...
INT32	VFTR_SHD_setParam (VFTR_SHD_INSTANCE_S *instance, const VFTR_SHD_PARAM_S *param)
	Set SHD parameters. More...
INT32	VFTR_SHD_getParam (const VFTR_SHD_INSTANCE_S *instance, VFTR_SHD_PARAM_S *param)
	Get SHD parameters. More...
INT32	VFTR_SHD_detectShake (VFTR_SHD_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_SHD_STATUS_S *status)
	Detect shaking objects. More...
INT32	VFTR_SHD_getStat (const VFTR_SHD_INSTANCE_S *instance, VFTR_SHD_STATUS_S *status)
	Detect object shaking properties. More...
INT32	VFTR_SHD_setUserLongTermList (VFTR_SHD_INSTANCE_S *instance, const VFTR_SHD_LONGTERM_LIST_S *lt_list)
	Configure user long term list. More...
INT32	VFTR_SHD_getUserLongTermList (const VFTR_SHD_INSTANCE_S *instance, VFTR_SHD_LONGTERM_LIST_S *lt_list)
	Retrieve user long term list configuration. More...

Detailed Description

Interface of shaking object detection module.

Function Documentation

INT32 VFTR_SHD_deleteInstance

(

VFTR_SHD_INSTANCE_S **

instance

)

Delete shaking object detector instance.

Parameters

[in,out]

instance

pointer to object instance pointer

Returns

The execution result.

Return values

0	success
-EFAULT	pointer of SHD instance is NULL

See also

VFTR_SDH_newInstance()

INT32 VFTR_SHD_detectShake	(	VFTR_SHD_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_SHD_STATUS_S *	status
	)

Detect shaking objects.

Parameters

[in,out]	instance	The pointer to shaking object detector instance.
[in]	obj_list	object list.
[out]	status	SHD status.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.
-EINVAL	invalid input parameters.

See also

VFTR_SHD_getStat()

When object_i is detected as shaking:

• status->shaking[i] is true, and status->shake_rect[i] is valid. When object_i is not detected as shaking:

status->shaking[i] is false, and status->shake_rect[i] is not modified.

INT32 VFTR_SHD_getParam	(	const VFTR_SHD_INSTANCE_S *	instance,
		VFTR_SHD_PARAM_S *	param
	)

Get SHD parameters.

Parameters

[in]	instance	The pointer to shaking object detector instance.
[out]	param	SHD parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

SHD_setParam()

INT32 VFTR_SHD_getStat	(	const VFTR_SHD_INSTANCE_S *	instance,
		VFTR_SHD_STATUS_S *	status
	)

Detect object shaking properties.

Parameters

[in]	instance	The pointer to shaking object detector instance.
[out]	status	SHD status.

Returns

The execution result

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_SHD_detectShake()

INT32 VFTR_SHD_getUserLongTermList	(	const VFTR_SHD_INSTANCE_S *	instance,
		VFTR_SHD_LONGTERM_LIST_S *	lt_list
	)

Retrieve user long term list configuration.

Parameters

[in]	instance	Pointer to shaking ojbect detector instance.
[out]	lt_list	pointer to user long term list

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.
-EINVAL	invalid input parameters.

See also

VFTR_SHD_setUserLongTermList()

VFTR_SHD_INSTANCE_S* VFTR_SHD_newInstance

(

void

)

Create shaking object detector instance.

Default value of SHD parameter is as following

{
    .en = 1,
    .obj_life_th = 32,
    .sensitivity = 75,
    .quality = 75,
    .instance_duration = 10,
    .shaking_update_duration = 30,
    .longterm_life_th = 10,
    .longterm_dec_period = 1800,
}

Returns

The pointer of shaking object detector instance.

Return values

NULL	fail to create instance
Not NULL	success to create instance

See also

VFTR_SHD_setParam()

VFTR_SHD_setUserLongTermList()

VFTR_SHD_deleteInstance()

< long term life dec

< long term life dec

< long term life dec

< long term life active threshold

INT32 VFTR_SHD_setParam	(	VFTR_SHD_INSTANCE_S *	instance,
		const VFTR_SHD_PARAM_S *	param
	)

Set SHD parameters.

Parameters

[in]	instance	The pointer to shaking object detector instance.
[in]	param	SHD parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.
-EINVAL	invalid parameters.

See also

VFTR_SHD_getParam()

After configured SHD instance, it restarts to initial state.

INT32 VFTR_SHD_setUserLongTermList	(	VFTR_SHD_INSTANCE_S *	instance,
		const VFTR_SHD_LONGTERM_LIST_S *	lt_list
	)

Configure user long term list.

Parameters

[in]	instance	Pointer to shaking ojbect detector instance.
[in]	lt_list	pointer to user long term list

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.
-EINVAL	invalid input parameters.

See also

VFTR_SHD_getUserLongTermList()