tofi_compute.h File Reference

#include <stdint.h>
#include "tofi_error.h"
#include "tofi_util.h"

Include dependency graph for tofi_compute.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	TemperatureInfo
struct	TofiComputeContext
	Function to get the version for TOF Depth Compute Engine Library. More...

Macros
#define	NO_OF_PHASES   3
#define	TOFI_COMPUTE_API

Functions
TOFI_COMPUTE_API void	FreeTofiCompute (TofiComputeContext *p_tofi_compute_context)
TOFI_COMPUTE_API TofiComputeContext *	InitTofiCompute (const void *p_tofi_cal_config, uint32_t *p_status)
TOFI_COMPUTE_API int	TofiCompute (const uint16_t *const input_frame, TofiComputeContext *const p_tofi_compute_context, TemperatureInfo *p_temperature)
TOFI_COMPUTE_API void	TofiSetABOnly (TofiComputeContext *const p_tofi_compute_context, int option)

Macro Definition Documentation

NO_OF_PHASES

#define NO_OF_PHASES   3

Definition at line 28 of file tofi_compute.h.

TOFI_COMPUTE_API

#define TOFI_COMPUTE_API

Definition at line 19 of file tofi_compute.h.

Function Documentation

FreeTofiCompute()

TOFI_COMPUTE_API void FreeTofiCompute

(

TofiComputeContext *

p_tofi_compute_context

)

Function to release memory for TOFI compute context structure including its parameters like Depth/AB/Confidence memory buffers

Parameters

[in,out]

TofiComputeContext

*p_tofi_compute_context: pointer to the TOFI compute context structure to be freed

Definition at line 147 of file tofiCompute.cpp.

InitTofiCompute()

TOFI_COMPUTE_API TofiComputeContext* InitTofiCompute	(	const void *	p_tofi_cal_config,
		uint32_t *	p_status
	)

Function to Initialize the configuration for TOFI compute context including memory allocation for parameters like Depth/AB/Confidence memory buffers

Parameters

[in]	const	void *p_tofi_cal_config: pointer to calibration configuration
[out]	uint32_t	*p_status: pointer to status, assigned as ADI_TOFI_SUCCESS on success, assigned as error code incase of failure

Returns

TofiComputeContext *: returns pointer to TofiComputeContext on success, returns NULL on failure

Definition at line 22 of file tofiCompute.cpp.

TofiCompute()

TOFI_COMPUTE_API int TofiCompute	(	const uint16_t *const	input_frame,
		TofiComputeContext *const	p_tofi_compute_context,
		TemperatureInfo *	p_temperature
	)

Function to process input frame data and output Depth/AB/Confidence frame data.

Parameters

[in]	const	uint16_t *const input_frame: Input frame data(unsigned short format) buffer
[in]	TofiComputeContext	*const p_tofi_compute_context: pointer to the TOFI compute context structure
[in]	TemperatureInfo	*p_temperature: pointer to the temperature data, temperature correction applied based on the value, no temperature correction is applied if this pointer is NULL

Returns

int: returns ADI_TOFI_SUCCESS(0) on success, returns error code (>1) on failure

Definition at line 106 of file tofiCompute.cpp.

TofiSetABOnly()

TOFI_COMPUTE_API void TofiSetABOnly	(	TofiComputeContext *const	p_tofi_compute_context,
		int	option
	)

Function to enable/disable AB only output

Parameters

[in]	TofiConfig	*p_tofi_cal_config: pointer to the TOFI
[in]	int	option: '1' for enable & '0' for disable