JeVois
1.22
JeVois Smart Embedded Machine Vision Toolkit
|
|
#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 366 of file PythonModule.H.
Public Member Functions | |
PythonModule (VideoMapping const &m) | |
Constructor needs the full path to a Python source code file. | |
void | preInit () override |
Load python code and optionally call init() python module function, if implemented. | |
virtual | ~PythonModule () |
Virtual destructor for safe inheritance. | |
virtual void | process (InputFrame &&inframe, OutputFrame &&outframe) override |
Processing function, version that receives a frame from camera and sends a frame out over USB. | |
virtual void | process (InputFrame &&inframe) override |
Processing function, version that receives a frame from camera and does not use USB. | |
virtual void | process (InputFrame &&inframe, GUIhelper &helper) |
Processing function, version that receives a frame from camera, no USB, but GUI output on JeVois-Pro. | |
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. | |
virtual void | supportedCommands (std::ostream &os) override |
Human-readable description of this Module's supported custom commands. | |
void | postUninit () override |
Optionally call uninit() python module function, if implemented. | |
Public Member Functions inherited from jevois::Module | |
Module (std::string const &instance) | |
Constructor. | |
virtual | ~Module () |
Virtual destructor for safe inheritance. | |
virtual void | sendSerial (std::string const &str) |
Send a string over the 'serout' serial port. | |
Public Member Functions inherited from jevois::Component | |
Component (std::string const &instance) | |
Constructor. | |
virtual | ~Component () |
Virtual destructor for safe inheritance. | |
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. | |
template<class Comp > | |
void | removeSubComponent (std::shared_ptr< Comp > &component) |
Remove a sub-Component from this Component, by shared_ptr. | |
void | removeSubComponent (std::string const &instance, bool warnIfNotFound=true) |
Remove a sub-Component from this Component, by instance name. | |
template<class Comp = jevois::Component> | |
std::shared_ptr< Comp > | getSubComponent (std::string const &instance) const |
Get a sub-component by instance name. | |
bool | isTopLevel () const |
Returns true if this component is top-level, i.e., its parent is jevois::Manager. | |
bool | initialized () const |
Has this component been initialized yet? | |
std::string const & | className () const |
The class name of this component. | |
std::string const & | instanceName () const |
The instance name of this component. | |
template<typename T > | |
std::vector< std::string > | setParamVal (std::string const ¶mdescriptor, T const &val) |
Set a parameter value. | |
template<typename T > | |
void | setParamValUnique (std::string const ¶mdescriptor, T const &val) |
Set a parameter value, simple version assuming only one parameter match. | |
template<typename T > | |
std::vector< std::pair< std::string, T > > | getParamVal (std::string const ¶mdescriptor) const |
Get parameter(s) value(s) by descriptor. | |
template<typename T > | |
T | getParamValUnique (std::string const ¶mdescriptor) const |
Get a parameter value, simple version assuming only one parameter match. | |
std::vector< std::string > | setParamString (std::string const ¶mdescriptor, std::string const &val) |
Set a parameter value, by string. | |
void | setParamStringUnique (std::string const ¶mdescriptor, std::string const &val) |
Set a parameter value by string, simple version assuming only one parameter match. | |
std::vector< std::pair< std::string, std::string > > | getParamString (std::string const ¶mdescriptor) const |
Get a parameter value, by string. | |
std::string | getParamStringUnique (std::string const ¶mdescriptor) const |
Get a parameter value by string, simple version assuming only one parameter match. | |
void | freezeParam (std::string const ¶mdescriptor, bool doit) |
Freeze/unfreeze a parameter, by name, see ParameterBase::freeze() | |
void | freezeAllParams (bool doit) |
Freeze all parameters. | |
std::string | descriptor () const |
Get our full descriptor (including all parents) as [Instancename]:[...]:[...]. | |
void | setParamsFromFile (std::string const &filename) |
Set some parameters from a file. | |
std::istream & | setParamsFromStream (std::istream &is, std::string const &absfile) |
Set some parameters from an open stream. | |
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. | |
void | foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="") |
Run a function on every param we hold. | |
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. | |
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. | |
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. | |
void | removeDynamicParameter (std::string const &name, bool throw_if_not_found=true) |
Remove a previously added dynamic parameter. | |
void | setPath (std::string const &path) |
Assign a filesystem path to this component. | |
std::filesystem::path | absolutePath (std::filesystem::path const &path="") |
If given path is relative (not starting with /), prepend the Component path to it. | |
Public Member Functions inherited from jevois::ParameterRegistry | |
virtual | ~ParameterRegistry () |
Virtual destructor for safe inheritance. | |
Public Member Functions inherited from jevois::PythonWrapper | |
PythonWrapper () | |
Default constructor. Will need to call pythonload() later. | |
virtual | ~PythonWrapper () |
Destructor. | |
PythonWrapper (std::string const &path) | |
Construct from path. | |
void | pythonload (std::string const &path) |
Init from path if default constructor was used. | |
boost::python::object & | pyinst () |
Get the python class pyinst, or throw if construction error occurred (e.g., file not found) | |
boost::python::object & | mainModule () |
Get the main module. | |
boost::python::object & | mainNamespace () |
Get the main namespace. | |
std::string const & | constructionError () const |
Get the construction error if any, or empty string. | |
Additional Inherited Members | |
Protected Member Functions inherited from jevois::Component | |
virtual void | postInit () |
Called after all sub-Components are init()ed. | |
virtual void | preUninit () |
Called before all sub-Components are uninit()ed. | |
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. | |
void | removeParameter (ParameterBase *const param) |
The Parameter class uses this method to un-register itself on destruction with its owning Component. | |
void | callbackInitCall () |
For all parameters that have a callback which has never been called, call it with the default param value. | |
jevois::PythonModule::PythonModule | ( | jevois::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 510 of file PythonModule.C.
References jevois::VideoMapping::ispython, and LFATAL.
|
virtual |
Virtual destructor for safe inheritance.
Definition at line 534 of file PythonModule.C.
References jevois::Engine::unRegisterPythonComponent().
|
overridevirtual |
Receive a string from a serial port which contains a user command.
Reimplemented from jevois::Module.
Definition at line 567 of file PythonModule.C.
References jevois::python::hasattr(), jevois::Module::parseSerial(), and jevois::PythonWrapper::pyinst().
|
overridevirtual |
Optionally call uninit() python module function, if implemented.
Reimplemented from jevois::Component.
Definition at line 527 of file PythonModule.C.
References jevois::python::hasattr(), and jevois::PythonWrapper::pyinst().
|
overridevirtual |
Load python code and optionally call init() python module function, if implemented.
Reimplemented from jevois::Component.
Definition at line 517 of file PythonModule.C.
References jevois::python::hasattr(), jevois::PythonWrapper::pyinst(), and jevois::PythonWrapper::pythonload().
|
overridevirtual |
Processing function, version that receives a frame from camera and does not use USB.
Reimplemented from jevois::Module.
Definition at line 548 of file PythonModule.C.
References jevois::PythonWrapper::pyinst().
|
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 557 of file PythonModule.C.
References jevois::PythonWrapper::pyinst().
|
overridevirtual |
Processing function, version that receives a frame from camera and sends a frame out over USB.
Reimplemented from jevois::Module.
Definition at line 540 of file PythonModule.C.
References jevois::PythonWrapper::pyinst().
|
overridevirtual |
Human-readable description of this Module's supported custom commands.
Reimplemented from jevois::Module.
Definition at line 579 of file PythonModule.C.
References jevois::python::hasattr(), jevois::PythonWrapper::pyinst(), and jevois::Module::supportedCommands().