CoreFlow 1.0.0
A modern orchestration and execution runtime
Loading...
Searching...
No Matches
coreflow::Threshold Class Reference

#include <vx_threshold.h>

Inheritance diagram for coreflow::Threshold:
coreflow::Reference

Public Member Functions

 Threshold (vx_context context, vx_reference scope)
 Construct a new Threshold object.
 
 ~Threshold ()
 Destroy the Threshold object.
 
void setBinaryValue (vx_int32 value)
 Set the binary threshold value.
 
void setBinaryValueUnion (vx_pixel_value_t value)
 Set the binary threshold value as a pixel value union.
 
void setLowerBound (vx_int32 lower)
 Set the lower bound for range threshold.
 
void setLowerBoundUnion (vx_pixel_value_t lower)
 Set the lower bound for range threshold as a pixel value union.
 
void setUpperBound (vx_int32 upper)
 Set the upper bound for range threshold.
 
void setUpperBoundUnion (vx_pixel_value_t upper)
 Set the upper bound for range threshold as a pixel value union.
 
void setTrueValue (vx_int32 true_value)
 Set the true value for output.
 
void setTrueValueUnion (vx_pixel_value_t true_value)
 Set the true value for output as a pixel value union.
 
void setFalseValue (vx_int32 false_value)
 Set the false value for output.
 
void setFalseValueUnion (vx_pixel_value_t false_value)
 Set the false value for output as a pixel value union.
 
vx_int32 binaryValue () const
 Get the binary threshold value.
 
vx_pixel_value_t binaryValueUnion () const
 Get the binary threshold value as a pixel value union.
 
vx_int32 lowerBound () const
 Get the lower bound for range threshold.
 
vx_pixel_value_t lowerBoundUnion () const
 Get the lower bound for range threshold as a pixel value union.
 
vx_int32 upperBound () const
 Get the upper bound for range threshold.
 
vx_pixel_value_t upperBoundUnion () const
 Get the upper bound for range threshold as a pixel value union.
 
vx_int32 trueValue () const
 Get the true value for output.
 
vx_pixel_value_t trueValueUnion () const
 Get the true value for output as a pixel value union.
 
vx_int32 falseValue () const
 Get the false value for output.
 
vx_pixel_value_t falseValueUnion () const
 Get the false value for output as a pixel value union.
 
vx_enum dataType () const
 Get the data type of the threshold.
 
vx_enum threshType () const
 Get the threshold type.
 
vx_df_image inputFormat () const
 Get the input image format.
 
vx_df_image outputFormat () const
 Get the output image format.
 
vx_status 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 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 copyValue (vx_pixel_value_t *value_ptr, vx_enum usage, vx_enum user_mem_type)
 Copy the threshold value to/from user memory.
 
vx_uint32 refCount () const
 Returns the reference count of the object.
 
const vx_charrefName () const
 Returns the name of the reference.
 
void setName (const vx_char *name)
 Sets the name of the reference.
 
vx_uint32 incrementReference (vx_reftype_e refType)
 Increments the ref count.
 
vx_uint32 decrementReference (vx_reftype_e refType)
 Decrements the ref count.
 
vx_uint32 totalReferenceCount ()
 Returns the total reference count of the object.
 
void initReferenceForDelay (vx_delay delay, vx_int32 index)
 Used to initialize any vx_reference as a delay element.
 
virtual void destruct ()
 Destruct reference.
 

Static Public Member Functions

static vx_threshold createThreshold (vx_context context, vx_enum thresh_type, vx_enum data_type)
 Create a threshold object.
 
static vx_bool isValidThresholdType (vx_enum thresh_type)
 Validate threshold type.
 
static vx_bool isValidThresholdDataType (vx_enum data_type)
 Validate theshold data type.
 
static vx_bool isValidThresholdFormat (vx_df_image format)
 Validate threshold format.
 
static vx_reference createReference (vx_context context, vx_enum type, vx_reftype_e refType, vx_reference scope)
 Used to create a reference.
 
static void printReference (vx_reference ref)
 Prints the values of a reference.
 
static vx_bool isValidReference (vx_reference ref)
 Used to validate everything but vx_context, vx_image and vx_buffer.
 
static vx_bool isValidReference (vx_reference ref, vx_enum type)
 Used to validate everything but vx_context, vx_image and vx_buffer.
 
static vx_size sizeOfType (vx_enum type)
 Returns the number of bytes in the internal structure for a given type.
 
static vx_status releaseReference (vx_reference *ref, vx_enum type, vx_reftype_e reftype, vx_destructor_f special_destructor)
 Used to destroy a reference.
 

Public Attributes

vx_enum thresh_type
 From vx_threshold_type_e.
 
vx_enum data_type
 From vx_type_e.
 
vx_pixel_value_t value
 The binary threshold value.
 
vx_pixel_value_t lower
 Lower bound for range threshold.
 
vx_pixel_value_t upper
 Upper bound for range threshold.
 
vx_pixel_value_t true_value
 True value for output.
 
vx_pixel_value_t false_value
 False value for output.
 
vx_df_image input_format
 The input image format.
 
vx_df_image output_format
 The output image format.
 
struct _vx_platform * platform
 Platform for ICD compatibility.
 
vx_uint32 magic
 Used to validate references, must be set to VX_MAGIC.
 
vx_enum type
 Set to an enum value in vx_type_e.
 
vx_context context
 Pointer to the top level context. If this reference is the context, this will be NULL.
 
vx_reference scope
 The pointer to the object's scope parent. When virtual objects are scoped within a graph, this will point to that parent graph. This is left generic to allow future scoping variations. By default scope should be the same as context.
 
vx_uint32 external_count
 The count of the number of users with this reference. When greater than 0, this can not be freed. When zero, the value can be considered inaccessible.
 
vx_uint32 internal_count
 The count of the number of framework references. When greater than 0, this can not be freed.
 
vx_uint32 read_count
 The number of times the object has been read (in some portion)
 
vx_uint32 write_count
 The number of times the object has been written to (in some portion)
 
vx_sem_t lock
 The reference lock which is used to protect access to "in-fly" data.
 
void * reserved
 A reserved field which can be used to store anonymous data.
 
vx_uint32 index
 A field which can be used to store a temporary, per-graph index.
 
vx_bool extracted
 This indicates if the object was extracted from another object.
 
vx_bool is_virtual
 This indicates if the object is virtual or not.
 
vx_delay delay
 
vx_int32 delay_slot_index
 
vx_bool is_accessible
 This indicates that if the object is virtual whether it is accessible at the moment or not.
 
vx_char name [VX_MAX_REFERENCE_NAME]
 The reference name.
 

Member Data Documentation

◆ context

vx_context coreflow::Reference::context
inherited

Pointer to the top level context. If this reference is the context, this will be NULL.

◆ data_type

vx_enum coreflow::Threshold::data_type

From vx_type_e.

◆ delay

vx_delay coreflow::Reference::delay
inherited

◆ delay_slot_index

vx_int32 coreflow::Reference::delay_slot_index
inherited

◆ external_count

vx_uint32 coreflow::Reference::external_count
inherited

The count of the number of users with this reference. When greater than 0, this can not be freed. When zero, the value can be considered inaccessible.

◆ extracted

vx_bool coreflow::Reference::extracted
inherited

This indicates if the object was extracted from another object.

◆ false_value

vx_pixel_value_t coreflow::Threshold::false_value

False value for output.

◆ index

vx_uint32 coreflow::Reference::index
inherited

A field which can be used to store a temporary, per-graph index.

◆ input_format

vx_df_image coreflow::Threshold::input_format

The input image format.

◆ internal_count

vx_uint32 coreflow::Reference::internal_count
inherited

The count of the number of framework references. When greater than 0, this can not be freed.

◆ is_accessible

vx_bool coreflow::Reference::is_accessible
inherited

This indicates that if the object is virtual whether it is accessible at the moment or not.

◆ is_virtual

vx_bool coreflow::Reference::is_virtual
inherited

This indicates if the object is virtual or not.

◆ lock

vx_sem_t coreflow::Reference::lock
inherited

The reference lock which is used to protect access to "in-fly" data.

◆ lower

vx_pixel_value_t coreflow::Threshold::lower

Lower bound for range threshold.

◆ magic

vx_uint32 coreflow::Reference::magic
inherited

Used to validate references, must be set to VX_MAGIC.

◆ name

vx_char coreflow::Reference::name[VX_MAX_REFERENCE_NAME]
inherited

The reference name.

◆ output_format

vx_df_image coreflow::Threshold::output_format

The output image format.

◆ platform

struct _vx_platform* coreflow::Reference::platform
inherited

Platform for ICD compatibility.

◆ read_count

vx_uint32 coreflow::Reference::read_count
inherited

The number of times the object has been read (in some portion)

◆ reserved

void* coreflow::Reference::reserved
inherited

A reserved field which can be used to store anonymous data.

◆ scope

vx_reference coreflow::Reference::scope
inherited

The pointer to the object's scope parent. When virtual objects are scoped within a graph, this will point to that parent graph. This is left generic to allow future scoping variations. By default scope should be the same as context.

◆ thresh_type

vx_enum coreflow::Threshold::thresh_type

◆ true_value

vx_pixel_value_t coreflow::Threshold::true_value

True value for output.

◆ type

vx_enum coreflow::Reference::type
inherited

Set to an enum value in vx_type_e.

◆ upper

vx_pixel_value_t coreflow::Threshold::upper

Upper bound for range threshold.

◆ value

vx_pixel_value_t coreflow::Threshold::value

The binary threshold value.

◆ write_count

vx_uint32 coreflow::Reference::write_count
inherited

The number of times the object has been written to (in some portion)