Internal Convolution API

The Internal Convolution API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Convolution::Convolution (vx_context context, vx_reference scope)
	Construct a new Convolution object.
static vx_convolution	coreflow::Convolution::createConvolution (vx_context context, vx_size columns, vx_size rows)
	Create a new convolution.
vx_uint32	coreflow::Convolution::scaleFactor () const
	Get the scale factor of the convolution.
vx_size	coreflow::Convolution::size () const
	Get the size of the convolution in bytes.
void	coreflow::Convolution::setScale (vx_uint32 value)
	Set the scale factor of the convolution.
vx_status	coreflow::Convolution::readCoefficients (vx_int16 *array)
	Read the coefficients of the convolution.
vx_status	coreflow::Convolution::writeCoefficients (const vx_int16 *array)
	Write the coefficients of the convolution.
vx_status	coreflow::Convolution::copyCoefficients (void *ptr, vx_enum usage, vx_enum mem_type)
	Copy the coefficients to a specified memory location.
	coreflow::Convolution::~Convolution ()
	Destroy the Convolution object.
void	coreflow::Convolution::destruct () override final
	Destroys a convolution.

Variables
vx_uint32	coreflow::Convolution::scale
	The Scale Factor.

Detailed Description

The Internal Convolution API.

Function Documentation

Convolution()

coreflow::Convolution::Convolution	(	vx_context	context,
		vx_reference	scope )

#include <vx_convolution.h>

Construct a new Convolution object.

Parameters

context	The context associated with object
scope	The parent ref of this object

copyCoefficients()

vx_status coreflow::Convolution::copyCoefficients	(	void *	ptr,
		vx_enum	usage,
		vx_enum	mem_type )

#include <vx_convolution.h>

Copy the coefficients to a specified memory location.

Parameters

ptr	Pointer to the memory location
usage	Memory usage type
mem_type	Memory type (e.g., host, device)

Returns

vx_status The status of the operation

createConvolution()

static vx_convolution coreflow::Convolution::createConvolution ( vx_context context, vx_size columns, vx_size rows )

static

#include <vx_convolution.h>

Create a new convolution.

Parameters

context	The context associated with this convolution
columns	The number of columns in the convolution
rows	The number of rows in the convolution

Returns

vx_convolution The convolution object

destruct()

void coreflow::Convolution::destruct ( )

finaloverridevirtual

#include <vx_convolution.h>

Destroys a convolution.

Reimplemented from coreflow::Reference.

readCoefficients()

vx_status coreflow::Convolution::readCoefficients

(

vx_int16 *

array

)

#include <vx_convolution.h>

Read the coefficients of the convolution.

Parameters

array

The array to read coefficients into

Returns

vx_status The status of the operation

scaleFactor()

vx_uint32 coreflow::Convolution::scaleFactor

(

)

const

#include <vx_convolution.h>

Get the scale factor of the convolution.

Returns

vx_uint32 The scale factor

setScale()

void coreflow::Convolution::setScale

(

vx_uint32

value

)

#include <vx_convolution.h>

Set the scale factor of the convolution.

Parameters

value

The scale factor to set

size()

vx_size coreflow::Convolution::size

(

)

const

#include <vx_convolution.h>

Get the size of the convolution in bytes.

Returns

vx_size The size in bytes

writeCoefficients()

vx_status coreflow::Convolution::writeCoefficients

(

const vx_int16 *

array

)

#include <vx_convolution.h>

Write the coefficients of the convolution.

Parameters

array

The array containing coefficients to write

Returns

vx_status The status of the operation

~Convolution()

coreflow::Convolution::~Convolution

(

)

#include <vx_convolution.h>

Destroy the Convolution object.

Variable Documentation

scale

vx_uint32 coreflow::Convolution::scale

The Scale Factor.