vftr_fld.h File Reference

Core feature-lib for fall detection (FLD) More...

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

Data Structures
struct	VFTR_FLD_PARAM_S
	Structure for the parameters of FLD. More...
struct	VFTR_FLD_INSTANCE_STATUS_S
	Structure of FLD object status. More...
struct	VFTR_FLD_STATUS_S
	Struct for FLD status. More...
struct	VFTR_FLD_INSTANCE_S
	Struct for FLD instance status. More...

Macros
#define	VFTR_FLD_FRACTION   8
#define	VFTR_FLD_WEIGHT_MAX   (1 << (VFTR_FLD_FRACTION))

Enumerations
enum	VFTR_FLD_RESULT_E {   VFTR_FLD_UNKNOWN = 0, VFTR_FLD_NORMAL = 1, VFTR_FLD_FALLING = 2, VFTR_FLD_DOWN = 3,   VFTR_FLD_FALLEN = 4, VFTR_FLD_NUM = 5 }
	Enumeration of fall detection result. More...

Functions
VFTR_FLD_INSTANCE_S *	VFTR_FLD_newInstance ()
	Create FLD (fall detection) instance. More...
INT32	VFTR_FLD_deleteInstance (VFTR_FLD_INSTANCE_S **instance)
	Delete FLD instance. More...
INT32	VFTR_FLD_setParam (VFTR_FLD_INSTANCE_S *instance, const VFTR_FLD_PARAM_S *param)
	Set FLD (fall detection) parameters. More...
INT32	VFTR_FLD_checkParam (const VFTR_FLD_PARAM_S *param)
	Check FLD parameters. More...
INT32	VFTR_FLD_getParam (const VFTR_FLD_INSTANCE_S *instance, VFTR_FLD_PARAM_S *param)
	Get FLD parameters. More...
INT32	VFTR_FLD_detect (VFTR_FLD_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_FLD_STATUS_S *status)
	Detect FLD (fall detection) result. More...
INT32	VFTR_FLD_getStat (const VFTR_FLD_INSTANCE_S *instance, VFTR_FLD_STATUS_S *stat)
	Get FLD status. More...

Detailed Description

Core feature-lib for fall detection (FLD)

Macro Definition Documentation

#define VFTR_FLD_FRACTION   8

Fraction bit of FLD

#define VFTR_FLD_WEIGHT_MAX   (1 << (VFTR_FLD_FRACTION))

Maximum weight of FLD.

Enumeration Type Documentation

enum VFTR_FLD_RESULT_E

Enumeration of fall detection result.

Enumerator
VFTR_FLD_UNKNOWN	Object init in the scence
VFTR_FLD_NORMAL	Object normal in the scence
VFTR_FLD_FALLING	Object falling in the scence
VFTR_FLD_DOWN	Object down in the scence
VFTR_FLD_FALLEN	Object fallen in the scence
VFTR_FLD_NUM	Number of enum FLD_RESULT_E

Function Documentation

INT32 VFTR_FLD_checkParam

(

const VFTR_FLD_PARAM_S *

inParam

)

Check FLD parameters.

Parameters

[in]

param

FLD parameters.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_FLD_setParam()

VFTR_FLD_getParam()

INT32 VFTR_FLD_deleteInstance

(

VFTR_FLD_INSTANCE_S **

instance

)

Delete FLD instance.

Parameters

[in]

instance

FLD instance status.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_DK_newInstance()

INT32 VFTR_FLD_detect	(	VFTR_FLD_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_FLD_STATUS_S *	status
	)

Detect FLD (fall detection) result.

Parameters

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

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_FLD_getStat()

INT32 VFTR_FLD_getParam	(	const VFTR_FLD_INSTANCE_S *	instance,
		VFTR_FLD_PARAM_S *	param
	)

Get FLD parameters.

Parameters

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

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_FLD_setParam()

VFTR_FLD_checkParam()

INT32 VFTR_FLD_getStat	(	const VFTR_FLD_INSTANCE_S *	instance,
		VFTR_FLD_STATUS_S *	status
	)

Get FLD status.

Parameters

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

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_FLD_detect()

VFTR_FLD_INSTANCE_S* VFTR_FLD_newInstance

(

)

Create FLD (fall detection) instance.

Returns

The pointer to FLD instance.

Return values

Not NULL	success to create instance
NULL	fail to create instance

See also

VFTR_FLD_deleteInstance()

INT32 VFTR_FLD_setParam	(	VFTR_FLD_INSTANCE_S *	instance,
		const VFTR_FLD_PARAM_S *	param
	)

Set FLD (fall detection) parameters.

Parameters

[in]	instance	FLD instance.
[in]	param	FLD parameters.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_FLD_checkParam()

VFTR_FLD_getParam()