Main MRPT website > C++ reference for MRPT 1.5.0
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
mrpt::hwdrivers::CKinect Class Referenceabstract

Detailed Description

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

To use Kinect for Windows or ASUS/Primesense RGBD cameras, use the class COpenNI2.

Configuration and usage:


Data is returned as observations of type mrpt::obs::CObservation3DRangeScan (and mrpt::obs::CObservationIMU for accelerometers data). See those classes for documentation on their fields.

As with any other CGenericSensor class, the normal sequence of methods to be called is:

Calibration parameters


For an accurate transformation of depth images to 3D points, you'll have to calibrate your Kinect, and supply the following threee pieces of information (default calibration data will be used otherwise, but they'll be not optimal for all sensors!):

See http://www.mrpt.org/Kinect_calibration for a procedure to calibrate Kinect sensors with an interactive GUI program.

Coordinates convention


The origin of coordinates is the focal point of the depth camera, with the axes oriented as in the diagram shown in mrpt::obs::CObservation3DRangeScan. Notice in that picture that the RGB camera is assumed to have axes as usual in computer vision, which differ from those for the depth camera.

The X,Y,Z axes used to report the data from accelerometers coincide with those of the depth camera (e.g. the camera standing on a table would have an ACC_Z=-9.8m/s2).

Notice however that, for consistency with stereo cameras, when loading the calibration parameters from a configuration file, the left-to-right pose increment is expected as if both RGB & IR cameras had their +Z axes pointing forward, +X to the right, +Y downwards (just like it's the standard in stereo cameras and in computer vision literature). In other words: the pose stored in this class uses a different axes convention for the depth camera than in a stereo camera, so when a pose L2R is loaded from a calibration file it's actually converted like:

L2R(this class convention) = CPose3D(0,0,0,-90deg,0deg,-90deg) (+) L2R(in the config file)

Some general comments


Converting to 3D point cloud


You can convert the 3D observation into a 3D point cloud with this piece of code:

pntsMap.colorScheme.scheme = CColouredPointsMap::cmFromIntensityImage;
pntsMap.loadFromRangeScan(obs3D);

Then the point cloud mrpt::maps::CColouredPointsMap can be converted into an OpenGL object for rendering with mrpt::maps::CMetricMap::getAs3DObject() or alternatively with:

mrpt::opengl::CPointCloudColouredPtr gl_points = mrpt::opengl::CPointCloudColoured::Create();
gl_points->loadFromPointsMap(&pntsMap);

Raw depth to range conversion


At construction, this class builds an internal array for converting raw 10 or 11bit depths into ranges in meters. Users can read that array or modify it (if you have a better calibration, for example) by calling CKinect::getRawDepth2RangeConversion(). If you replace it, remember to set the first and last entries (index 0 and KINECT_RANGES_TABLE_LEN-1) to zero, to indicate that those are invalid ranges.


R(d) = k3 * tan(d/k2 + k1);
k1 = 1.1863, k2 = 2842.5, k3 = 0.1236

Platform-specific comments


For more details, refer to libfreenect documentation:

Format of parameters for loading from a .ini file


PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
-------------------------------------------------------
[supplied_section_name]
sensorLabel = KINECT // A text description
preview_window = false // Show a window with a preview of the grabbed data in real-time
device_number = 0 // Device index to open (0:first Kinect, 1:second Kinect,...)
grab_image = true // Grab the RGB image channel? (Default=true)
grab_depth = true // Grab the depth channel? (Default=true)
grab_3D_points = true // Grab the 3D point cloud? (Default=true) If disabled, points can be generated later on.
grab_IMU = true // Grab the accelerometers? (Default=true)
video_channel = VIDEO_CHANNEL_RGB // Optional. Can be: VIDEO_CHANNEL_RGB (default) or VIDEO_CHANNEL_IR
pose_x=0 // Camera position in the robot (meters)
pose_y=0
pose_z=0
pose_yaw=0 // Angles in degrees
pose_pitch=0
pose_roll=0
// Optional: Set the initial tilt angle of Kinect: upon initialization, the motor is sent a command to
// rotate to this angle (in degrees). Note: You must be aware of the tilt when interpreting the sensor readings.
// If not present or set to "360", no motor command will be sent at start up.
initial_tilt_angle = 0
// Kinect sensor calibration:
// See http://www.mrpt.org/Kinect_and_MRPT
// Left/Depth camera
[supplied_section_name_LEFT]
rawlog-grabber-ignore = true // Instructs rawlog-grabber to ignore this section (it is not a separate device!)
resolution = [640 488]
cx = 314.649173
cy = 240.160459
fx = 572.882768
fy = 542.739980
dist = [-4.747169e-03 -4.357976e-03 0.000000e+00 0.000000e+00 0.000000e+00] // The order is: [K1 K2 T1 T2 K3]
// Right/RGB camera
[supplied_section_name_RIGHT]
rawlog-grabber-ignore = true // Instructs rawlog-grabber to ignore this section (it is not a separate device!)
resolution = [640 480]
cx = 322.515987
cy = 259.055966
fx = 521.179233
fy = 493.033034
dist = [5.858325e-02 3.856792e-02 0.000000e+00 0.000000e+00 0.000000e+00] // The order is: [K1 K2 T1 T2 K3]
// Relative pose of the right camera wrt to the left camera:
// This assumes that both camera frames are such that +Z points
// forwards, and +X and +Y to the right and downwards.
// For the actual coordinates employed in 3D observations, see figure in mrpt::obs::CObservation3DRangeScan
[supplied_section_name_LEFT2RIGHT_POSE]
rawlog-grabber-ignore = true // Instructs rawlog-grabber to ignore this section (it is not a separate device!)
pose_quaternion = [0.025575 -0.000609 -0.001462 0.999987 0.002038 0.004335 -0.001693]

More references to read:

Definition at line 207 of file CKinect.h.

#include <mrpt/hwdrivers/CKinect.h>

Inheritance diagram for mrpt::hwdrivers::CKinect:
Inheritance graph
[legend]
Collaboration diagram for mrpt::hwdrivers::CKinect:
Collaboration graph
[legend]

Public Types

enum  TVideoChannel { VIDEO_CHANNEL_RGB =0, VIDEO_CHANNEL_IR }
 RGB or IR video channel identifiers. More...
 
typedef float TDepth2RangeArray[KINECT_RANGES_TABLE_LEN]
 A typedef for an array that converts raw depth to ranges in meters. More...
 
enum  TSensorState { ssInitializing = 0, ssWorking, ssError }
 The current state of the sensor. More...
 
typedef std::multimap< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > TListObservations
 
typedef std::pair< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > TListObsPair
 

Public Member Functions

 CKinect ()
 Default ctor. More...
 
 ~CKinect ()
 Default ctor. More...
 
virtual void initialize ()
 Initializes the 3D camera - should be invoked after calling loadConfig() or setting the different parameters with the set*() methods. More...
 
virtual void doProcess ()
 To be called at a high rate (>XX Hz), this method populates the internal buffer of received observations. More...
 
void getNextObservation (mrpt::obs::CObservation3DRangeScan &out_obs, bool &there_is_obs, bool &hardware_error)
 The main data retrieving function, to be called after calling loadConfig() and initialize(). More...
 
void getNextObservation (mrpt::obs::CObservation3DRangeScan &out_obs, mrpt::obs::CObservationIMU &out_obs_imu, bool &there_is_obs, bool &hardware_error)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void setPathForExternalImages (const std::string &directory)
 Set the path where to save off-rawlog image files (this class DOES take into account this path). More...
 
virtual const mrpt::hwdrivers::TSensorClassIdGetRuntimeClass () const =0
 
TSensorState getState () const
 The current state of the sensor. More...
 
double getProcessRate () const
 
std::string getSensorLabel () const
 
void setSensorLabel (const std::string &sensorLabel)
 
void enableVerbose (bool enabled=true)
 Enable or disable extra debug info dumped to std::cout during sensor operation. More...
 
bool isVerboseEnabled () const
 
void loadConfig (const mrpt::utils::CConfigFileBase &configSource, const std::string &section)
 Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensorSpecific"

Exceptions
Thismethod throws an exception with a descriptive message if some critical parameter is missing or has an invalid value.
More...
 
void getObservations (TListObservations &lstObjects)
 Returns a list of enqueued objects, emptying it (thread-safe). More...
 
void setExternalImageFormat (const std::string &ext)
 Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg". More...
 
void setExternalImageJPEGQuality (const unsigned int quality)
 The quality of JPEG compression, when external images is enabled and the format is "jpg". More...
 
unsigned int getExternalImageJPEGQuality () const
 
Sensor parameters (alternative to \a loadConfig ) and manual control
void open ()
 Try to open the camera (set all the parameters before calling this) - users may also call initialize(), which in turn calls this method. More...
 
bool isOpen () const
 Whether there is a working connection to the sensor. More...
 
void close ()
 Close the conection to the sensor (not need to call it manually unless desired for some reason, since it's called at destructor) More...
 
void setVideoChannel (const TVideoChannel vch)
 Changes the video channel to open (RGB or IR) - you can call this method before start grabbing or in the middle of streaming and the video source will change on the fly. More...
 
TVideoChannel getVideoChannel () const
 Return the current video channel (RGB or IR) More...
 
void setDeviceIndexToOpen (int index)
 Set the sensor index to open (if there're several sensors attached to the computer); default=0 -> the first one. More...
 
int getDeviceIndexToOpen () const
 
void setTiltAngleDegrees (double angle)
 Change tilt angle. More...
 
double getTiltAngleDegrees ()
 
void enablePreviewRGB (bool enable=true)
 Default: disabled. More...
 
void disablePreviewRGB ()
 
bool isPreviewRGBEnabled () const
 
void setPreviewDecimation (size_t decimation_factor)
 If preview is enabled, show only one image out of N (default: 1=show all) More...
 
size_t getPreviewDecimation () const
 
double getMaxRange () const
 Get the maximum range (meters) that can be read in the observation field "rangeImage". More...
 
size_t getRowCount () const
 Get the row count in the camera images, loaded automatically upon camera open(). More...
 
size_t getColCount () const
 Get the col count in the camera images, loaded automatically upon camera open(). More...
 
const mrpt::utils::TCameragetCameraParamsIntensity () const
 Get a const reference to the depth camera calibration parameters. More...
 
void setCameraParamsIntensity (const mrpt::utils::TCamera &p)
 
const mrpt::utils::TCameragetCameraParamsDepth () const
 Get a const reference to the depth camera calibration parameters. More...
 
void setCameraParamsDepth (const mrpt::utils::TCamera &p)
 
void setRelativePoseIntensityWrtDepth (const mrpt::poses::CPose3D &p)
 Set the pose of the intensity camera wrt the depth camera. More...
 
const mrpt::poses::CPose3DgetRelativePoseIntensityWrtDepth () const
 
TDepth2RangeArraygetRawDepth2RangeConversion ()
 Get a reference to the array that convert raw depth values (10 or 11 bit) into ranges in meters, so it can be read or replaced by the user. More...
 
const TDepth2RangeArraygetRawDepth2RangeConversion () const
 
void enableGrabRGB (bool enable=true)
 Enable/disable the grabbing of the RGB channel. More...
 
bool isGrabRGBEnabled () const
 
void enableGrabDepth (bool enable=true)
 Enable/disable the grabbing of the depth channel. More...
 
bool isGrabDepthEnabled () const
 
void enableGrabAccelerometers (bool enable=true)
 Enable/disable the grabbing of the inertial data. More...
 
bool isGrabAccelerometersEnabled () const
 
void enableGrab3DPoints (bool enable=true)
 Enable/disable the grabbing of the 3D point clouds. More...
 
bool isGrab3DPointsEnabled () const
 

Static Public Member Functions

static void registerClass (const TSensorClassId *pNewClass)
 Register a class into the internal list of "CGenericSensor" descendents. More...
 
static CGenericSensorcreateSensor (const std::string &className)
 Creates a sensor by a name of the class. More...
 
static CGenericSensorPtr createSensorPtr (const std::string &className)
 Just like createSensor, but returning a smart pointer to the newly created sensor object. More...
 

Protected Member Functions

virtual void loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &section)
 See the class documentation at the top for expected parameters. More...
 
void appendObservations (const std::vector< mrpt::utils::CSerializablePtr > &obj)
 This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations. More...
 
void appendObservation (const mrpt::utils::CSerializablePtr &obj)
 Like appendObservations() but for just one observation. More...
 

Protected Attributes

mrpt::poses::CPose3D m_sensorPoseOnRobot
 
bool m_preview_window
 Show preview window while grabbing. More...
 
size_t m_preview_window_decimation
 If preview is enabled, only show 1 out of N images. More...
 
size_t m_preview_decim_counter_range
 
size_t m_preview_decim_counter_rgb
 
mrpt::gui::CDisplayWindowPtr m_win_range
 
mrpt::gui::CDisplayWindowPtr m_win_int
 
mrpt::utils::TCamera m_cameraParamsRGB
 Params for the RGB camera. More...
 
mrpt::utils::TCamera m_cameraParamsDepth
 Params for the Depth camera. More...
 
mrpt::poses::CPose3D m_relativePoseIntensityWRTDepth
 See mrpt::obs::CObservation3DRangeScan for a diagram of this pose. More...
 
int m_initial_tilt_angle
 Set Kinect tilt to an initial deegre (it should be take in account in the sensor pose by the user) More...
 
double m_maxRange
 Sensor max range (meters) More...
 
int m_user_device_number
 Number of device to open (0:first,...) More...
 
bool m_grab_image
 
bool m_grab_depth
 
bool m_grab_3D_points
 
bool m_grab_IMU
 Default: all true. More...
 
TVideoChannel m_video_channel
 The video channel to open: RGB or IR. More...
 
size_t m_grab_decimation_counter
 Used when "m_grab_decimation" is enabled. More...
 
TSensorState m_state
 
bool m_verbose
 
std::string m_path_for_external_images
 The path where to save off-rawlog images: empty means save images embedded in the rawlog. More...
 
std::string m_external_images_format
 The extension ("jpg","gif","png",...) that determines the format of images saved externally. More...
 
unsigned int m_external_images_jpeg_quality
 For JPEG images, the quality (default=95%). More...
 
Common settings to any sensor, loaded in "loadConfig"
double m_process_rate
 See CGenericSensor. More...
 
size_t m_max_queue_len
 See CGenericSensor. More...
 
size_t m_grab_decimation
 If set to N>=2, only 1 out of N observations will be saved to m_objList. More...
 
std::string m_sensorLabel
 See CGenericSensor. More...
 

Private Member Functions

void calculate_range2meters ()
 Compute m_range2meters at construction. More...
 

Private Attributes

std::vector< uint8_t > m_buf_depth
 
std::vector< uint8_t > m_buf_rgb
 Temporary buffers for image grabbing. More...
 
TDepth2RangeArray m_range2meters
 The table raw depth -> range in meters. More...
 

Member Typedef Documentation

typedef float mrpt::hwdrivers::CKinect::TDepth2RangeArray[KINECT_RANGES_TABLE_LEN]

A typedef for an array that converts raw depth to ranges in meters.

Definition at line 212 of file CKinect.h.

typedef std::multimap< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > mrpt::hwdrivers::CGenericSensor::TListObservations
inherited

Definition at line 68 of file CGenericSensor.h.

typedef std::pair< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > mrpt::hwdrivers::CGenericSensor::TListObsPair
inherited

Definition at line 69 of file CGenericSensor.h.

Member Enumeration Documentation

The current state of the sensor.

See also
CGenericSensor::getState
Enumerator
ssInitializing 
ssWorking 
ssError 

Definition at line 74 of file CGenericSensor.h.

RGB or IR video channel identifiers.

See also
setVideoChannel
Enumerator
VIDEO_CHANNEL_RGB 
VIDEO_CHANNEL_IR 

Definition at line 215 of file CKinect.h.

Constructor & Destructor Documentation

mrpt::hwdrivers::CKinect::CKinect ( )

Default ctor.

mrpt::hwdrivers::CKinect::~CKinect ( )

Default ctor.

Member Function Documentation

void mrpt::hwdrivers::CGenericSensor::appendObservation ( const mrpt::utils::CSerializablePtr &  obj)
inlineprotectedinherited

Like appendObservations() but for just one observation.

Definition at line 146 of file CGenericSensor.h.

void mrpt::hwdrivers::CGenericSensor::appendObservations ( const std::vector< mrpt::utils::CSerializablePtr > &  obj)
protectedinherited

This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations.

Passed objects must be created in dynamic memory and a smart pointer passed. Example of creation:

mrpt::obs::CObservationGPSPtr o = CObservationGPSPtr( new CObservationGPS() );
o-> .... // Set data

If several observations are passed at once in the vector, they'll be considered as a block regarding the grabbing decimation factor.

void mrpt::hwdrivers::CKinect::calculate_range2meters ( )
private

Compute m_range2meters at construction.

void mrpt::hwdrivers::CKinect::close ( )

Close the conection to the sensor (not need to call it manually unless desired for some reason, since it's called at destructor)

static CGenericSensor* mrpt::hwdrivers::CGenericSensor::createSensor ( const std::string &  className)
staticinherited

Creates a sensor by a name of the class.

Typically the user may want to create a smart pointer around the returned pointer, whis is made with:

Returns
A pointer to a new class, or NULL if class name is unknown.
static CGenericSensorPtr mrpt::hwdrivers::CGenericSensor::createSensorPtr ( const std::string &  className)
inlinestaticinherited

Just like createSensor, but returning a smart pointer to the newly created sensor object.

Definition at line 179 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor.

void mrpt::hwdrivers::CKinect::disablePreviewRGB ( )
inline

Definition at line 295 of file CKinect.h.

virtual void mrpt::hwdrivers::CKinect::doProcess ( )
virtual

To be called at a high rate (>XX Hz), this method populates the internal buffer of received observations.

This method is mainly intended for usage within rawlog-grabber or similar programs. For an alternative, see getNextObservation()

Exceptions
Thismethod must throw an exception with a descriptive message if some critical error is found.
See also
getNextObservation

Implements mrpt::hwdrivers::CGenericSensor.

void mrpt::hwdrivers::CKinect::enableGrab3DPoints ( bool  enable = true)
inline

Enable/disable the grabbing of the 3D point clouds.

Definition at line 341 of file CKinect.h.

void mrpt::hwdrivers::CKinect::enableGrabAccelerometers ( bool  enable = true)
inline

Enable/disable the grabbing of the inertial data.

Definition at line 337 of file CKinect.h.

void mrpt::hwdrivers::CKinect::enableGrabDepth ( bool  enable = true)
inline

Enable/disable the grabbing of the depth channel.

Definition at line 333 of file CKinect.h.

void mrpt::hwdrivers::CKinect::enableGrabRGB ( bool  enable = true)
inline

Enable/disable the grabbing of the RGB channel.

Definition at line 329 of file CKinect.h.

void mrpt::hwdrivers::CKinect::enablePreviewRGB ( bool  enable = true)
inline

Default: disabled.

Definition at line 294 of file CKinect.h.

void mrpt::hwdrivers::CGenericSensor::enableVerbose ( bool  enabled = true)
inlineinherited

Enable or disable extra debug info dumped to std::cout during sensor operation.

Default: disabled unless the environment variable "MRPT_HWDRIVERS_VERBOSE" is set to "1" during object creation.

Definition at line 92 of file CGenericSensor.h.

const mrpt::utils::TCamera& mrpt::hwdrivers::CKinect::getCameraParamsDepth ( ) const
inline

Get a const reference to the depth camera calibration parameters.

Definition at line 315 of file CKinect.h.

const mrpt::utils::TCamera& mrpt::hwdrivers::CKinect::getCameraParamsIntensity ( ) const
inline

Get a const reference to the depth camera calibration parameters.

Definition at line 311 of file CKinect.h.

size_t mrpt::hwdrivers::CKinect::getColCount ( ) const
inline

Get the col count in the camera images, loaded automatically upon camera open().

Definition at line 308 of file CKinect.h.

int mrpt::hwdrivers::CKinect::getDeviceIndexToOpen ( ) const
inline

Definition at line 287 of file CKinect.h.

unsigned int mrpt::hwdrivers::CGenericSensor::getExternalImageJPEGQuality ( ) const
inlineinherited

Definition at line 233 of file CGenericSensor.h.

References MRPT_MAKE_ALIGNED_OPERATOR_NEW.

double mrpt::hwdrivers::CKinect::getMaxRange ( ) const
inline

Get the maximum range (meters) that can be read in the observation field "rangeImage".

Definition at line 303 of file CKinect.h.

void mrpt::hwdrivers::CKinect::getNextObservation ( mrpt::obs::CObservation3DRangeScan out_obs,
bool &  there_is_obs,
bool &  hardware_error 
)

The main data retrieving function, to be called after calling loadConfig() and initialize().

Parameters
out_obsThe output retrieved observation (only if there_is_obs=true).
there_is_obsIf set to false, there was no new observation.
hardware_errorTrue on hardware/comms error.
See also
doProcess
void mrpt::hwdrivers::CKinect::getNextObservation ( mrpt::obs::CObservation3DRangeScan out_obs,
mrpt::obs::CObservationIMU out_obs_imu,
bool &  there_is_obs,
bool &  hardware_error 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Note
This method also grabs data from the accelerometers, returning them in out_obs_imu
void mrpt::hwdrivers::CGenericSensor::getObservations ( TListObservations lstObjects)
inherited

Returns a list of enqueued objects, emptying it (thread-safe).

The objects must be freed by the invoker.

size_t mrpt::hwdrivers::CKinect::getPreviewDecimation ( ) const
inline

Definition at line 300 of file CKinect.h.

double mrpt::hwdrivers::CGenericSensor::getProcessRate ( ) const
inlineinherited

Definition at line 84 of file CGenericSensor.h.

TDepth2RangeArray& mrpt::hwdrivers::CKinect::getRawDepth2RangeConversion ( )
inline

Get a reference to the array that convert raw depth values (10 or 11 bit) into ranges in meters, so it can be read or replaced by the user.

If you replace it, remember to set the first and last entries (index 0 and KINECT_RANGES_TABLE_LEN-1) to zero, to indicate that those are invalid ranges.

Definition at line 325 of file CKinect.h.

const TDepth2RangeArray& mrpt::hwdrivers::CKinect::getRawDepth2RangeConversion ( ) const
inline

Definition at line 326 of file CKinect.h.

const mrpt::poses::CPose3D& mrpt::hwdrivers::CKinect::getRelativePoseIntensityWrtDepth ( ) const
inline

Definition at line 320 of file CKinect.h.

size_t mrpt::hwdrivers::CKinect::getRowCount ( ) const
inline

Get the row count in the camera images, loaded automatically upon camera open().

Definition at line 306 of file CKinect.h.

virtual const mrpt::hwdrivers::TSensorClassId* mrpt::hwdrivers::CGenericSensor::GetRuntimeClass ( ) const
pure virtualinherited
std::string mrpt::hwdrivers::CGenericSensor::getSensorLabel ( ) const
inlineinherited

Definition at line 86 of file CGenericSensor.h.

TSensorState mrpt::hwdrivers::CGenericSensor::getState ( ) const
inlineinherited

The current state of the sensor.

Definition at line 82 of file CGenericSensor.h.

double mrpt::hwdrivers::CKinect::getTiltAngleDegrees ( )
TVideoChannel mrpt::hwdrivers::CKinect::getVideoChannel ( ) const
inline

Return the current video channel (RGB or IR)

See also
setVideoChannel

Definition at line 283 of file CKinect.h.

virtual void mrpt::hwdrivers::CKinect::initialize ( )
virtual

Initializes the 3D camera - should be invoked after calling loadConfig() or setting the different parameters with the set*() methods.

Exceptions
Thismethod must throw an exception with a descriptive message if some critical error is found.

Reimplemented from mrpt::hwdrivers::CGenericSensor.

bool mrpt::hwdrivers::CKinect::isGrab3DPointsEnabled ( ) const
inline

Definition at line 342 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::isGrabAccelerometersEnabled ( ) const
inline

Definition at line 338 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::isGrabDepthEnabled ( ) const
inline

Definition at line 334 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::isGrabRGBEnabled ( ) const
inline

Definition at line 330 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::isOpen ( ) const

Whether there is a working connection to the sensor.

bool mrpt::hwdrivers::CKinect::isPreviewRGBEnabled ( ) const
inline

Definition at line 296 of file CKinect.h.

bool mrpt::hwdrivers::CGenericSensor::isVerboseEnabled ( ) const
inlineinherited

Definition at line 93 of file CGenericSensor.h.

References mrpt::utils::registerClass().

void mrpt::hwdrivers::CGenericSensor::loadConfig ( const mrpt::utils::CConfigFileBase configSource,
const std::string &  section 
)
inherited

Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensorSpecific"

Exceptions
Thismethod throws an exception with a descriptive message if some critical parameter is missing or has an invalid value.

virtual void mrpt::hwdrivers::CKinect::loadConfig_sensorSpecific ( const mrpt::utils::CConfigFileBase configSource,
const std::string &  section 
)
protectedvirtual

See the class documentation at the top for expected parameters.

Implements mrpt::hwdrivers::CGenericSensor.

void mrpt::hwdrivers::CKinect::open ( )

Try to open the camera (set all the parameters before calling this) - users may also call initialize(), which in turn calls this method.

Raises an exception upon error.

Exceptions
std::exceptionA textual description of the error.
static void mrpt::hwdrivers::CGenericSensor::registerClass ( const TSensorClassId pNewClass)
staticinherited

Register a class into the internal list of "CGenericSensor" descendents.

Used internally in the macros DEFINE_GENERIC_SENSOR, etc...

Can be used as "CGenericSensor::registerClass( SENSOR_CLASS_ID(CMySensor) );" if building custom sensors outside mrpt libraries in user code.

Referenced by mrpt::hwdrivers::CGenericSensor::CLASSINIT_GENERIC_SENSOR::CLASSINIT_GENERIC_SENSOR().

void mrpt::hwdrivers::CKinect::setCameraParamsDepth ( const mrpt::utils::TCamera p)
inline

Definition at line 316 of file CKinect.h.

void mrpt::hwdrivers::CKinect::setCameraParamsIntensity ( const mrpt::utils::TCamera p)
inline

Definition at line 312 of file CKinect.h.

void mrpt::hwdrivers::CKinect::setDeviceIndexToOpen ( int  index)
inline

Set the sensor index to open (if there're several sensors attached to the computer); default=0 -> the first one.

Definition at line 286 of file CKinect.h.

void mrpt::hwdrivers::CGenericSensor::setExternalImageFormat ( const std::string &  ext)
inlineinherited

Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg".

See also
setPathForExternalImages, setExternalImageJPEGQuality

Definition at line 225 of file CGenericSensor.h.

void mrpt::hwdrivers::CGenericSensor::setExternalImageJPEGQuality ( const unsigned int  quality)
inlineinherited

The quality of JPEG compression, when external images is enabled and the format is "jpg".

See also
setExternalImageFormat

Definition at line 230 of file CGenericSensor.h.

virtual void mrpt::hwdrivers::CKinect::setPathForExternalImages ( const std::string &  directory)
virtual

Set the path where to save off-rawlog image files (this class DOES take into account this path).

An empty string (the default value at construction) means to save images embedded in the rawlog, instead of on separate files.

Exceptions
std::exceptionIf the directory doesn't exists and cannot be created.

Reimplemented from mrpt::hwdrivers::CGenericSensor.

void mrpt::hwdrivers::CKinect::setPreviewDecimation ( size_t  decimation_factor)
inline

If preview is enabled, show only one image out of N (default: 1=show all)

Definition at line 299 of file CKinect.h.

void mrpt::hwdrivers::CKinect::setRelativePoseIntensityWrtDepth ( const mrpt::poses::CPose3D p)
inline

Set the pose of the intensity camera wrt the depth camera.

See also
See mrpt::obs::CObservation3DRangeScan for a 3D diagram of this pose

Definition at line 319 of file CKinect.h.

void mrpt::hwdrivers::CGenericSensor::setSensorLabel ( const std::string &  sensorLabel)
inlineinherited

Definition at line 87 of file CGenericSensor.h.

void mrpt::hwdrivers::CKinect::setTiltAngleDegrees ( double  angle)

Change tilt angle.

Note
Sensor must be open first.
void mrpt::hwdrivers::CKinect::setVideoChannel ( const TVideoChannel  vch)

Changes the video channel to open (RGB or IR) - you can call this method before start grabbing or in the middle of streaming and the video source will change on the fly.

Default is RGB channel.

Member Data Documentation

std::vector<uint8_t> mrpt::hwdrivers::CKinect::m_buf_depth
private

Definition at line 394 of file CKinect.h.

std::vector<uint8_t> mrpt::hwdrivers::CKinect::m_buf_rgb
private

Temporary buffers for image grabbing.

Definition at line 394 of file CKinect.h.

mrpt::utils::TCamera mrpt::hwdrivers::CKinect::m_cameraParamsDepth
protected

Params for the Depth camera.

Definition at line 380 of file CKinect.h.

mrpt::utils::TCamera mrpt::hwdrivers::CKinect::m_cameraParamsRGB
protected

Params for the RGB camera.

Definition at line 379 of file CKinect.h.

std::string mrpt::hwdrivers::CGenericSensor::m_external_images_format
protectedinherited

The extension ("jpg","gif","png",...) that determines the format of images saved externally.

See also
setPathForExternalImages

Definition at line 130 of file CGenericSensor.h.

unsigned int mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality
protectedinherited

For JPEG images, the quality (default=95%).

Definition at line 131 of file CGenericSensor.h.

bool mrpt::hwdrivers::CKinect::m_grab_3D_points
protected

Definition at line 389 of file CKinect.h.

size_t mrpt::hwdrivers::CGenericSensor::m_grab_decimation
protectedinherited

If set to N>=2, only 1 out of N observations will be saved to m_objList.

Definition at line 117 of file CGenericSensor.h.

size_t mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter
protectedinherited

Used when "m_grab_decimation" is enabled.

Definition at line 122 of file CGenericSensor.h.

bool mrpt::hwdrivers::CKinect::m_grab_depth
protected

Definition at line 389 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::m_grab_image
protected

Definition at line 389 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::m_grab_IMU
protected

Default: all true.

Definition at line 389 of file CKinect.h.

int mrpt::hwdrivers::CKinect::m_initial_tilt_angle
protected

Set Kinect tilt to an initial deegre (it should be take in account in the sensor pose by the user)

Definition at line 383 of file CKinect.h.

size_t mrpt::hwdrivers::CGenericSensor::m_max_queue_len
protectedinherited

See CGenericSensor.

Definition at line 116 of file CGenericSensor.h.

double mrpt::hwdrivers::CKinect::m_maxRange
protected

Sensor max range (meters)

Definition at line 385 of file CKinect.h.

std::string mrpt::hwdrivers::CGenericSensor::m_path_for_external_images
protectedinherited

The path where to save off-rawlog images: empty means save images embedded in the rawlog.

Definition at line 129 of file CGenericSensor.h.

size_t mrpt::hwdrivers::CKinect::m_preview_decim_counter_range
protected

Definition at line 366 of file CKinect.h.

size_t mrpt::hwdrivers::CKinect::m_preview_decim_counter_rgb
protected

Definition at line 366 of file CKinect.h.

bool mrpt::hwdrivers::CKinect::m_preview_window
protected

Show preview window while grabbing.

Definition at line 364 of file CKinect.h.

size_t mrpt::hwdrivers::CKinect::m_preview_window_decimation
protected

If preview is enabled, only show 1 out of N images.

Definition at line 365 of file CKinect.h.

double mrpt::hwdrivers::CGenericSensor::m_process_rate
protectedinherited

See CGenericSensor.

Definition at line 115 of file CGenericSensor.h.

TDepth2RangeArray mrpt::hwdrivers::CKinect::m_range2meters
private

The table raw depth -> range in meters.

Definition at line 395 of file CKinect.h.

mrpt::poses::CPose3D mrpt::hwdrivers::CKinect::m_relativePoseIntensityWRTDepth
protected

See mrpt::obs::CObservation3DRangeScan for a diagram of this pose.

Definition at line 381 of file CKinect.h.

std::string mrpt::hwdrivers::CGenericSensor::m_sensorLabel
protectedinherited

See CGenericSensor.

Definition at line 118 of file CGenericSensor.h.

mrpt::poses::CPose3D mrpt::hwdrivers::CKinect::m_sensorPoseOnRobot
protected

Definition at line 362 of file CKinect.h.

TSensorState mrpt::hwdrivers::CGenericSensor::m_state
protectedinherited

Definition at line 124 of file CGenericSensor.h.

int mrpt::hwdrivers::CKinect::m_user_device_number
protected

Number of device to open (0:first,...)

Definition at line 387 of file CKinect.h.

bool mrpt::hwdrivers::CGenericSensor::m_verbose
protectedinherited

Definition at line 125 of file CGenericSensor.h.

TVideoChannel mrpt::hwdrivers::CKinect::m_video_channel
protected

The video channel to open: RGB or IR.

Definition at line 391 of file CKinect.h.

mrpt::gui::CDisplayWindowPtr mrpt::hwdrivers::CKinect::m_win_int
protected

Definition at line 367 of file CKinect.h.

mrpt::gui::CDisplayWindowPtr mrpt::hwdrivers::CKinect::m_win_range
protected

Definition at line 367 of file CKinect.h.




Page generated by Doxygen 1.8.11 for MRPT 1.5.0 Git: 23811f3 Mon Apr 24 03:24:28 2017 +0200 at Tue Apr 25 00:00:31 CEST 2017