JeVois  1.20
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
jevois::dnn::NetworkHailo Class Reference

#include <jevois/DNN/NetworkHailo.H>

Wrapper around an DNN neural network running on the Hailo8 neural accelerator.

Note that this network type does not support setting intensors or outtensors externally, these are fixed in the HEF file.

Definition at line 34 of file NetworkHailo.H.

Inheritance diagram for jevois::dnn::NetworkHailo:
Collaboration diagram for jevois::dnn::NetworkHailo:

Public Member Functions

 NetworkHailo (std::string const &instance)
 Constructor. More...
 
virtual ~NetworkHailo ()
 Destructor. More...
 
void freeze (bool doit) override
 Freeze/unfreeze parameters that users should not change while running. More...
 
virtual std::vector< vsi_nn_tensor_attr_t > inputShapes () override
 Get shapes of all input tensors. More...
 
virtual std::vector< vsi_nn_tensor_attr_t > outputShapes () override
 Get shapes of all output tensors. More...
 
- Public Member Functions inherited from jevois::dnn::Network
virtual ~Network ()
 Destructor. More...
 
void waitBeforeDestroy ()
 If network is currently loading, wait until that is done before destroying. More...
 
bool ready ()
 Returns true when network is ready to run (loaded and initialized) More...
 
std::vector< cv::Mat > process (std::vector< cv::Mat > const &blobs, std::vector< std::string > &info)
 Process input blobs and obtain output blobs. More...
 
- Public Member Functions inherited from jevois::Component
 Component (std::string const &instance)
 Constructor. More...
 
virtual ~Component ()
 Virtual destructor for safe inheritance. More...
 
template<class Comp , typename... Args>
std::shared_ptr< Comp > addSubComponent (std::string const &instance, Args &&...args)
 Pseudo-constructor: construct and add another component as a subcomponent of this one. More...
 
template<class Comp >
void removeSubComponent (std::shared_ptr< Comp > &component)
 Remove a sub-Component from this Component, by shared_ptr. More...
 
void removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
 Remove a sub-Component from this Component, by instance name. More...
 
template<class Comp = jevois::Component>
std::shared_ptr< Comp > getSubComponent (std::string const &instance) const
 Get a sub-component by instance name. More...
 
bool isTopLevel () const
 Returns true if this component is top-level, i.e., its parent is jevois::Manager. More...
 
Engineengine () const
 Get a handle to our Engine, or throw if we do not have an Engine as root ancestor. More...
 
bool initialized () const
 Has this component been initialized yet? More...
 
const std::string & className () const
 The class name of this component. More...
 
const std::string & instanceName () const
 The instance name of this component. More...
 
template<typename T >
std::vector< std::string > setParamVal (std::string const &paramdescriptor, T const &val)
 Set a parameter value. More...
 
template<typename T >
void setParamValUnique (std::string const &paramdescriptor, T const &val)
 Set a parameter value, simple version assuming only one parameter match. More...
 
template<typename T >
std::vector< std::pair< std::string, T > > getParamVal (std::string const &paramdescriptor) const
 Get parameter(s) value(s) by descriptor. More...
 
template<typename T >
getParamValUnique (std::string const &paramdescriptor) const
 Get a parameter value, simple version assuming only one parameter match. More...
 
std::vector< std::string > setParamString (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value, by string. More...
 
void setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value by string, simple version assuming only one parameter match. More...
 
std::vector< std::pair< std::string, std::string > > getParamString (std::string const &paramdescriptor) const
 Get a parameter value, by string. More...
 
std::string getParamStringUnique (std::string const &paramdescriptor) const
 Get a parameter value by string, simple version assuming only one parameter match. More...
 
void freezeParam (std::string const &paramdescriptor)
 Freeze a parameter, by name, see ParameterBase::freeze() More...
 
void unFreezeParam (std::string const &paramdescriptor)
 Unfreeze a parameter, by name, see ParameterBase::unFreeze() More...
 
void freezeAllParams ()
 Freeze all parameters. More...
 
void unFreezeAllParams ()
 Unfreeze all parameters. More...
 
std::string descriptor () const
 Get our full descriptor (including all parents) as [Instancename]:[...]:[...]. More...
 
void setParamsFromFile (std::string const &filename)
 Set some parameters from a file. More...
 
std::istream & setParamsFromStream (std::istream &is, std::string const &absfile)
 Set some parameters from an open stream. More...
 
virtual void paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
 Get machine-oriented descriptions of all parameters. More...
 
void foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
 Run a function on every param we hold. More...
 
template<typename T >
std::shared_ptr< DynamicParameter< T > > addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
 Add a new parameter after the Component has already been constructed. More...
 
template<typename T , template< typename > class ValidValuesSpec>
std::shared_ptr< DynamicParameter< T > > addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
 Add a new parameter after the Component has already been constructed. More...
 
template<typename T >
void setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
 Register a callback with a previously created dynamic parameter. More...
 
void removeDynamicParameter (std::string const &name)
 Remove a previously added dynamic parameter. More...
 
void setPath (std::string const &path)
 Assign a filesystem path to this component. More...
 
std::filesystem::path absolutePath (std::filesystem::path const &path="")
 If given path is relative (not starting with /), prepend the Component path to it. More...
 
- Public Member Functions inherited from jevois::ParameterRegistry
virtual ~ParameterRegistry ()
 Virtual destructor for safe inheritance. More...
 

Protected Member Functions

void load () override
 Load from disk. More...
 
std::vector< cv::Mat > doprocess (std::vector< cv::Mat > const &blobs, std::vector< std::string > &info) override
 Process input blobs and obtain output blobs. More...
 
void onParamChange (network::turbo const &par, bool const &newval) override
 
- Protected Member Functions inherited from jevois::dnn::Network
void onParamChange (network::outreshape const &param, std::string const &val) override
 
- Protected Member Functions inherited from jevois::Component
virtual void preInit ()
 Called before all sub-Components are init()ed. More...
 
virtual void postInit ()
 Called after all sub-Components are init()ed. More...
 
virtual void preUninit ()
 Called before all sub-Components are uninit()ed. More...
 
virtual void postUninit ()
 Called after all sub-Components are uninit()ed. More...
 
- Protected Member Functions inherited from jevois::ParameterRegistry
void addParameter (ParameterBase *const param)
 The Parameter class uses this method to register itself on construction with its owning Component. More...
 
void removeParameter (ParameterBase *const param)
 The Parameter class uses this method to un-register itself on destruction with its owning Component. More...
 
void callbackInitCall ()
 For all parameters that have a callback which has never been called, call it with the default param value. More...
 

Constructor & Destructor Documentation

◆ NetworkHailo()

jevois::dnn::NetworkHailo::NetworkHailo ( std::string const &  instance)

Constructor.

Definition at line 35 of file NetworkHailo.C.

◆ ~NetworkHailo()

jevois::dnn::NetworkHailo::~NetworkHailo ( )
virtual

Destructor.

Definition at line 64 of file NetworkHailo.C.

Member Function Documentation

◆ doprocess()

std::vector< cv::Mat > jevois::dnn::NetworkHailo::doprocess ( std::vector< cv::Mat > const &  blobs,
std::vector< std::string > &  info 
)
overrideprotectedvirtual

◆ freeze()

void jevois::dnn::NetworkHailo::freeze ( bool  doit)
overridevirtual

Freeze/unfreeze parameters that users should not change while running.

Reimplemented from jevois::dnn::Network.

Definition at line 72 of file NetworkHailo.C.

References jevois::dnn::Network::freeze().

◆ inputShapes()

std::vector< vsi_nn_tensor_attr_t > jevois::dnn::NetworkHailo::inputShapes ( )
overridevirtual

Get shapes of all input tensors.

Implements jevois::dnn::Network.

Definition at line 56 of file NetworkHailo.C.

◆ load()

void jevois::dnn::NetworkHailo::load ( )
overrideprotectedvirtual

◆ onParamChange()

void jevois::dnn::NetworkHailo::onParamChange ( network::turbo const &  par,
bool const &  newval 
)
overrideprotected

Definition at line 162 of file NetworkHailo.C.

◆ outputShapes()

std::vector< vsi_nn_tensor_attr_t > jevois::dnn::NetworkHailo::outputShapes ( )
overridevirtual

Get shapes of all output tensors.

Implements jevois::dnn::Network.

Definition at line 60 of file NetworkHailo.C.


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