TIOVX User Guide
vx_tutorial_graph_user_kernel_pytiovx_uc.NodePhaseRgb Class Reference

Class to represent user/target kernel. More...

Inherits tiovx.node.Node.

Public Member Functions

def __init__ (self, image_in, image_out, name="default", target=Target.DEFAULT)
 Constructor for user/target kernel class. More...
 
def checkParams (self, param_type_args)
 Parameter checking function. More...
 
def setParams (self, num_in, num_out, param_type_args)
 Specify number of input/output parameters and data object type for each. More...
 
def setTarget (self, target)
 Specify target on which to run this node. More...
 
def setKernelEnumName (self, kernel_enum_name)
 Specify kernel enum name to use. More...
 

Detailed Description

Class to represent user/target kernel.

Dervied from tiovx::node::Node base class

Definition at line 84 of file vx_tutorial_graph_user_kernel_pytiovx_uc.py.

Constructor & Destructor Documentation

◆ __init__()

def vx_tutorial_graph_user_kernel_pytiovx_uc.NodePhaseRgb.__init__ (   self,
  image_in,
  image_out,
  name = "default",
  target = Target.DEFAULT 
)

Constructor for user/target kernel class.

Parameters
image_in[in] Input image handle parameter for this function
image_out[in] Output image handle parameter for this function
name[in] user indetifiable name
target[in] target CPU on which this kernel/node will run

Definition at line 91 of file vx_tutorial_graph_user_kernel_pytiovx_uc.py.

Member Function Documentation

◆ checkParams()

def vx_tutorial_graph_user_kernel_pytiovx_uc.NodePhaseRgb.checkParams (   self,
  param_type_args 
)

Parameter checking function.

Checks if number of parameters passed is correct Checks if data type of parameters passed is correct

Parameters
param_type_args[in] Variable number of args list of type tiovx.enums.Type to specify data object types

Definition at line 103 of file vx_tutorial_graph_user_kernel_pytiovx_uc.py.

◆ setParams()

def tiovx.node.Node.setParams (   self,
  num_in,
  num_out,
  param_type_args 
)
inherited

Specify number of input/output parameters and data object type for each.

Assumes input parameters are followed by output parameters. It is recommended user kernels follow this convention.

Parameters
num_in[in] Number of inputs
num_out[in] Number of outputs
param_type_args[in] Variable number of args list of type tiovx.enums.Type to specify data object types.
Number of arguments MUST match num_in+num_out

Definition at line 327 of file node.py.

◆ setTarget()

def tiovx.node.Node.setTarget (   self,
  target 
)
inherited

Specify target on which to run this node.

Parameters
target[in] Object of type tiovx.enums.Target

Definition at line 339 of file node.py.

◆ setKernelEnumName()

def tiovx.node.Node.setKernelEnumName (   self,
  kernel_enum_name 
)
inherited

Specify kernel enum name to use.

Use "VX_USER_KERNEL" as 'kernel_enum_name' for custom/user kernels

Parameters
kernel_enum_name[in] Type string.

Definition at line 354 of file node.py.


The documentation for this class was generated from the following file: