TI VPAC NF (Noise filter) Kernel APIs

Detailed Description

VPAC Noise Filter Kernels.

Data Structures
struct	tivx_vpac_nf_common_params_t
	The configuration data structure used by the TIVX_KERNEL_VPAC_NF_GENERIC and TIVX_KERNEL_VPAC_NF_BILATERAL kernels. More...
struct	tivx_vpac_nf_bilateral_params_t
	The configuration data structure used by the TIVX_KERNEL_VPAC_NF_BILATERAL kernel. More...
struct	tivx_vpac_nf_bilateral_sigmas_t
	The sigmas data structure used by the TIVX_KERNEL_VPAC_NF_BILATERAL kernel. More...
struct	tivx_vpac_nf_hts_bw_limit_params_t
	Configuration parameters used to set HTS BW limit used by TIVX_KERNEL_VPAC_NF kernel. More...

Defines
#define	TIVX_KERNEL_VPAC_NF_GENERIC_NAME   "com.ti.hwa.vpac_nf_generic"
	vpac_nf_generic kernel name
#define	TIVX_KERNEL_VPAC_NF_BILATERAL_NAME   "com.ti.hwa.vpac_nf_bilateral"
	vpac_nf_bilateral kernel name

Functions
void	tivxRegisterHwaTargetVpacNfKernels (void)
	Function to register HWA Kernels on the vpac_nf Target.
void	tivxUnRegisterHwaTargetVpacNfKernels (void)
	Function to un-register HWA Kernels on the vpac_nf Target.
VX_API_ENTRY vx_node VX_API_CALL	tivxVpacNfGenericNode (vx_graph graph, vx_user_data_object configuration, vx_image input, vx_convolution conv, vx_image output)
	[Graph] Creates a VPAC_NF_GENERIC Node. More...
VX_API_ENTRY vx_node VX_API_CALL	tivxVpacNfBilateralNode (vx_graph graph, vx_user_data_object configuration, vx_image input, vx_user_data_object sigmas, vx_image output)
	[Graph] Creates a VPAC_NF_BILATERAL Node. More...
void	tivx_vpac_nf_common_params_init (tivx_vpac_nf_common_params_t *prms)
	Function to initialize NF common Parameters. More...
void	tivx_vpac_nf_hts_bw_limit_params_init (tivx_vpac_nf_hts_bw_limit_params_t *prms)
	Function to initialize NF HTS bandwidth limit Parameters. More...
void	tivx_vpac_nf_bilateral_params_init (tivx_vpac_nf_bilateral_params_t *prms)
	Function to initialize NF bilateral Parameters. More...
void	tivx_vpac_nf_bilateral_sigmas_init (tivx_vpac_nf_bilateral_sigmas_t *sigmas)
	Function to initialize NF bilateral Sigmas. More...

Function Documentation

tivxVpacNfGenericNode()

VX_API_ENTRY vx_node VX_API_CALL tivxVpacNfGenericNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_image	input,
		vx_convolution	conv,
		vx_image	output
	)

[Graph] Creates a VPAC_NF_GENERIC Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration	The input object of a single params structure of type tivx_vpac_nf_common_params_t.
[in]	input	The input image in VX_DF_IMAGE_U8, VX_DF_IMAGE_U16, or TIVX_DF_IMAGE_P12 format.
[in]	conv	The input convolution matrix. Max columns or rows supported is 5. Scale value is ignored. Coefficients are 9-bit signed.
[out]	output	The output image in VX_DF_IMAGE_U8, VX_DF_IMAGE_U16, or TIVX_DF_IMAGE_P12 format.

See also

TIVX_KERNEL_VPAC_NF_GENERIC_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus

tivxVpacNfBilateralNode()

VX_API_ENTRY vx_node VX_API_CALL tivxVpacNfBilateralNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_image	input,
		vx_user_data_object	sigmas,
		vx_image	output
	)

[Graph] Creates a VPAC_NF_BILATERAL Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration	The input object of a single params structure of type tivx_vpac_nf_bilateral_params_t.
[in]	input	The input image in VX_DF_IMAGE_U8, VX_DF_IMAGE_U16, or TIVX_DF_IMAGE_P12 format.
[in]	sigmas	The input object of a single params structure of type tivx_vpac_nf_bilateral_sigmas_t.
[out]	output	The output image in VX_DF_IMAGE_U8, VX_DF_IMAGE_U16, or TIVX_DF_IMAGE_P12 format.

See also

TIVX_KERNEL_VPAC_NF_BILATERAL_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus

tivx_vpac_nf_common_params_init()

void tivx_vpac_nf_common_params_init

(

tivx_vpac_nf_common_params_t *

prms

)

Function to initialize NF common Parameters.

Parameters

prms	[IN] Pointer to NF common parameters

tivx_vpac_nf_hts_bw_limit_params_init()

void tivx_vpac_nf_hts_bw_limit_params_init

(

tivx_vpac_nf_hts_bw_limit_params_t *

prms

)

Function to initialize NF HTS bandwidth limit Parameters.

Parameters

prms	[IN] Pointer to NF HTS bandwidth limit parameters

tivx_vpac_nf_bilateral_params_init()

void tivx_vpac_nf_bilateral_params_init

(

tivx_vpac_nf_bilateral_params_t *

prms

)

Function to initialize NF bilateral Parameters.

Parameters

prms	[IN] Pointer to NF bilateral parameters

tivx_vpac_nf_bilateral_sigmas_init()

void tivx_vpac_nf_bilateral_sigmas_init

(

tivx_vpac_nf_bilateral_sigmas_t *

sigmas

)

Function to initialize NF bilateral Sigmas.

Parameters

sigmas

[IN] Pointer to NF bilateral sigmas