#include <jevois/Core/PythonModule.H>

Wrapper module to allow users to develop new modules written in Python.

This wrapper module calls a process function written in Python on every frame. Note how sendSerial() is added dynamically after the python class is defined, as a new member function of the class.

Definition at line 359 of file PythonModule.H.

Inheritance diagram for jevois::PythonModule:

[legend]

Collaboration diagram for jevois::PythonModule:

[legend]

Public Member Functions
	PythonModule (VideoMapping const &m)
	Constructor needs the full path to a Python source code file. More...

void	preInit () override
	Load python code and optionally call init() python module function, if implemented. More...

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

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

virtual void	process (InputFrame &&inframe) override
	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	parseSerial (std::string const &str, std::shared_ptr< UserInterface > s) override
	Receive a string from a serial port which contains a user command. More...

virtual void	supportedCommands (std::ostream &os) override
	Human-readable description of this Module's supported custom commands. More...

void	postUninit () override
	Optionally call uninit() python module function, if implemented. 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	sendSerial (std::string const &str)
	Send a string over the 'serout' serial port. 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...

Public Member Functions inherited from jevois::PythonWrapper
	PythonWrapper ()
	Default constructor. Will need to call pythonload() later. More...

virtual	~PythonWrapper ()
	Destructor. More...

	PythonWrapper (std::string const &path)
	Construct from path. More...

void	pythonload (std::string const &path)
	Init from path if default constructor was used. More...

boost::python::object &	pyinst ()
	Get the python class pyinst, or throw if construction error occurred (e.g., file not found) More...

boost::python::object &	mainModule ()
	Get the main module. More...

boost::python::object &	mainNamespace ()
	Get the main namespace. More...

const std::string &	constructionError () const
	Get the construction error if any, or empty string. More...

Additional Inherited Members
Protected Member Functions inherited from jevois::Component
virtual void	postInit ()
	Called after all sub-Components are init()ed. More...

virtual void	preUninit ()
	Called before 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

◆ PythonModule()

jevois::PythonModule::PythonModule ( VideoMapping const & m )

Constructor needs the full path to a Python source code file.

Note that, contrary to C++ modules, construction will not throw. This is so that the module is always valid and initialized, and its module path can be set by Engine, which is necessary to allow saving the source code from JeVois Inventor. Instead, any construction error is stored internally in this class and will be re-thrown at any access to process(), parfseSerial(), etc.

Definition at line 588 of file PythonModule.C.

References LFATAL.

◆ ~PythonModule()

jevois::PythonModule::~PythonModule ( )

virtual

Virtual destructor for safe inheritance.

Definition at line 611 of file PythonModule.C.

Member Function Documentation

◆ parseSerial()

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

overridevirtual

Receive a string from a serial port which contains a user command.

Reimplemented from jevois::Module.

Definition at line 642 of file PythonModule.C.

References jevois::python::hasattr(), jevois::Module::parseSerial(), jevois::PythonWrapper::pyinst(), and jevois::UserInterface::writeString().

◆ postUninit()

void jevois::PythonModule::postUninit ( )

overridevirtual

Optionally call uninit() python module function, if implemented.

Reimplemented from jevois::Component.

Definition at line 604 of file PythonModule.C.

References jevois::python::hasattr(), and jevois::PythonWrapper::pyinst().

◆ preInit()

void jevois::PythonModule::preInit ( )

overridevirtual

Load python code and optionally call init() python module function, if implemented.

Reimplemented from jevois::Component.

Definition at line 594 of file PythonModule.C.

References jevois::python::hasattr(), jevois::PythonWrapper::pyinst(), and jevois::PythonWrapper::pythonload().

◆ process() [1/3]

void jevois::PythonModule::process ( InputFrame && inframe )

overridevirtual

Processing function, version that receives a frame from camera and does not use USB.

Reimplemented from jevois::Module.

Definition at line 623 of file PythonModule.C.

References jevois::PythonWrapper::pyinst().

◆ process() [2/3]

void jevois::PythonModule::process	(	InputFrame &&	inframe,
		GUIhelper &	helper
	)

virtual

Processing function, version that receives a frame from camera, no USB, but GUI output on JeVois-Pro.

Reimplemented from jevois::Module.

Definition at line 632 of file PythonModule.C.

References jevois::PythonWrapper::pyinst().

◆ process() [3/3]

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

overridevirtual

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

Reimplemented from jevois::Module.

Definition at line 615 of file PythonModule.C.

References jevois::PythonWrapper::pyinst().

◆ supportedCommands()

void jevois::PythonModule::supportedCommands ( std::ostream & os )

overridevirtual

Human-readable description of this Module's supported custom commands.

Reimplemented from jevois::Module.

Definition at line 654 of file PythonModule.C.

References jevois::python::hasattr(), jevois::PythonWrapper::pyinst(), and jevois::Module::supportedCommands().

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

include/jevois/Core/PythonModule.H
src/jevois/Core/PythonModule.C

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ PythonModule()

◆ ~PythonModule()

Member Function Documentation

◆ parseSerial()

◆ postUninit()

◆ preInit()

◆ process() [1/3]

◆ process() [2/3]

◆ process() [3/3]

◆ supportedCommands()