JeVois  1.21
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Friends
jevois::InputFramePython Class Reference
Core classes and definitions » Support for JeVois modules written in Python

#include <jevois/Core/PythonModule.H>

Wrapper around InputFrame 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 InputFrame will outlive any and all InputFramePython instances, since InputFramePython just references to the source InputFrame by unprotected raw pointer. Although the C++ object is called InputFramePython, we will expose it to python under the name InputFrame (see PythonSupport.C).

Definition at line 46 of file PythonModule.H.

Public Member Functions

 InputFramePython ()=default
 Default constructor to keep boost::python happy, object is not operational.
 
 InputFramePython (InputFrame *src)
 Construct from a regular (move-only) InputFrame that should be be coming from Engine.
 
RawImage const & get1 (bool casync) const
 Get the next captured camera image, thin wrapper for default arg value.
 
RawImage const & get () const
 Get the next captured camera image, thin wrapper for default arg value.
 
bool hasScaledImage () const
 Check whether a second input image scaled by the JeVoisPro Platform ISP is available.
 
void done () const
 Indicate that user processing is done with the image previously obtained via get()
 
void done2 () const
 Indicate that user processing is done with the ISP-scaled image previously obtained via get2()
 
RawImage const & get21 (bool casync) const
 Get the next captured camera image, ISP-scaled second frame.
 
RawImage const & get2 () const
 Get the next captured camera image, ISP-scaled second frame.
 
RawImage const & getp1 (bool casync) const
 Get the next captured camera image that is intended for processing.
 
RawImage const & getp () const
 Get the next captured camera image that is intended for processing.
 
cv::Mat getCvGRAY1 (bool casync) const
 Shorthand to get the input image as a GRAY cv::Mat and release the raw buffer.
 
cv::Mat getCvGRAY () const
 Shorthand to get the input image as a GRAY cv::Mat and release the raw buffer.
 
cv::Mat getCvBGR1 (bool casync) const
 Shorthand to get the input image as a BGR cv::Mat and release the raw buffer.
 
cv::Mat getCvBGR () const
 Shorthand to get the input image as a BGR cv::Mat and release the raw buffer.
 
cv::Mat getCvRGB1 (bool casync) const
 Shorthand to get the input image as a RGB cv::Mat and release the raw buffer.
 
cv::Mat getCvRGB () const
 Shorthand to get the input image as a RGB cv::Mat and release the raw buffer.
 
cv::Mat getCvRGBA1 (bool casync) const
 Shorthand to get the input image as a RGBA cv::Mat and release the raw buffer.
 
cv::Mat getCvRGBA () const
 Shorthand to get the input image as a RGBA cv::Mat and release the raw buffer.
 
cv::Mat getCvGRAYp () const
 Shorthand to get the input image for processing as a GRAY cv::Mat and release the raw buffer.
 
cv::Mat getCvBGRp () const
 Shorthand to get the input image for processing as a BGR cv::Mat and release the raw buffer.
 
cv::Mat getCvRGBp () const
 Shorthand to get the input image for processing as a RGB cv::Mat and release the raw buffer.
 
cv::Mat getCvRGBAp () const
 Shorthand to get the input image for processing as a RGBA cv::Mat and release the raw buffer.
 

Friends

class GUIhelperPython
 

Constructor & Destructor Documentation

◆ InputFramePython() [1/2]

jevois::InputFramePython::InputFramePython ( )
default

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

◆ InputFramePython() [2/2]

jevois::InputFramePython::InputFramePython ( InputFrame *  src)

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

Definition at line 31 of file PythonModule.C.

References LFATAL.

Member Function Documentation

◆ done()

void jevois::InputFramePython::done ( ) const

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

Definition at line 69 of file PythonModule.C.

◆ done2()

void jevois::InputFramePython::done2 ( ) const

Indicate that user processing is done with the ISP-scaled image previously obtained via get2()

Definition at line 74 of file PythonModule.C.

◆ get()

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

Get the next captured camera image, thin wrapper for default arg value.

Definition at line 39 of file PythonModule.C.

◆ get1()

jevois::RawImage const & jevois::InputFramePython::get1 ( bool  casync) const

Get the next captured camera image, thin wrapper for default arg value.

Definition at line 34 of file PythonModule.C.

◆ get2()

jevois::RawImage const & jevois::InputFramePython::get2 ( ) const

Get the next captured camera image, ISP-scaled second frame.

Definition at line 54 of file PythonModule.C.

◆ get21()

jevois::RawImage const & jevois::InputFramePython::get21 ( bool  casync) const

Get the next captured camera image, ISP-scaled second frame.

Definition at line 49 of file PythonModule.C.

◆ getCvBGR()

cv::Mat jevois::InputFramePython::getCvBGR ( ) const

Shorthand to get the input image as a BGR cv::Mat and release the raw buffer.

Definition at line 94 of file PythonModule.C.

◆ getCvBGR1()

cv::Mat jevois::InputFramePython::getCvBGR1 ( bool  casync) const

Shorthand to get the input image as a BGR cv::Mat and release the raw buffer.

Definition at line 89 of file PythonModule.C.

◆ getCvBGRp()

cv::Mat jevois::InputFramePython::getCvBGRp ( ) const

Shorthand to get the input image for processing as a BGR cv::Mat and release the raw buffer.

Definition at line 124 of file PythonModule.C.

◆ getCvGRAY()

cv::Mat jevois::InputFramePython::getCvGRAY ( ) const

Shorthand to get the input image as a GRAY cv::Mat and release the raw buffer.

Definition at line 84 of file PythonModule.C.

◆ getCvGRAY1()

cv::Mat jevois::InputFramePython::getCvGRAY1 ( bool  casync) const

Shorthand to get the input image as a GRAY cv::Mat and release the raw buffer.

Definition at line 79 of file PythonModule.C.

◆ getCvGRAYp()

cv::Mat jevois::InputFramePython::getCvGRAYp ( ) const

Shorthand to get the input image for processing as a GRAY cv::Mat and release the raw buffer.

Definition at line 119 of file PythonModule.C.

◆ getCvRGB()

cv::Mat jevois::InputFramePython::getCvRGB ( ) const

Shorthand to get the input image as a RGB cv::Mat and release the raw buffer.

Definition at line 104 of file PythonModule.C.

◆ getCvRGB1()

cv::Mat jevois::InputFramePython::getCvRGB1 ( bool  casync) const

Shorthand to get the input image as a RGB cv::Mat and release the raw buffer.

Definition at line 99 of file PythonModule.C.

◆ getCvRGBA()

cv::Mat jevois::InputFramePython::getCvRGBA ( ) const

Shorthand to get the input image as a RGBA cv::Mat and release the raw buffer.

Definition at line 114 of file PythonModule.C.

◆ getCvRGBA1()

cv::Mat jevois::InputFramePython::getCvRGBA1 ( bool  casync) const

Shorthand to get the input image as a RGBA cv::Mat and release the raw buffer.

Definition at line 109 of file PythonModule.C.

◆ getCvRGBAp()

cv::Mat jevois::InputFramePython::getCvRGBAp ( ) const

Shorthand to get the input image for processing as a RGBA cv::Mat and release the raw buffer.

Definition at line 134 of file PythonModule.C.

◆ getCvRGBp()

cv::Mat jevois::InputFramePython::getCvRGBp ( ) const

Shorthand to get the input image for processing as a RGB cv::Mat and release the raw buffer.

Definition at line 129 of file PythonModule.C.

◆ getp()

jevois::RawImage const & jevois::InputFramePython::getp ( ) const

Get the next captured camera image that is intended for processing.

Definition at line 64 of file PythonModule.C.

◆ getp1()

jevois::RawImage const & jevois::InputFramePython::getp1 ( bool  casync) const

Get the next captured camera image that is intended for processing.

Definition at line 59 of file PythonModule.C.

◆ hasScaledImage()

bool jevois::InputFramePython::hasScaledImage ( ) const

Check whether a second input image scaled by the JeVoisPro Platform ISP is available.

Definition at line 44 of file PythonModule.C.

Friends And Related Symbol Documentation

◆ GUIhelperPython

friend class GUIhelperPython
friend

Definition at line 119 of file PythonModule.H.

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