Definition at line 7 of file tutorial2.C.

Inheritance diagram for TutorialConvert:

[legend]

Collaboration diagram for TutorialConvert:

[legend]

Public Member Functions
virtual	~TutorialConvert ()

virtual void	process (jevois::InputFrame &&inframe, jevois::OutputFrame &&outframe) override
	Processing function, version that receives a frame from camera and sends a frame out over USB. More...

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

virtual	~Module ()
	Virtual destructor for safe inheritance. More...

virtual void	process (InputFrame &&inframe)
	Processing function, version that receives a frame from camera and does not use USB. More...

virtual void	process (InputFrame &&inframe, GUIhelper &helper)
	Processing function, version that receives a frame from camera, no USB, but GUI output on JeVois-Pro. More...

virtual void	sendSerial (std::string const &str)
	Send a string over the 'serout' serial port. More...

virtual void	parseSerial (std::string const &str, std::shared_ptr< UserInterface > s)
	Receive a string from a serial port which contains a user command. More...

virtual void	supportedCommands (std::ostream &os)
	Human-readable description of this Module's supported custom commands. 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...

Engine *	engine () 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 >
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...

Additional Inherited Members
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

◆ ~TutorialConvert()

virtual TutorialConvert::~TutorialConvert ( )

inlinevirtual

Definition at line 14 of file tutorial2.C.

Member Function Documentation

◆ process()

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

inlineoverridevirtual

Processing function, version that receives a frame from camera and sends a frame out over USB.

This function is called once for each grabbed video frame from the camera, and it should complete within the camera's frame period in order to avoid dropping frames. The InputFrame and OutputFrame objects are simple wrappers to ensure that the low-level video buffers will always be returned to the low-level camera and USB drivers even if the process function throws at any point during the processing. If any error occurs, it is hence ok to throw from within process() at any time, just make sure your locally allocated resources will be freed, which is usually best achieved by using shared_ptr and similar wrappers around them. The Engine (which calls process() on your module for every frame) will catch any exception an proceed to the next frame.

Default implementation in the base class just throws. Derived classes should override it.

Reimplemented from jevois::Module.

Definition at line 17 of file tutorial2.C.

References jevois::rawimage::convertCvBGRtoRawImage(), jevois::rawimage::convertToCvBGR(), jevois::RawImage::fmt, jevois::RawImage::height, jevois::RawImage::require(), and jevois::RawImage::width.

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

doc/snip/tutorial2.C

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~TutorialConvert()

Member Function Documentation

◆ process()