DemoEyeTracker Class Reference

Pupil detection and eye-tracker using the openEyes toolkit. More...

Inheritance diagram for DemoEyeTracker:

Collaboration diagram for DemoEyeTracker:

Public Member Functions
	DemoEyeTracker (std::string const &instance)
	Constructor. More...
virtual	~DemoEyeTracker ()
	Virtual destructor for safe inheritance. More...
virtual void	process (jevois::InputFrame &&inframe, jevois::OutputFrame &&outframe) override
	Processing function. More...
Public Member Functions inherited from jevois::Module
	Module (std::string const &instance)
virtual	~Module ()
virtual void	process (InputFrame &&inframe)
virtual void	process (InputFrame &&inframe, GUIhelper &helper)
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)
Public Member Functions inherited from jevois::Component
	Component (std::string const &instance)
virtual	~Component ()
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
Engine *	engine () const
bool	initialized () const
const std::string &	className () const
const std::string &	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
T	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)
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="")
void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
void	removeDynamicParameter (std::string const &name)
void	setPath (std::string const &path)
std::filesystem::path	absolutePath (std::filesystem::path 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
Engine *	engine () const
bool	initialized () const
const std::string &	className () const
const std::string &	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
T	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)
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="")
void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
void	removeDynamicParameter (std::string const &name)
void	setPath (std::string const &path)
std::filesystem::path	absolutePath (std::filesystem::path const &path="")
Public Member Functions inherited from jevois::ParameterRegistry
virtual	~ParameterRegistry ()

Protected Attributes
std::shared_ptr< EyeTracker >	itsEyeTracker

Additional Inherited Members
Protected Member Functions inherited from jevois::Component
virtual void	preInit ()
virtual void	postInit ()
virtual void	preUninit ()
virtual void	postUninit ()
virtual void	preInit ()
virtual void	postInit ()
virtual void	preUninit ()
virtual void	postUninit ()
Protected Member Functions inherited from jevois::ParameterRegistry
void	addParameter (ParameterBase *const param)
void	removeParameter (ParameterBase *const param)
void	callbackInitCall ()

Detailed Description

Pupil detection and eye-tracker using the openEyes toolkit.

This module implements an eye tracker, which is based on detecting the outline of the pupil.

Note that the camera has to be very close to the eye for this to work well. To be useful in practice, some sort of prism or tele-lens should be used so that the camera can be out of the field of view of the human participant.

This module can easily run at 120 frames/s.

The original eye tracking software used here can be found at http://thirtysixthspan.com/openEyes/software.html

This module only performs the required image processing. To build a complete eye tracking system, additional software is required (which can be provided by several open-source eye-tracking toolkits):

• Establish a calibration procedure, whereby the participant will be asked to look at small dots at known locations on the computer screen. This will allow a comparison between coordinates of the pupil center as reported by JeVois and coordinates on the computer screen.
• Compute the calibration transform (mapping from pupil coordinates reported by JeVois to screen coordinates) based on the data obtained by the calibration procedure. This has to be done once for each participant and eye-tracking session, or every time a participant moves her/his head by a large amount.
• On new eye-tracking sessions, convert pupil coordinates reported by JeVois to screen coordinates.
• If desired, extract events in the raw calibrated data stream, such as fixations, rapid saccadic eye movements, smooth pursuit movements, and blinks.

Author

Laurent Itti

Videomapping:

GREY 640 480 30.0 YUYV 640 480 30.0 JeVois DemoEyeTracker

Videomapping:

GREY 320 240 60.0 YUYV 320 240 60.0 JeVois DemoEyeTracker

Videomapping:

GREY 176 144 120.0 YUYV 176 144 120.0 JeVois DemoEyeTracker

Email:

itti@usc.edu

Address:

University of Southern California, HNB-07A, 3641 Watt Way, Los Angeles, CA 90089-2520, USA

Copyright

Copyright (C) 2016 by Laurent Itti, iLab and the University of Southern California

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 70 of file DemoEyeTracker.C.

Constructor & Destructor Documentation

DemoEyeTracker()

DemoEyeTracker::DemoEyeTracker ( std::string const &  instance )

inline

Constructor.

Definition at line 75 of file DemoEyeTracker.C.

References itsEyeTracker.

~DemoEyeTracker()

virtual DemoEyeTracker::~DemoEyeTracker ( )

inlinevirtual

Virtual destructor for safe inheritance.

Definition at line 79 of file DemoEyeTracker.C.

Member Function Documentation

process()

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

inlineoverridevirtual

Processing function.

Reimplemented from jevois::Module.

Definition at line 82 of file DemoEyeTracker.C.

References jevois::rawimage::cvImage(), jevois::RawImage::height, itsEyeTracker, jevois::RawImage::require(), jevois::Timer::start(), jevois::Timer::stop(), jevois::RawImage::width, and jevois::rawimage::writeText().

Member Data Documentation

itsEyeTracker

std::shared_ptr<EyeTracker> DemoEyeTracker::itsEyeTracker

protected

Definition at line 120 of file DemoEyeTracker.C.

Referenced by DemoEyeTracker(), and process().

---

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

• src/Modules/DemoEyeTracker/DemoEyeTracker.C