JeVois sample module.

This module is provided as an example of how to create a new standalone module.

JeVois provides helper scripts and files to assist you in programming new modules, following two basic formats:

if you wish to only create a single module that will execute a specific function, or a collection of such modules where there is no shared code between the modules (i.e., each module does things that do not relate to the other modules), use the skeleton provided by this sample module. Here, all the code for the sample module is compiled into a single shared object (.so) file that is loaded by the JeVois engine when the corresponding video output format is selected by the host computer.
if you are planning to write a collection of modules with some shared algorithms among several of the modules, it is better to first create machine vision Components that implement the algorithms that are shared among several of your modules. You would then compile all your components into a first shared library (.so) file, and then compile each module into its own shared object (.so) file that depends on and automatically loads your shared library file when it is selected by the host computer. The jevoisbase library and collection of components and modules is an example for how to achieve that, where libjevoisbase.so contains code for Saliency, ObjectRecognition, etc components that are used in several modules, and each module's .so file contains only the code specific to that module.

Author: Sample Author

@videomapping YUYV 640 480 28.5 YUYV 640 480 28.5 SampleVendor HelloJeVois @email sampleemail@samplecompany.com @address 123 First Street, Los Angeles, CA 90012

Copyright: Copyright (C) 2017 by Sample Author @mainurl http://samplecompany.com @supporturl http://samplecompany.com/support @otherurl http://samplecompany.com/about @license GPL v3 @distribution Unrestricted @restrictions None

Definition at line 38 of file HelloJeVois.C.

Inheritance diagram for HelloJeVois:

[legend]

Collaboration diagram for HelloJeVois:

[legend]

Public Member Functions
virtual	~HelloJeVois ()
	Virtual destructor for safe inheritance.

virtual void	process (jevois::InputFrame &&inframe, jevois::OutputFrame &&outframe) override
	Processing function.

Public Member Functions inherited from jevois::Module
	Module (std::string const &instance)

virtual	~Module ()

virtual void	process (InputFrame &&inframe)

virtual void	process (InputFrame &&inframe, GUIhelper &helper)

virtual void	sendSerial (std::string const &str)

virtual void	parseSerial (std::string const &str, std::shared_ptr< UserInterface > s)

virtual void	supportedCommands (std::ostream &os)

Public Member Functions inherited from jevois::Component
	Component (std::string const &instance)

virtual	~Component ()

std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)

void	removeSubComponent (std::shared_ptr< Comp > &component)

void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)

std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const

bool	isTopLevel () const

bool	initialized () const

std::string const &	className () const

std::string const &	instanceName () const

std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)

void	setParamValUnique (std::string const &paramdescriptor, T const &val)

std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const

T	getParamValUnique (std::string const &paramdescriptor) const

std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)

void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)

std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const

std::string	getParamStringUnique (std::string const &paramdescriptor) const

void	freezeParam (std::string const &paramdescriptor, bool doit)

void	freezeAllParams (bool doit)

void	hideParam (std::string const &paramdescriptor, bool doit)

void	hideAllParams (bool doit)

std::string	descriptor () const

void	setParamsFromFile (std::string const &filename)

std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)

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="")

void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")

std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)

std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)

void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)

void	removeDynamicParameter (std::string const &name, bool throw_if_not_found=true)

void	setPath (std::string const &path)

std::filesystem::path	absolutePath (std::filesystem::path const &path="")

std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)

void	removeSubComponent (std::shared_ptr< Comp > &component)

void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)

std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const

bool	isTopLevel () const

bool	initialized () const

std::string const &	className () const

std::string const &	instanceName () const

std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)

void	setParamValUnique (std::string const &paramdescriptor, T const &val)

std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const

T	getParamValUnique (std::string const &paramdescriptor) const

std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)

void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)

std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const

std::string	getParamStringUnique (std::string const &paramdescriptor) const

void	freezeParam (std::string const &paramdescriptor, bool doit)

void	freezeAllParams (bool doit)

void	hideParam (std::string const &paramdescriptor, bool doit)

void	hideAllParams (bool doit)

std::string	descriptor () const

void	setParamsFromFile (std::string const &filename)

std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)

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="")

void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")

std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)

std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)

void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)

void	removeDynamicParameter (std::string const &name, bool throw_if_not_found=true)

void	setPath (std::string const &path)

std::filesystem::path	absolutePath (std::filesystem::path const &path="")

Public Member Functions inherited from jevois::ParameterRegistry
virtual	~ParameterRegistry ()

Additional Inherited Members
Protected Member Functions inherited from jevois::Component
virtual void	preInit ()

virtual void	postInit ()

virtual void	preUninit ()

virtual void	postUninit ()

virtual void	preInit ()

virtual void	postInit ()

virtual void	preUninit ()

virtual void	postUninit ()

Protected Member Functions inherited from jevois::ParameterRegistry
void	addParameter (ParameterBase *const param)

void	removeParameter (ParameterBase *const param)

void	callbackInitCall ()

Constructor & Destructor Documentation

◆ ~HelloJeVois()

virtual HelloJeVois::~HelloJeVois ( )

inlinevirtual

Virtual destructor for safe inheritance.

Definition at line 45 of file HelloJeVois.C.

Member Function Documentation

◆ process()

virtual void HelloJeVois::process	(	jevois::InputFrame &&	inframe,
		jevois::OutputFrame &&	outframe
	)

inlineoverridevirtual

Processing function.

Reimplemented from jevois::Module.

Definition at line 48 of file HelloJeVois.C.

References jevois::RawImage::buf, jevois::RawImage::fmt, jevois::rawimage::Font20x38, jevois::RawImage::height, jevois::RawImage::pixels(), jevois::RawImage::pixelsw(), jevois::RawImage::require(), jevois::yuyv::White, jevois::RawImage::width, and jevois::rawimage::writeText().

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

doc/snip/HelloJeVois.C

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~HelloJeVois()

Member Function Documentation

◆ process()