Detailed Description

Contains classes for various device interfaces.

Classes
class	C2DRangeFinderAbstract
	This is the base, abstract class for "software drivers" interfaces to 2D scanners (laser range finders). More...

class	CBoardENoses
	A class for interfacing an e-Noses via a FTDI USB link. More...

class	CBoardSonars
	This "software driver" implements the communication protocol for interfacing a Ultrasonic range finder SRF10 through a custom USB board. More...

class	CCameraSensor
	The central class for camera grabbers in MRPT, implementing the "generic sensor" interface. More...

class	CCANBusReader
	This "software driver" implements the communication protocol for interfacing a SICK LMS 2XX laser scanners through a standard RS232 serial port (or a USB2SERIAL converter). More...

class	CDUO3DCamera
	This "software driver" implements the communication protocol for interfacing a DUO3D Stereo Camera. More...

class	CEnoseModular
	A class for interfacing an e-NoseModular via a FTDI USB link. More...

class	CFFMPEG_InputStream
	A generic class which process a video file or other kind of input stream (http, rtsp) and allows the extraction of images frame by frame. More...

class	CGenericSensor
	A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabber. More...

class	CGillAnemometer
	This class implements a driver for the Gill Windsonic Option 1 Anemometer The sensor is accessed via a standard serial port. More...

class	CGPS_NTRIP
	A combination of GPS receiver + NTRIP receiver capable of submitting GGA frames to enable RTCM 3.0. More...

class	CGPSInterface
	A class capable of reading GPS/GNSS/GNSS+IMU receiver data, from a serial port or from any input stream, and parsing the ASCII/binary stream into indivual messages stored in mrpt::obs::CObservationGPS objects. More...

class	CGyroKVHDSP3000
	A class for interfacing KVH DSP 3000 gyroscope with an assynchronous serial communication (product SN : 02-1222-01). More...

class	CHokuyoURG
	This software driver implements the protocol SCIP-2.0 for interfacing HOKUYO URG/UTM/UXM/UST laser scanners (USB or Ethernet). More...

class	CIbeoLuxETH
	This "software driver" implements the communication protocol for interfacing a Ibeo Lux laser scanners through an ethernet controller. More...

class	CImageGrabber_dc1394
	A class for grabing images from a IEEE1394 (Firewire) camera using the libdc1394-2 library. More...

class	CImageGrabber_FlyCapture2
	A wrapper for Point Gray Research (PGR) FlyCapture2 API for capturing images from Firewire, USB3 or GigaE cameras and stereo cameras. More...

class	CImageGrabber_OpenCV
	A class for grabing images from a "OpenCV"-compatible camera, or from an AVI video file. More...

class	CImpinjRFID
	This class implements an interface to an Impinj RFID reader. More...

class	CIMUIntersense
	A class for interfacing Intersense Inertial Measuring Units (IMUs). More...

class	CIMUXSens
	A class for interfacing XSens 3rd generation Inertial Measuring Units (IMUs), the "XSens MTi" model. More...

class	CIMUXSens_MT4
	A class for interfacing XSens 4th generation Inertial Measuring Units (IMUs): MTi 10-series, MTi 100-series. More...

class	CJoystick
	Access to joysticks and gamepads (read buttons and position), and request number of joysticks in the system. More...

class	CKinect
	A class for grabing "range images", intensity images (either RGB or IR) and other information from an Xbox Kinect sensor. More...

class	CLMS100Eth
	This "software driver" implements the communication protocol for interfacing a SICK LMS100 laser scanners through an ethernet controller. More...

class	CMyntEyeCamera
	Wrapper on MYNT-EYE-D cameras. More...

class	CNationalInstrumentsDAQ
	An interface to read from data acquisition boards compatible with National Instruments "DAQmx Base" or "DAQmx". More...

class	CNTRIPClient
	A client for NTRIP (HTTP) sources of differential GPS corrections from internet servers, or Global navigation satellite system (GNSS) internet radio. More...

class	CNTRIPEmitter
	This "virtual driver" encapsulates a NTRIP client (see CNTRIPClient) but adds the functionality of dumping the received datastream to a given serial port. More...

class	COpenNI2_RGBD360
	A class for grabing RGBD images from several OpenNI2 sensors. More...

class	COpenNI2Generic
	An abstract class for accessing OpenNI2 compatible sensors. More...

class	COpenNI2Sensor
	A class for grabing "range images", intensity images (either RGB or IR) and other information from an OpenNI2 sensor. More...

class	CPhidgetInterfaceKitProximitySensors
	: An interface for the phidget Interface kit board (1018). More...

class	CPtuBase
	This class implements initialization and communication methods to control a generic Pan and Tilt Unit, working in radians. More...

class	CPtuDPerception
	This class implements initialization and communication methods to control a Pan and Tilt Unit model PTU-46-17.5, working in radians . More...

class	CRaePID
	This class implements a driver for the RAE Systems gas PhotoIonization Detector (PID) (Tested on a MiniRAE Lite) The sensor is accessed via a standard (or USB) serial port. More...

class	CRoboPeakLidar
	Interfaces a Robo Peak LIDAR laser scanner. More...

class	CRoboticHeadInterface
	This "software driver" implements the communication protocol for interfacing a Robotic Head Board through a custom USB RS-422 interface board. More...

class	CRovio
	A class to interface a Rovio robot (manufactured by WowWee). More...

class	CServoeNeck
	A USB-interface for a custom "robotic neck" designed at MAPIR lab. More...

class	CSickLaserSerial
	This "software driver" implements the communication protocol for interfacing a SICK LMS 2XX laser scanners through a standard RS232 serial port (or a USB2SERIAL converter). More...

class	CSickLaserUSB
	This "software driver" implements the communication protocol for interfacing a SICK LMS2XX laser scanners through a custom USB RS-422 interface board. More...

class	CSICKTim561Eth

class	CSkeletonTracker
	A class for grabbing mrpt::obs::CObservationSkeleton from a PrimeSense camera. More...

class	CStereoGrabber_Bumblebee_libdc1394
	Grabs from a "Bumblebee" or "Bumblebee2" stereo camera using raw access to the libdc1394 library. More...

class	CStereoGrabber_SVS
	A class for grabing stereo images from a STOC camera of Videre Design NOTE: More...

class	CSwissRanger3DCamera
	A class for grabing "range images" from a MESA imaging SwissRanger 3D cameras (SR-2, SR-3000, SR-4k). More...

class	CTuMicos
	This class implements initialization and communication methods to control a Tilt Unit model DT-80, working in radians . More...

class	CVelodyneScanner
	A C++ interface to Velodyne laser scanners (HDL-64, HDL-32, VLP-16), working on Linux and Windows. More...

class	CWirelessPower
	This class implements a wireless power probe. More...

struct	TCaptureCVOptions
	Options used when creating an OpenCV capture object Some options apply to IEEE1394 cameras only. More...

struct	TCaptureOptions_bumblebee
	Options used when creating a bumblebee camera capture object. More...

struct	TCaptureOptions_dc1394
	Options used when creating an dc1394 capture object All but the frame size, framerate, and color_coding can be changed dynamically by CImageGrabber_dc1394::changeCaptureOptions. More...

struct	TCaptureOptions_DUO3D
	Options used when creating a camera capture object of type CImageGrabber_FlyCapture2. More...

struct	TCaptureOptions_FlyCapture2
	Options used when creating a camera capture object of type CImageGrabber_FlyCapture2. More...

struct	TCaptureOptions_SVS
	Options used when creating a STOC Videre Design camera capture object. More...

struct	TMyntEyeCameraParameters
	Open parameters for CMyntEyeCamera. More...

struct	TSensorClassId
	A structure for runtime ID class type information in the context of hwdrivers::CGenericSensor. More...

Enumerations
enum	GYRO_MODE { RATE, INCREMENTAL_ANGLE, INTEGRATED_ANGLE }

enum	grabber_dc1394_framerate_t { FRAMERATE_1_875 = 32, FRAMERATE_3_75, FRAMERATE_7_5, FRAMERATE_15, FRAMERATE_30, FRAMERATE_60, FRAMERATE_120, FRAMERATE_240 }

enum	grabber_dc1394_color_coding_t { COLOR_CODING_MONO8 = 352, COLOR_CODING_YUV411, COLOR_CODING_YUV422, COLOR_CODING_YUV444, COLOR_CODING_RGB8, COLOR_CODING_MONO16 }

enum	TCameraType { CAMERA_CV_AUTODETECT = 0, CAMERA_CV_DC1394, CAMERA_CV_VFL, CAMERA_CV_VFW, CAMERA_CV_MIL, CAMERA_CV_DSHOW }
	These capture types are like their OpenCV equivalents. More...

enum	SensorType { SHARP_30cm, SHARP_80cm, EZ1, UNPLUGGED }

Functions
CCameraSensor::Ptr	prepareVideoSourceFromPanel (void *panel)
	Used only from MRPT apps: Use with caution since "panel" MUST be a "mrpt::gui::CPanelCameraSelection *". More...

void	writeConfigFromVideoSourcePanel (void panel, const std::string &in_cfgfile_section_name, mrpt::config::CConfigFileBase out_cfgfile)
	Parse the user options in the wxWidgets "panel" and write the configuration into the given section of the given configuration file. More...

void	readConfigIntoVideoSourcePanel (void panel, const std::string &in_cfgfile_section_name, const mrpt::config::CConfigFileBase in_cfgfile)
	Parse the given section of the given configuration file and set accordingly the controls of the wxWidgets "panel". More...

CCameraSensor::Ptr	prepareVideoSourceFromUserSelection ()
	Show to the user a list of possible camera drivers and creates and open the selected camera. More...

Enumeration Type Documentation

◆ grabber_dc1394_color_coding_t

enum mrpt::hwdrivers::grabber_dc1394_color_coding_t

Enumerator
COLOR_CODING_MONO8
COLOR_CODING_YUV411
COLOR_CODING_YUV422
COLOR_CODING_YUV444
COLOR_CODING_RGB8
COLOR_CODING_MONO16

Definition at line 31 of file CImageGrabber_dc1394.h.

◆ grabber_dc1394_framerate_t

enum mrpt::hwdrivers::grabber_dc1394_framerate_t

Enumerator
FRAMERATE_1_875
FRAMERATE_3_75
FRAMERATE_7_5
FRAMERATE_15
FRAMERATE_30
FRAMERATE_60
FRAMERATE_120
FRAMERATE_240

Definition at line 19 of file CImageGrabber_dc1394.h.

◆ GYRO_MODE

enum mrpt::hwdrivers::GYRO_MODE

Enumerator
RATE
INCREMENTAL_ANGLE
INTEGRATED_ANGLE

Definition at line 20 of file CGyroKVHDSP3000.h.

◆ SensorType

enum mrpt::hwdrivers::SensorType

Enumerator
SHARP_30cm
SHARP_80cm
EZ1
UNPLUGGED

Definition at line 93 of file CPhidgetInterfaceKitProximitySensors.h.

◆ TCameraType

enum mrpt::hwdrivers::TCameraType

These capture types are like their OpenCV equivalents.

Enumerator
CAMERA_CV_AUTODETECT
CAMERA_CV_DC1394
CAMERA_CV_VFL
CAMERA_CV_VFW
CAMERA_CV_MIL
CAMERA_CV_DSHOW

Definition at line 21 of file CImageGrabber_OpenCV.h.

Function Documentation

◆ prepareVideoSourceFromPanel()

CCameraSensor::Ptr mrpt::hwdrivers::prepareVideoSourceFromPanel ( void * panel )

Used only from MRPT apps: Use with caution since "panel" MUST be a "mrpt::gui::CPanelCameraSelection *".

Definition at line 1542 of file CCameraSensor.cpp.

References THROW_EXCEPTION, and writeConfigFromVideoSourcePanel().

Here is the call graph for this function:

◆ prepareVideoSourceFromUserSelection()

CCameraSensor::Ptr mrpt::hwdrivers::prepareVideoSourceFromUserSelection ( )

Show to the user a list of possible camera drivers and creates and open the selected camera.

Definition at line 1467 of file CCameraSensor.cpp.

References mrpt::gui::WxSubsystem::createOneInstanceMainThread(), mrpt::gui::WxSubsystem::TRequestToWxMainThread::OPCODE, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ readConfigIntoVideoSourcePanel()

void mrpt::hwdrivers::readConfigIntoVideoSourcePanel	(	void *	panel,
		const std::string &	in_cfgfile_section_name,
		const mrpt::config::CConfigFileBase *	in_cfgfile
	)

Parse the given section of the given configuration file and set accordingly the controls of the wxWidgets "panel".

Use with caution since "panel" MUST be a "mrpt::gui::CPanelCameraSelection *"

See also: prepareVideoSourceFromUserSelection, prepareVideoSourceFromPanel, writeConfigFromVideoSourcePanel

Definition at line 1594 of file CCameraSensor.cpp.

References ASSERT_, ASSERTMSG_, MRPT_END, MRPT_START, sect, and THROW_EXCEPTION.

◆ writeConfigFromVideoSourcePanel()

void mrpt::hwdrivers::writeConfigFromVideoSourcePanel	(	void *	panel,
		const std::string &	in_cfgfile_section_name,
		mrpt::config::CConfigFileBase *	out_cfgfile
	)

Parse the user options in the wxWidgets "panel" and write the configuration into the given section of the given configuration file.