Scanner C++ API
Public Member Functions | Protected Member Functions | List of all members
scanner::Kernel Class Referenceabstract
Inheritance diagram for scanner::Kernel:
scanner::BaseKernel scanner::SampleKernel

Public Member Functions

 Kernel (const KernelConfig &config)
 
virtual void execute_kernel (const StenciledBatchedElements &input_columns, BatchedElements &output_columns)
 For internal use.
 
- Public Member Functions inherited from scanner::BaseKernel
 BaseKernel (const KernelConfig &config)
 
virtual void validate (proto::Result *result)
 Checks if kernel arguments are valid. More...
 
virtual void fetch_resources (proto::Result *result)
 Downloads any resources necessary for the kernel to run. More...
 
virtual void setup_with_resources (proto::Result *result)
 Runs any setup code that relies on fetched resources. More...
 
virtual void new_stream (const std::vector< u8 > &args)
 Called when the Kernel is about to process a new stream. More...
 
virtual void reset ()
 Requests that kernel resets its logical state. More...
 
virtual void set_profiler (Profiler *profiler)
 For internal use.
 

Protected Member Functions

virtual void execute (const Elements &input_columns, Elements &output_columns)=0
 Runs the op on input elements and produces equal number of output elements. More...
 

Additional Inherited Members

- Public Attributes inherited from scanner::BaseKernel
Profilerprofiler_ = nullptr
 
- Static Public Attributes inherited from scanner::BaseKernel
static const i32 UnlimitedDevices = 0
 

Member Function Documentation

virtual void scanner::Kernel::execute ( const Elements &  input_columns,
Elements &  output_columns 
)
protectedpure virtual

Runs the op on input elements and produces equal number of output elements.

Parameters
input_columnsvector of elements, where each element is from a different column
output_columnsop output, vector of elements, where each element is from a different column

Evaluate gets run on batches of inputs. At the beginning of a pipeline this is raw RGB images from the input images/videos, and after that the input becomes whatever was returned by the previous op.

Number of output columns must be non-zero.


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