Internal Threshold API

The Internal Threshold API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
void	ownReleaseThresholdInt (vx_threshold *threshold)
	Releases an internally referenced threshold.
	coreflow::Threshold::Threshold (vx_context context, vx_reference scope)
	Construct a new Threshold object.
	coreflow::Threshold::~Threshold ()
	Destroy the Threshold object.
static vx_threshold	coreflow::Threshold::createThreshold (vx_context context, vx_enum thresh_type, vx_enum data_type)
	Create a threshold object.
void	coreflow::Threshold::setBinaryValue (vx_int32 value)
	Set the binary threshold value.
void	coreflow::Threshold::setBinaryValueUnion (vx_pixel_value_t value)
	Set the binary threshold value as a pixel value union.
void	coreflow::Threshold::setLowerBound (vx_int32 lower)
	Set the lower bound for range threshold.
void	coreflow::Threshold::setLowerBoundUnion (vx_pixel_value_t lower)
	Set the lower bound for range threshold as a pixel value union.
void	coreflow::Threshold::setUpperBound (vx_int32 upper)
	Set the upper bound for range threshold.
void	coreflow::Threshold::setUpperBoundUnion (vx_pixel_value_t upper)
	Set the upper bound for range threshold as a pixel value union.
void	coreflow::Threshold::setTrueValue (vx_int32 true_value)
	Set the true value for output.
void	coreflow::Threshold::setTrueValueUnion (vx_pixel_value_t true_value)
	Set the true value for output as a pixel value union.
void	coreflow::Threshold::setFalseValue (vx_int32 false_value)
	Set the false value for output.
void	coreflow::Threshold::setFalseValueUnion (vx_pixel_value_t false_value)
	Set the false value for output as a pixel value union.
vx_int32	coreflow::Threshold::binaryValue () const
	Get the binary threshold value.
vx_pixel_value_t	coreflow::Threshold::binaryValueUnion () const
	Get the binary threshold value as a pixel value union.
vx_int32	coreflow::Threshold::lowerBound () const
	Get the lower bound for range threshold.
vx_pixel_value_t	coreflow::Threshold::lowerBoundUnion () const
	Get the lower bound for range threshold as a pixel value union.
vx_int32	coreflow::Threshold::upperBound () const
	Get the upper bound for range threshold.
vx_pixel_value_t	coreflow::Threshold::upperBoundUnion () const
	Get the upper bound for range threshold as a pixel value union.
vx_int32	coreflow::Threshold::trueValue () const
	Get the true value for output.
vx_pixel_value_t	coreflow::Threshold::trueValueUnion () const
	Get the true value for output as a pixel value union.
vx_int32	coreflow::Threshold::falseValue () const
	Get the false value for output.
vx_pixel_value_t	coreflow::Threshold::falseValueUnion () const
	Get the false value for output as a pixel value union.
vx_enum	coreflow::Threshold::dataType () const
	Get the data type of the threshold.
vx_enum	coreflow::Threshold::threshType () const
	Get the threshold type.
vx_df_image	coreflow::Threshold::inputFormat () const
	Get the input image format.
vx_df_image	coreflow::Threshold::outputFormat () const
	Get the output image format.
static vx_bool	coreflow::Threshold::isValidThresholdType (vx_enum thresh_type)
	Validate threshold type.
static vx_bool	coreflow::Threshold::isValidThresholdDataType (vx_enum data_type)
	Validate theshold data type.
static vx_bool	coreflow::Threshold::isValidThresholdFormat (vx_df_image format)
	Validate threshold format.
vx_status	coreflow::Threshold::copyOutput (vx_pixel_value_t *true_value_ptr, vx_pixel_value_t *false_value_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy the threshold output to/from user memory.
vx_status	coreflow::Threshold::copyRange (vx_pixel_value_t *lower_value_ptr, vx_pixel_value_t *upper_value_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy the threshold range to/from user memory.
vx_status	coreflow::Threshold::copyValue (vx_pixel_value_t *value_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy the threshold value to/from user memory.

Detailed Description

The Internal Threshold API.

Function Documentation

binaryValue()

vx_int32 coreflow::Threshold::binaryValue

(

)

const

#include <vx_threshold.h>

Get the binary threshold value.

Returns

vx_int32 The binary threshold value

binaryValueUnion()

vx_pixel_value_t coreflow::Threshold::binaryValueUnion

(

)

const

#include <vx_threshold.h>

Get the binary threshold value as a pixel value union.

Returns

vx_pixel_value_t

copyOutput()

vx_status coreflow::Threshold::copyOutput	(	vx_pixel_value_t *	true_value_ptr,
		vx_pixel_value_t *	false_value_ptr,
		vx_enum	usage,
		vx_enum	user_mem_type )

#include <vx_threshold.h>

Copy the threshold output to/from user memory.

Parameters

true_value_ptr	Pointer to the true value
false_value_ptr	Pointer to the false value
usage	Memory usage type (read/write)
user_mem_type	The type of memory (host, opencl, etc.)

Returns

vx_status VX_SUCCESS on success, error code otherwise

copyRange()

vx_status coreflow::Threshold::copyRange	(	vx_pixel_value_t *	lower_value_ptr,
		vx_pixel_value_t *	upper_value_ptr,
		vx_enum	usage,
		vx_enum	user_mem_type )

#include <vx_threshold.h>

Copy the threshold range to/from user memory.

Parameters

lower_value_ptr	Pointer to the lower value
upper_value_ptr	Pointer to the upper value
usage	Memory usage type (read/write)
user_mem_type	The type of memory (host, opencl, etc.)

Returns

vx_status VX_SUCCESS on success, error code otherwise

copyValue()

vx_status coreflow::Threshold::copyValue	(	vx_pixel_value_t *	value_ptr,
		vx_enum	usage,
		vx_enum	user_mem_type )

#include <vx_threshold.h>

Copy the threshold value to/from user memory.

Parameters

value_ptr	Pointer to the value
usage	Memory usage type (read/write)
user_mem_type	The type of memory (host, opencl, etc.)

Returns

vx_status VX_SUCCESS on success, error code otherwise

createThreshold()

static vx_threshold coreflow::Threshold::createThreshold ( vx_context context, vx_enum thresh_type, vx_enum data_type )

static

#include <vx_threshold.h>

Create a threshold object.

Parameters

context	The context associated with this obj
thresh_type	The threshold type
data_type	The data type

Returns

vx_threshold The threshold object

dataType()

vx_enum coreflow::Threshold::dataType

(

)

const

#include <vx_threshold.h>

Get the data type of the threshold.

Returns

vx_enum The data type

falseValue()

vx_int32 coreflow::Threshold::falseValue

(

)

const

#include <vx_threshold.h>

Get the false value for output.

Returns

vx_int32 The false value

falseValueUnion()

vx_pixel_value_t coreflow::Threshold::falseValueUnion

(

)

const

#include <vx_threshold.h>

Get the false value for output as a pixel value union.

Returns

vx_pixel_value_t

inputFormat()

vx_df_image coreflow::Threshold::inputFormat

(

)

const

#include <vx_threshold.h>

Get the input image format.

Returns

vx_df_image The input image format

isValidThresholdDataType()

static vx_bool coreflow::Threshold::isValidThresholdDataType ( vx_enum data_type )

static

#include <vx_threshold.h>

Validate theshold data type.

Parameters

data_type

Returns

vx_bool

isValidThresholdFormat()

static vx_bool coreflow::Threshold::isValidThresholdFormat ( vx_df_image format )

static

#include <vx_threshold.h>

Validate threshold format.

Parameters

format

Threshold format to validate

Returns

vx_bool true if valid, false otherwise

isValidThresholdType()

static vx_bool coreflow::Threshold::isValidThresholdType ( vx_enum thresh_type )

static

#include <vx_threshold.h>

Validate threshold type.

Parameters

thresh_type

Returns

vx_bool

lowerBound()

vx_int32 coreflow::Threshold::lowerBound

(

)

const

#include <vx_threshold.h>

Get the lower bound for range threshold.

Returns

vx_int32 The lower bound value

lowerBoundUnion()

vx_pixel_value_t coreflow::Threshold::lowerBoundUnion

(

)

const

#include <vx_threshold.h>

Get the lower bound for range threshold as a pixel value union.

Returns

vx_pixel_value_t

outputFormat()

vx_df_image coreflow::Threshold::outputFormat

(

)

const

#include <vx_threshold.h>

Get the output image format.

Returns

vx_df_image The output image format

ownReleaseThresholdInt()

void ownReleaseThresholdInt

(

vx_threshold *

threshold

)

#include <vx_threshold.h>

Releases an internally referenced threshold.

Parameters

[in]

threshold

The pointer to a threshold structure.

setBinaryValue()

void coreflow::Threshold::setBinaryValue

(

vx_int32

value

)

#include <vx_threshold.h>

Set the binary threshold value.

Parameters

value

The binary threshold value

setBinaryValueUnion()

void coreflow::Threshold::setBinaryValueUnion

(

vx_pixel_value_t

value

)

#include <vx_threshold.h>

Set the binary threshold value as a pixel value union.

Parameters

value

The binary threshold value as a pixel value union

setFalseValue()

void coreflow::Threshold::setFalseValue

(

vx_int32

false_value

)

#include <vx_threshold.h>

Set the false value for output.

Parameters

false_value

The false value

setFalseValueUnion()

void coreflow::Threshold::setFalseValueUnion

(

vx_pixel_value_t

false_value

)

#include <vx_threshold.h>

Set the false value for output as a pixel value union.

Parameters

false_value

The false value as a pixel value union

setLowerBound()

void coreflow::Threshold::setLowerBound

(

vx_int32

lower

)

#include <vx_threshold.h>

Set the lower bound for range threshold.

Parameters

lower

The lower bound value

setLowerBoundUnion()

void coreflow::Threshold::setLowerBoundUnion

(

vx_pixel_value_t

lower

)

#include <vx_threshold.h>

Set the lower bound for range threshold as a pixel value union.

Parameters

lower

The lower bound value as a pixel value union

setTrueValue()

void coreflow::Threshold::setTrueValue

(

vx_int32

true_value

)

#include <vx_threshold.h>

Set the true value for output.

Parameters

true_value

The true value

setTrueValueUnion()

void coreflow::Threshold::setTrueValueUnion

(

vx_pixel_value_t

true_value

)

#include <vx_threshold.h>

Set the true value for output as a pixel value union.

Parameters

true_value

The true value as a pixel value union

setUpperBound()

void coreflow::Threshold::setUpperBound

(

vx_int32

upper

)

#include <vx_threshold.h>

Set the upper bound for range threshold.

Parameters

upper

The upper bound value

setUpperBoundUnion()

void coreflow::Threshold::setUpperBoundUnion

(

vx_pixel_value_t

upper

)

#include <vx_threshold.h>

Set the upper bound for range threshold as a pixel value union.

Parameters

upper

The upper bound value as a pixel value union

Threshold()

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

#include <vx_threshold.h>

Construct a new Threshold object.

Parameters

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

threshType()

vx_enum coreflow::Threshold::threshType

(

)

const

#include <vx_threshold.h>

Get the threshold type.

Returns

vx_enum The threshold type

trueValue()

vx_int32 coreflow::Threshold::trueValue

(

)

const

#include <vx_threshold.h>

Get the true value for output.

Returns

vx_int32 The true value

trueValueUnion()

vx_pixel_value_t coreflow::Threshold::trueValueUnion

(

)

const

#include <vx_threshold.h>

Get the true value for output as a pixel value union.

Returns

vx_pixel_value_t

upperBound()

vx_int32 coreflow::Threshold::upperBound

(

)

const

#include <vx_threshold.h>

Get the upper bound for range threshold.

Returns

vx_int32 The upper bound value

upperBoundUnion()

vx_pixel_value_t coreflow::Threshold::upperBoundUnion

(

)

const

#include <vx_threshold.h>

Get the upper bound for range threshold as a pixel value union.

Returns

vx_pixel_value_t

~Threshold()

coreflow::Threshold::~Threshold

(

)

#include <vx_threshold.h>

Destroy the Threshold object.