DemoDMP Class Reference

Plot results of processing IMU data with the on-chip Digital Motion Processor (DMP) More...

Inheritance diagram for DemoDMP:

Collaboration diagram for DemoDMP:

Public Member Functions
	DemoDMP (std::string const &instance)
	Constructor. More...
virtual	~DemoDMP ()
	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 ()

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

Plot results of processing IMU data with the on-chip Digital Motion Processor (DMP)

As an optional hardware upgrade, one can install a global shutter sensor into JeVois (an OnSemi AR0135 1.2MP), which also includes on its custom circuit board for JeVois an inertial measurement unit (IMU). The IMU is a 9-degrees-of-freedom (9DOF) TDK InvenSense ICM-20948 (with 3-axis accelerometer, 3-axis gyroscope, and 3-axis magnetometer). This IMU also includes a digital motion processing unit (small programmable processor inside the IMU chip), which allows it to compute and filter quaternions directly inside the IMU chip.

This module only works with optional JeVois sensors that include an IMU! The base JeVois-A33 smart camera does not have an onboard IMU.

This module demonstrates the digital motion processing (DMP) mode of the IMU.

The specifications of this chip are quite impressive:

• 3-axis 16-bit accelerometer with full-range sensitivity selectable to +/-2g, +/-4g, +/-8g, and +/-16g.
• Accelerometer data rate from 4 Hz to 1125 Hz.
• 3-axis 16-bit gyroscope with full-range sensitivity selectable to +/-250dps (degrees/s), +/-500dps, +/-1000dps, and +/-2000dps.
• Gyroscope data rate from 4 Hz to 1125 Hz.
• 3-axis 16-bit magnetometer (compass) with wide range of +/-4900uT (micro Tesla).
• Magnetometer data rates 10 Hz, 20 Hz, 50 Hz, or 100 Hz.
• 16-bit temperature sensor with readout rate of up to 8 kHz.
• RAW data mode (get current sensor values at any time), buffered (FIFO) data mode (sensor values accumulate into a FIFO at a fixed rate), and digital motion processing mode (DMP; raw data is processed on-chip).
• On-chip digital motion processor (DMP) can compute, inside the IMU chip itself:
  • quaternion 6 (uses accel + gyro),
  • quaternion 9 (uses accel + gyro + compass),
  • geomag quaternion (uses accel + compass),
  • flip/pickup detection,
  • step detection and counting,
  • basic activity recognition: drive, walk, run, bike, tilt, still.

With quaternions computed on-chip, with an algorithm that gets sensor data at a highly accurate, fixed rate, and applies various calibrations, drift corrections, and compensations on the fly, one gets highly accurate real-time estimate of the sensor's pose in the 3D world and of how it is moving.

Note that communication with the IMU is over a 400kHz I2C bus, which may limit data readout rate depending on which data is requested from the IMU.

This IMU has 3 basic modes of operation (parameter mode, which can only be set in params.cfg):

• RAW: One can access the latest raw sensor data at any time using the getRaw() or get() functions. This is the simplest mode of operation. One disadvantage is that if you are not calling get() at a perfectly regular interval, there will be some time jitter in your readouts. The IMU does not provide any time stamps for its data.
• FIFO: In this mode, data from the sensor is piled up into a 1 kbyte FIFO buffer at a precise, constant rate (when all three of accelerometer, gyroscope, and magnetometer are on, the gyro rate determines the FIFO buffering rate). Main advantage is that you can then read out the data without having to worry about calling getRaw() or get() at a highly precise interval. But you need to be careful that the FIFO can fill up and overflow very quickly when using high sensor data rates.
• DMP: In this mode, data is captured from the sensor at an accurate, fixed rate, and is fed to the on-chip digital motion processor (DMP). The DMP then computes quaternions, activity recognition, etc and pushes data packets into the FIFO as results from these algorithms become available.

Low-level tweaking of the IMU and DMP

The ICM-20948 IMU chip is a very sophisticated and complex computer on its own right. There are many settings and modes that are supported. Unfortunately, the full documentation is not open. But you can obtain it after registration with TDK InvenSense. We provide the following user-level functions in the command-line interface of JeVois to allow you to get/set raw registers of the IMU and DMP:

• setimureg <reg> <val> - set raw IMU register <reg> to value <val>
• getimureg <reg> - get value of raw IMU register <reg>
• setimuregs <reg> <num> <val1> ... <valn> - set array of raw IMU register values
• getimuregs <reg> <num> - get array of raw IMU register values
• setdmpreg <reg> <val> - set raw DMP register <reg> to value <val>
• getdmpreg <reg> - get value of raw DMP register <reg>
• setdmpregs <reg> <num> <val1> ... <valn> - set array of raw DMP register values
• getdmpregs <reg> <num> - get array of raw DMP register values

The registers and values can be specified in decimal, hex (with prefix 0x), or octal (with prefix 0 - beware of this and be careful). The values returned are always in hex (with no prefix). Note that the above functions are not activated by default, to prevent mistakes by rookie users. To activate them, issue a setpar camreg 1 on the JeVois console.

For example, to set the output data rate (ODR) of the DMP quaternion-9; this is in DMP register DMP_ODR_QUAT9 = 168 (see definitions in file ICM20948_regs.H of the JeVois core software):

setpar camreg 1
getdmpreg 168 # shows default divider value of 5; ODR is DMP engine rate / (1 + divider)
setdmpreg 168 2

To see the effect, you should first turn on FSYNC as one of the DMP outputs (e.g., set dmp parameter to QF). Then turn on parameter pktdbg and turn on log messages to USB see how many quaternion packets (long packets that start with 4 0) you get between two FSYNC packets (short packets that start with 0 8 8 0). By default it is about 2 (with camera sensor at 25fps and DMP engine running at 56Hz). Then increase the arate and grate to 112 Hz. You should still get about 2 quaternion packets between two FSYNC packets. Finally, apply the above DMP register change. You should now see 4 quaternion packets between two FSYNC packets. Note that sometimes quaternion and FSYNC packets get combined.

As you experiment, keep in mind that the IMU can easily saturate the 400 kHz bandwidth of the i2c bus that connects it to the JeVois main processor. If you start getting errors in the console from IMUdata::parsePacket() then likely your data rate is too high for the i2c bus. One of the nice things about the DMP is that you can still run the quaternion computation very fast (e.g., at 450 Hz or even 1125 Hz) while maintaining a low output data rate.

Author

Laurent Itti

Videomapping:

YUYV 640 520 25.0 YUYV 640 480 25.0 JeVois DemoDMP

Email:

itti@usc.edu

Address:

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

Copyright

Copyright (C) 2018 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 145 of file DemoDMP.C.

Constructor & Destructor Documentation

DemoDMP()

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

inline

Constructor.

Definition at line 149 of file DemoDMP.C.

~DemoDMP()

virtual DemoDMP::~DemoDMP ( )

inlinevirtual

Virtual destructor for safe inheritance.

Definition at line 153 of file DemoDMP.C.

Member Function Documentation

process()

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

inlineoverridevirtual

Processing function.

Reimplemented from jevois::Module.

Definition at line 156 of file DemoDMP.C.

References jevois::DMPdata::accel, jevois::DMPdata::activity2(), jevois::IMUrawData::ax(), jevois::IMUdata::ax(), jevois::IMUrawData::ay(), jevois::IMUdata::ay(), jevois::IMUrawData::az(), jevois::IMUdata::az(), jevois::RawImage::buf, jevois::DMPdata::cpass, jevois::rawimage::drawFilledRect(), jevois::rawimage::drawLine(), jevois::DMPdata::fix2float(), jevois::RawImage::fmt, jevois::rawimage::Font10x20, jevois::DMPdata::fsync_us(), jevois::DMPdata::geomag, jevois::IMUrawData::gx(), jevois::IMUdata::gx(), jevois::IMUrawData::gy(), jevois::IMUdata::gy(), jevois::DMPdata::gyro, jevois::IMUrawData::gz(), jevois::IMUdata::gz(), h, jevois::DMPdata::header1, jevois::DMPdata::header2, jevois::RawImage::height, JEVOIS_DMP_ACCEL, JEVOIS_DMP_ACT_RECOG, JEVOIS_DMP_CPASS, JEVOIS_DMP_FLIP_PICKUP, JEVOIS_DMP_FSYNC, JEVOIS_DMP_GEOMAG, JEVOIS_DMP_GYRO, JEVOIS_DMP_PED_STEPDET, JEVOIS_DMP_QUAT6, JEVOIS_DMP_QUAT9, jevois::join(), LERROR, LINFO, jevois::IMUrawData::mx(), jevois::IMUdata::mx(), jevois::IMUdata::my(), jevois::IMUrawData::my(), jevois::IMUdata::mz(), jevois::IMUrawData::mz(), jevois::RawImage::pixels(), jevois::RawImage::pixelsw(), quantize-inc::q, jevois::DMPdata::quat6, jevois::DMPdata::quat9, jevois::RawImage::require(), jevois::sformat(), jevois::DMPdata::steps, jevois::DMPdata::stepts, to_string(), demo::w, jevois::RawImage::width, and jevois::rawimage::writeText().

---

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

• src/Modules/DemoDMP/DemoDMP.C