JeVoisBase  1.6
JeVois Smart Embedded Machine Vision Toolkit Base Modules
Share this page:
SurpriseRecorder Class Reference

Surprise-based recording of events. More...

Inheritance diagram for SurpriseRecorder:
Collaboration diagram for SurpriseRecorder:

Public Member Functions

 SurpriseRecorder (std::string const &instance)
 Constructor. More...
 
virtual ~SurpriseRecorder ()
 Virtual destructor for safe inheritance. More...
 
void postInit () override
 Get started. More...
 
void postUninit () override
 Get stopped. More...
 
void process (jevois::InputFrame &&inframe) override
 Processing function, version with no video output. More...
 
- Public Member Functions inherited from jevois::Module
 Module (std::string const &instance)
 
virtual ~Module ()
 
virtual void process (InputFrame &&inframe, OutputFrame &&outframe)
 
virtual void sendSerial (std::string const &str)
 
virtual void parseSerial (std::string const &str, std::shared_ptr< UserInterface > s)
 
virtual void supportedCommands (std::ostream &os)
 
 JEVOIS_DEFINE_ENUM_CLASS (SerStyle,(Terse)(Normal)(Detail)(Fine)) JEVOIS_DECLARE_PARAMETER(serstyle
 
 JEVOIS_DECLARE_PARAMETER (serprec, unsigned int, "Number of decimal points in standardized serial messages as " "defined in http://jevois.org/doc/UserSerialStyle.html", 0U, ParamCateg)
 
- Public Member Functions inherited from jevois::Component
 Component (std::string const &instance)
 
virtual ~Component ()
 
std::shared_ptr< ComponentgetSubComponent (std::string const &instance) const
 
std::shared_ptr< Comp > addSubComponent (std::string const &instance, Args &&...args)
 
void removeSubComponent (std::shared_ptr< Comp > &component)
 
void removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
 
std::shared_ptr< Comp > getSubComponent (std::string const &instance) const
 
bool isTopLevel () const
 
bool initialized () const
 
std::string const & className () const
 
std::string const & instanceName () const
 
std::vector< std::string > setParamVal (std::string const &paramdescriptor, T const &val)
 
void setParamValUnique (std::string const &paramdescriptor, T const &val)
 
std::vector< std::pair< std::string, T > > getParamVal (std::string const &paramdescriptor) const
 
getParamValUnique (std::string const &paramdescriptor) const
 
std::vector< std::string > setParamString (std::string const &paramdescriptor, std::string const &val)
 
void setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
 
std::vector< std::pair< std::string, std::string > > getParamString (std::string const &paramdescriptor) const
 
std::string getParamStringUnique (std::string const &paramdescriptor) const
 
void freezeParam (std::string const &paramdescriptor)
 
void unFreezeParam (std::string const &paramdescriptor)
 
void freezeAllParams ()
 
void unFreezeAllParams ()
 
std::string descriptor () const
 
void setParamsFromFile (std::string const &filename)
 
std::istream & setParamsFromStream (std::istream &is, std::string const &absfile)
 
void setPath (std::string const &path)
 
std::string absolutePath (std::string const &path="")
 
std::shared_ptr< Comp > addSubComponent (std::string const &instance, Args &&...args)
 
void removeSubComponent (std::shared_ptr< Comp > &component)
 
void removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
 
std::shared_ptr< Comp > getSubComponent (std::string const &instance) const
 
bool isTopLevel () const
 
bool initialized () const
 
std::string const & className () const
 
std::string const & instanceName () const
 
std::vector< std::string > setParamVal (std::string const &paramdescriptor, T const &val)
 
void setParamValUnique (std::string const &paramdescriptor, T const &val)
 
std::vector< std::pair< std::string, T > > getParamVal (std::string const &paramdescriptor) const
 
getParamValUnique (std::string const &paramdescriptor) const
 
std::vector< std::string > setParamString (std::string const &paramdescriptor, std::string const &val)
 
void setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
 
std::vector< std::pair< std::string, std::string > > getParamString (std::string const &paramdescriptor) const
 
std::string getParamStringUnique (std::string const &paramdescriptor) const
 
void freezeParam (std::string const &paramdescriptor)
 
void unFreezeParam (std::string const &paramdescriptor)
 
void freezeAllParams ()
 
void unFreezeAllParams ()
 
std::string descriptor () const
 
void setParamsFromFile (std::string const &filename)
 
std::istream & setParamsFromStream (std::istream &is, std::string const &absfile)
 
void setPath (std::string const &path)
 
std::string absolutePath (std::string const &path="")
 
- Public Member Functions inherited from jevois::ParameterRegistry
virtual ~ParameterRegistry ()
 

Protected Member Functions

void run ()
 Video writer thread. More...
 
- Protected Member Functions inherited from jevois::Component
virtual void preInit ()
 
virtual void preUninit ()
 
virtual void preInit ()
 
virtual void preUninit ()
 
- Protected Member Functions inherited from jevois::ParameterRegistry
void addParameter (ParameterBase *const param)
 
void removeParameter (ParameterBase *const param)
 
void callbackInitCall ()
 

Protected Attributes

std::shared_ptr< SurpriseitsSurprise
 
std::future< void > itsRunFut
 Future for our run() thread. More...
 
std::deque< cv::Mat > itsCtxBuf
 Buffer for context frames before event start. More...
 
jevois::BoundedBuffer< cv::Mat, jevois::BlockingBehavior::Block, jevois::BlockingBehavior::BlockitsBuf
 Buffer for frames to save. More...
 
int itsToSave
 Number of context frames after end of event that remain to be saved. More...
 
int itsFileNum
 Video file number. More...
 
std::atomic< bool > itsRunning
 Flag to let run thread when to quit. More...
 
std::string itsFilename
 Current video file name. More...
 

Related Functions

(Note that these are not member functions.)

 JEVOIS_DECLARE_PARAMETER (filename, std::string, "Name of the video file to write. If path is not absolute, " PATHPREFIX " will be prepended to it. Name should contain a printf-like directive for " "one int argument, which will start at 0 and be incremented on each streamoff command.", "video%06d.avi", ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (fourcc, std::string, "FourCC of the codec to use. The OpenCV VideoWriter doc is unclear " "as to which codecs are supported. Presumably, the ffmpeg library is used inside OpenCV. " "Hence any video encoder supported by ffmpeg should work. Tested codecs include: MJPG, " "MP4V, AVC1. Make sure you also pick the right filename extension (e.g., .avi for MJPG, " ".mp4 for MP4V, etc)", "MJPG", boost::regex("^\4}$"), ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (fps, double, "Video frames/sec as stored in the file and to be used both for recording and " "playback. Beware that the video writer will drop frames if you are capturing faster than " "the frame rate specified here. For example, if capturing at 120fps, be sure to set this " "parameter to 120, otherwise by default the saved video will be at 30fps even though capture " "was running at 120fps.", 15.0, ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (thresh, double, "Surprise threshold. Lower values will record more events.", 1.0e7, ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (ctxframes, unsigned int, "Number of context video frames recorded before and after " "each surprising event.", 150, ParamCateg)
 Parameter. More...
 

Detailed Description

Surprise-based recording of events.

This module detects surprising events in the live video feed from the camera, and records short video clips of each detected event.

Surprising is here defined according to Itti and Baldi's mathematical theory of surprise (see, e.g., http://ilab.usc.edu/surprise/) which is applied to monitoring live video streams. When a surprising event is detected, a short video clip of that event is saved to the microSD card inside JeVois, for later review.

It was created in this JeVois tutorial: http://jevois.org/tutorials/ProgrammerSurprise.html

Using this module

This module does not send any video output to USB. Rather, it just saves surprising events to microSD for later review. Hence, you may want to try the following:

  • mount the JeVois camera where you want it to detect surprising events
  • run it connected to a laptop computer, using any mode which does have some video output over USB (e.g., 640x500 YUYV). Adjust the camera orientation to best fit your needs.
  • edit JEVOIS:/config/initscript.cfg to contain:
      setmapping2 YUYV 640 480 15.0 JeVois SurpriseRecorder
      setpar thresh 1e7
      setpar channels S
      streamon
    and see the above tutorial for more details. Next time you power JeVois, it will immediately start detecting and recording surprising events in its view.

Example

Here is one hour of video surveillance footage. It is very boring overall. Except that a few brief surprising things occur (a few seconds each). Can you find them?

Here is what the SurpriseRecorder module found (4 true events plus 2 false alarms):

With only 6 surprising events, and assuming +/- 10 seconds of context frames around each event, we have achieved a compression of the surveillance footage from 60 minutes to 2 minutes (a factor 30x).

Author
Laurent Itti
Videomapping:
NONE 0 0 0 YUYV 640 480 15.0 JeVois SurpriseRecorder
Email:
itti@usc.edu
Address:
University of Southern California, HNB-07A, 3641 Watt Way, Los Angeles, CA 90089-2520, USA
Main URL:
http://jevois.org
Support URL:
http://jevois.org/doc
Other URL:
http://iLab.usc.edu
License:
GPL v3
Distribution:
Unrestricted
Restrictions:
None

Definition at line 124 of file SurpriseRecorder.C.

Constructor & Destructor Documentation

◆ SurpriseRecorder()

SurpriseRecorder::SurpriseRecorder ( std::string const &  instance)
inline

Constructor.

Definition at line 132 of file SurpriseRecorder.C.

References itsSurprise.

◆ ~SurpriseRecorder()

virtual SurpriseRecorder::~SurpriseRecorder ( )
inlinevirtual

Virtual destructor for safe inheritance.

Definition at line 139 of file SurpriseRecorder.C.

Member Function Documentation

◆ postInit()

void SurpriseRecorder::postInit ( )
inlineoverridevirtual

Get started.

Reimplemented from jevois::Component.

Definition at line 145 of file SurpriseRecorder.C.

References itsRunFut, itsRunning, and run().

◆ postUninit()

◆ process()

◆ run()

void SurpriseRecorder::run ( )
inlineprotected

Friends And Related Function Documentation

◆ JEVOIS_DECLARE_PARAMETER() [1/5]

JEVOIS_DECLARE_PARAMETER ( filename  ,
std::string  ,
"Name of the video file to write. If path is not  absolute,
" PATHPREFIX " will be prepended to it. Name should contain a printf-like directive for " "one int  argument,
which will start at 0 and be incremented on each streamoff command."  ,
"video%06d.avi"  ,
ParamCateg   
)
related

Parameter.

◆ JEVOIS_DECLARE_PARAMETER() [2/5]

JEVOIS_DECLARE_PARAMETER ( fourcc  ,
std::string  ,
"FourCC of the codec to use. The OpenCV VideoWriter doc is unclear " "as to which codecs are supported.  Presumably,
the ffmpeg library is used inside OpenCV. " "Hence any video encoder supported by ffmpeg should work. Tested codecs include:MJPG  ,
" "  MP4V,
AVC1. Make sure you also pick the right filename extension(e.g.,.avi for MJPG, " ".mp4 for MP4V, etc)"  ,
"MJPG"  ,
boost::regex("^\}$")  ,
ParamCateg   
)
related

Parameter.

◆ JEVOIS_DECLARE_PARAMETER() [3/5]

JEVOIS_DECLARE_PARAMETER ( fps  ,
double  ,
"Video frames/sec as stored in the file and to be used both for recording and " "playback. Beware that the video writer will drop frames if you are capturing faster than " "the frame rate specified here. For  example,
if capturing at  120fps,
be sure to set this " "parameter to  120,
otherwise by default the saved video will be at 30fps even though capture " "was running at 120fps."  ,
15.  0,
ParamCateg   
)
related

Parameter.

◆ JEVOIS_DECLARE_PARAMETER() [4/5]

JEVOIS_DECLARE_PARAMETER ( thresh  ,
double  ,
"Surprise threshold. Lower values will record more events."  ,
1.  0e7,
ParamCateg   
)
related

Parameter.

◆ JEVOIS_DECLARE_PARAMETER() [5/5]

JEVOIS_DECLARE_PARAMETER ( ctxframes  ,
unsigned  int,
"Number of context video frames recorded before and after " "each surprising event."  ,
150  ,
ParamCateg   
)
related

Parameter.

Member Data Documentation

◆ itsBuf

Buffer for frames to save.

Definition at line 323 of file SurpriseRecorder.C.

Referenced by postUninit(), process(), and run().

◆ itsCtxBuf

std::deque<cv::Mat> SurpriseRecorder::itsCtxBuf
protected

Buffer for context frames before event start.

Definition at line 321 of file SurpriseRecorder.C.

Referenced by process().

◆ itsFilename

std::string SurpriseRecorder::itsFilename
protected

Current video file name.

Definition at line 327 of file SurpriseRecorder.C.

Referenced by postUninit(), and run().

◆ itsFileNum

int SurpriseRecorder::itsFileNum
protected

Video file number.

Definition at line 325 of file SurpriseRecorder.C.

Referenced by run().

◆ itsRunFut

std::future<void> SurpriseRecorder::itsRunFut
protected

Future for our run() thread.

Definition at line 320 of file SurpriseRecorder.C.

Referenced by postInit(), and postUninit().

◆ itsRunning

std::atomic<bool> SurpriseRecorder::itsRunning
protected

Flag to let run thread when to quit.

Definition at line 326 of file SurpriseRecorder.C.

Referenced by postInit(), postUninit(), and run().

◆ itsSurprise

std::shared_ptr<Surprise> SurpriseRecorder::itsSurprise
protected

Definition at line 251 of file SurpriseRecorder.C.

Referenced by process(), and SurpriseRecorder().

◆ itsToSave

int SurpriseRecorder::itsToSave
protected

Number of context frames after end of event that remain to be saved.

Definition at line 324 of file SurpriseRecorder.C.

Referenced by process().


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