JeVois  1.17
JeVois Smart Embedded Machine Vision Toolkit
Share this page:

#include <jevois/Core/PythonModule.H>

Wrapper around OutputFrame to be used by Python.

This wrapper is to work around the lack of move semantics in our Python support. This class is not intended for general use, but only for use by PythonModule. Users of this class must ensure that the original OutputFrame will outlive any and all OutputFramePython instances, since OutputFramePython just references to the source OutputFrame by unprotected raw pointer. Although the C++ object is called OutputFramePython, we will expose it to python under the name OutputFrame (see PythonSupport.C).

Definition at line 129 of file PythonModule.H.

Public Member Functions

 OutputFramePython ()=default
 Default constructor to keep boost::python happy, object is not operational. More...
 
 OutputFramePython (OutputFrame *src)
 Construct from a regular (move-only) OutputFrame that should be be coming from Engine. More...
 
const RawImageget () const
 Get the next captured camera image. More...
 
void send () const
 Indicate that user processing is done with the image previously obtained via get() More...
 
void sendCv1 (cv::Mat const &img, int quality) const
 Shorthand to send a cv::Mat after scaling/converting it to the current output format. More...
 
void sendCv (cv::Mat const &img) const
 Shorthand to send a cv::Mat after scaling/converting it to the current output format. More...
 
void sendCvGRAY1 (cv::Mat const &img, int quality) const
 Shorthand to send a GRAY cv::Mat after converting it to the current output format. More...
 
void sendCvGRAY (cv::Mat const &img) const
 Shorthand to send a GRAY cv::Mat after converting it to the current output format. More...
 
void sendCvBGR1 (cv::Mat const &img, int quality) const
 Shorthand to send a BGR cv::Mat after converting it to the current output format. More...
 
void sendCvBGR (cv::Mat const &img) const
 Shorthand to send a BGR cv::Mat after converting it to the current output format. More...
 
void sendCvRGB1 (cv::Mat const &img, int quality) const
 Shorthand to send a RGB cv::Mat after converting it to the current output format. More...
 
void sendCvRGB (cv::Mat const &img) const
 Shorthand to send a RGB cv::Mat after converting it to the current output format. More...
 
void sendCvRGBA1 (cv::Mat const &img, int quality) const
 Shorthand to send a RGBA cv::Mat after converting it to the current output format. More...
 
void sendCvRGBA (cv::Mat const &img) const
 Shorthand to send a RGBA cv::Mat after converting it to the current output format. More...
 
void sendScaledCvGRAY1 (cv::Mat const &img, int quality) const
 Shorthand to send a GRAY cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvGRAY (cv::Mat const &img) const
 Shorthand to send a GRAY cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvBGR1 (cv::Mat const &img, int quality) const
 Shorthand to send a BGR cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvBGR (cv::Mat const &img) const
 Shorthand to send a BGR cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvRGB1 (cv::Mat const &img, int quality) const
 Shorthand to send a RGB cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvRGB (cv::Mat const &img) const
 Shorthand to send a RGB cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvRGBA1 (cv::Mat const &img, int quality) const
 Shorthand to send a RGBA cv::Mat after scaling/converting it to the current output format. More...
 
void sendScaledCvRGBA (cv::Mat const &img) const
 Shorthand to send a RGBA cv::Mat after scaling/converting it to the current output format. More...
 

Constructor & Destructor Documentation

◆ OutputFramePython() [1/2]

jevois::OutputFramePython::OutputFramePython ( )
default

Default constructor to keep boost::python happy, object is not operational.

◆ OutputFramePython() [2/2]

jevois::OutputFramePython::OutputFramePython ( OutputFrame src)

Construct from a regular (move-only) OutputFrame that should be be coming from Engine.

Definition at line 158 of file PythonModule.C.

Member Function Documentation

◆ get()

const jevois::RawImage & jevois::OutputFramePython::get ( ) const

Get the next captured camera image.

Definition at line 161 of file PythonModule.C.

References LFATAL.

◆ send()

void jevois::OutputFramePython::send ( ) const

Indicate that user processing is done with the image previously obtained via get()

Definition at line 167 of file PythonModule.C.

References LFATAL.

◆ sendCv()

void jevois::OutputFramePython::sendCv ( cv::Mat const &  img) const

Shorthand to send a cv::Mat after scaling/converting it to the current output format.

Definition at line 179 of file PythonModule.C.

References LFATAL.

◆ sendCv1()

void jevois::OutputFramePython::sendCv1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a cv::Mat after scaling/converting it to the current output format.

Definition at line 173 of file PythonModule.C.

References LFATAL.

◆ sendCvBGR()

void jevois::OutputFramePython::sendCvBGR ( cv::Mat const &  img) const

Shorthand to send a BGR cv::Mat after converting it to the current output format.

Definition at line 203 of file PythonModule.C.

References LFATAL.

◆ sendCvBGR1()

void jevois::OutputFramePython::sendCvBGR1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a BGR cv::Mat after converting it to the current output format.

Definition at line 197 of file PythonModule.C.

References LFATAL.

◆ sendCvGRAY()

void jevois::OutputFramePython::sendCvGRAY ( cv::Mat const &  img) const

Shorthand to send a GRAY cv::Mat after converting it to the current output format.

Definition at line 191 of file PythonModule.C.

References LFATAL.

◆ sendCvGRAY1()

void jevois::OutputFramePython::sendCvGRAY1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a GRAY cv::Mat after converting it to the current output format.

Definition at line 185 of file PythonModule.C.

References LFATAL.

◆ sendCvRGB()

void jevois::OutputFramePython::sendCvRGB ( cv::Mat const &  img) const

Shorthand to send a RGB cv::Mat after converting it to the current output format.

Definition at line 215 of file PythonModule.C.

References LFATAL.

◆ sendCvRGB1()

void jevois::OutputFramePython::sendCvRGB1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a RGB cv::Mat after converting it to the current output format.

Definition at line 209 of file PythonModule.C.

References LFATAL.

◆ sendCvRGBA()

void jevois::OutputFramePython::sendCvRGBA ( cv::Mat const &  img) const

Shorthand to send a RGBA cv::Mat after converting it to the current output format.

Definition at line 227 of file PythonModule.C.

References LFATAL.

◆ sendCvRGBA1()

void jevois::OutputFramePython::sendCvRGBA1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a RGBA cv::Mat after converting it to the current output format.

Definition at line 221 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvBGR()

void jevois::OutputFramePython::sendScaledCvBGR ( cv::Mat const &  img) const

Shorthand to send a BGR cv::Mat after scaling/converting it to the current output format.

Definition at line 251 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvBGR1()

void jevois::OutputFramePython::sendScaledCvBGR1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a BGR cv::Mat after scaling/converting it to the current output format.

Definition at line 245 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvGRAY()

void jevois::OutputFramePython::sendScaledCvGRAY ( cv::Mat const &  img) const

Shorthand to send a GRAY cv::Mat after scaling/converting it to the current output format.

Definition at line 239 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvGRAY1()

void jevois::OutputFramePython::sendScaledCvGRAY1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a GRAY cv::Mat after scaling/converting it to the current output format.

Definition at line 233 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvRGB()

void jevois::OutputFramePython::sendScaledCvRGB ( cv::Mat const &  img) const

Shorthand to send a RGB cv::Mat after scaling/converting it to the current output format.

Definition at line 263 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvRGB1()

void jevois::OutputFramePython::sendScaledCvRGB1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a RGB cv::Mat after scaling/converting it to the current output format.

Definition at line 257 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvRGBA()

void jevois::OutputFramePython::sendScaledCvRGBA ( cv::Mat const &  img) const

Shorthand to send a RGBA cv::Mat after scaling/converting it to the current output format.

Definition at line 275 of file PythonModule.C.

References LFATAL.

◆ sendScaledCvRGBA1()

void jevois::OutputFramePython::sendScaledCvRGBA1 ( cv::Mat const &  img,
int  quality 
) const

Shorthand to send a RGBA cv::Mat after scaling/converting it to the current output format.

Definition at line 269 of file PythonModule.C.

References LFATAL.


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