Observation class for either a pair of left+right or left+disparity images from a stereo camera.
To find whether the observation contains a right image and/or a disparity image, see the fields hasImageDisparity and hasImageRight, respectively.
This figure illustrates the coordinate frames involved in this class:
<center>
Definition at line 41 of file obs/CObservationStereoImages.h.
#include <mrpt/obs/CObservationStereoImages.h>
Public Member Functions | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) throw () |
void | operator delete[] (void *ptr) throw () |
void | operator delete (void *memory, void *ptr) throw () |
void * | operator new (size_t size, const std::nothrow_t &) throw () |
void | operator delete (void *ptr, const std::nothrow_t &) throw () |
CObservationStereoImages () | |
Default Constructor. More... | |
CObservationStereoImages (void *iplImageLeft, void *iplImageRight, void *iplImageDisparity=NULL, bool ownMemory=false) | |
Constructor from "IplImage*" images, which could be NULL. More... | |
~CObservationStereoImages () | |
Destructor. More... | |
void | getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const |
A general method to retrieve the sensor pose on the robot. More... | |
void | setSensorPose (const mrpt::poses::CPose3D &newSensorPose) |
A general method to change the sensor pose on the robot. More... | |
virtual void | getDescriptionAsText (std::ostream &o) const |
Build a detailed, multi-line textual description of the observation contents and dump it to the output stream. More... | |
void | swap (CObservationStereoImages &o) |
Do an efficient swap of all data members of this object with "o". More... | |
template<class METRICMAP > | |
bool | insertObservationInto (METRICMAP *theMap, const mrpt::poses::CPose3D *robotPose=NULL) const |
This method is equivalent to: More... | |
void | getSensorPose (mrpt::math::TPose3D &out_sensorPose) const |
A general method to retrieve the sensor pose on the robot. More... | |
void | setSensorPose (const mrpt::math::TPose3D &newSensorPose) |
A general method to change the sensor pose on the robot. More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
mrpt::utils::CObjectPtr | duplicateGetSmartPtr () const |
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |
CObject * | clone () const |
Cloning interface for smart pointers. More... | |
Delayed-load manual control methods. | |
virtual void | load () const |
Makes sure all images and other fields which may be externally stored are loaded in memory. More... | |
virtual void | unload () |
Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect). More... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Public Attributes | |
Data common to any observation | |
mrpt::system::TTimeStamp | timestamp |
The associated time-stamp. More... | |
std::string | sensorLabel |
An arbitrary label that can be used to identify the sensor. More... | |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCObservation |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
Protected Member Functions | |
void | swap (CObservation &o) |
Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data. More... | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More... | |
RTTI stuff | |
typedef CObservationStereoImagesPtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CObservationStereoImages |
static mrpt::utils::TRuntimeClassId | classCObservationStereoImages |
static const mrpt::utils::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CObservationStereoImagesPtr | Create () |
Main observation data members | |
mrpt::utils::CImage | imageLeft |
Image from the left camera (this image will be ALWAYS present) More... | |
mrpt::utils::CImage | imageRight |
Image from the right camera, only contains a valid image if hasImageRight == true. More... | |
mrpt::utils::CImage | imageDisparity |
Disparity image, only contains a valid image if hasImageDisparity == true. More... | |
bool | hasImageDisparity |
Whether imageDisparity actually contains data (Default upon construction: false) More... | |
bool | hasImageRight |
Whether imageRight actually contains data (Default upon construction: true) More... | |
mrpt::utils::TCamera | leftCamera |
Parameters for the left/right cameras: individual intrinsic and distortion parameters of the cameras. More... | |
mrpt::utils::TCamera | rightCamera |
mrpt::poses::CPose3DQuat | cameraPose |
The pose of the LEFT camera, relative to the robot. More... | |
mrpt::poses::CPose3DQuat | rightCameraPose |
The pose of the right camera, relative to the left one: Note that using the conventional reference coordinates for the left camera (x points to the right, y down), the "right" camera is situated at position (BL, 0, 0) with yaw=pitch=roll=0, where BL is the BASELINE. More... | |
void | getStereoCameraParams (mrpt::utils::TStereoCamera &out_params) const |
Populates a TStereoCamera structure with the parameters in leftCamera, rightCamera and rightCameraPose. More... | |
void | setStereoCameraParams (const mrpt::utils::TStereoCamera &in_params) |
Sets leftCamera, rightCamera and rightCameraPose from a TStereoCamera structure. More... | |
bool | areImagesRectified () const |
This method only checks whether ALL the distortion parameters in leftCamera are set to zero, which is the convention in MRPT to denote that this pair of stereo images has been rectified. More... | |
typedef CObservationStereoImagesPtr mrpt::obs::CObservationStereoImages::SmartPtr |
A typedef for the associated smart pointer
Definition at line 44 of file obs/CObservationStereoImages.h.
mrpt::obs::CObservationStereoImages::CObservationStereoImages | ( | ) |
Default Constructor.
mrpt::obs::CObservationStereoImages::CObservationStereoImages | ( | void * | iplImageLeft, |
void * | iplImageRight, | ||
void * | iplImageDisparity = NULL , |
||
bool | ownMemory = false |
||
) |
Constructor from "IplImage*" images, which could be NULL.
The fields hasImageDisparity and hasImageRight will be set to true/false depending on them being !=NULL. Note that the IplImage's will be COPIED, so it's still the caller's reponsibility to free the original images, unless ownMemory is set to true: in that case the IplImage pointers are copied and those IplImage's will be automatically freed by this object.
mrpt::obs::CObservationStereoImages::~CObservationStereoImages | ( | ) |
Destructor.
|
staticprotected |
bool mrpt::obs::CObservationStereoImages::areImagesRectified | ( | ) | const |
This method only checks whether ALL the distortion parameters in leftCamera are set to zero, which is the convention in MRPT to denote that this pair of stereo images has been rectified.
|
inlineinherited |
|
static |
|
static |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
virtual |
Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.
Reimplemented from mrpt::obs::CObservation.
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::obs::CObservation.
|
inherited |
A general method to retrieve the sensor pose on the robot.
Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.
|
inlinevirtual |
A general method to retrieve the sensor pose on the robot.
Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.
Implements mrpt::obs::CObservation.
Definition at line 111 of file obs/CObservationStereoImages.h.
void mrpt::obs::CObservationStereoImages::getStereoCameraParams | ( | mrpt::utils::TStereoCamera & | out_params | ) | const |
Populates a TStereoCamera structure with the parameters in leftCamera, rightCamera and rightCameraPose.
Referenced by mrpt::vision::CStereoRectifyMap::setFromCamParams().
|
inlineinherited |
This method is equivalent to:
theMap | The map where this observation is to be inserted: the map will be updated. |
robotPose | The pose of the robot base for this observation, relative to the target metric map. Set to NULL (default) to use (0,0,0deg) |
Definition at line 91 of file obs/CObservation.h.
|
inlinevirtualinherited |
Makes sure all images and other fields which may be externally stored are loaded in memory.
Note that for all CImages, calling load() is not required since the images will be automatically loaded upon first access, so load() shouldn't be needed to be called in normal cases by the user. If all the data were alredy loaded or this object has no externally stored data fields, calling this method has no effects.
Reimplemented in mrpt::obs::CObservation3DRangeScan.
Definition at line 133 of file obs/CObservation.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inlinestatic |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
inline |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
protectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
|
inlinevirtual |
A general method to change the sensor pose on the robot.
Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.
Implements mrpt::obs::CObservation.
Definition at line 113 of file obs/CObservationStereoImages.h.
References mrpt::poses::CPose3DQuat, DECLARE_MEXPLUS_FROM, DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE, and OBS_IMPEXP.
|
inherited |
A general method to change the sensor pose on the robot.
Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.
void mrpt::obs::CObservationStereoImages::setStereoCameraParams | ( | const mrpt::utils::TStereoCamera & | in_params | ) |
Sets leftCamera, rightCamera and rightCameraPose from a TStereoCamera structure.
|
protectedinherited |
Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data.
void mrpt::obs::CObservationStereoImages::swap | ( | CObservationStereoImages & | o | ) |
Do an efficient swap of all data members of this object with "o".
|
inlinevirtualinherited |
Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).
Reimplemented in mrpt::obs::CObservation3DRangeScan.
Definition at line 137 of file obs/CObservation.h.
References DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE, and OBS_IMPEXP.
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
References BASE_IMPEXP, mrpt::utils::CSerializablePtr, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 44 of file obs/CObservationStereoImages.h.
mrpt::poses::CPose3DQuat mrpt::obs::CObservationStereoImages::cameraPose |
The pose of the LEFT camera, relative to the robot.
Definition at line 87 of file obs/CObservationStereoImages.h.
|
staticinherited |
|
staticinherited |
Definition at line 53 of file obs/CObservation.h.
|
static |
Definition at line 44 of file obs/CObservationStereoImages.h.
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 44 of file obs/CObservationStereoImages.h.
bool mrpt::obs::CObservationStereoImages::hasImageDisparity |
Whether imageDisparity actually contains data (Default upon construction: false)
Definition at line 78 of file obs/CObservationStereoImages.h.
bool mrpt::obs::CObservationStereoImages::hasImageRight |
Whether imageRight actually contains data (Default upon construction: true)
Definition at line 79 of file obs/CObservationStereoImages.h.
mrpt::utils::CImage mrpt::obs::CObservationStereoImages::imageDisparity |
Disparity image, only contains a valid image if hasImageDisparity == true.
The relation between the actual disparity and pixels and each value in this image is... ???????????
Definition at line 76 of file obs/CObservationStereoImages.h.
mrpt::utils::CImage mrpt::obs::CObservationStereoImages::imageLeft |
Image from the left camera (this image will be ALWAYS present)
Definition at line 69 of file obs/CObservationStereoImages.h.
mrpt::utils::CImage mrpt::obs::CObservationStereoImages::imageRight |
Image from the right camera, only contains a valid image if hasImageRight == true.
Definition at line 72 of file obs/CObservationStereoImages.h.
mrpt::utils::TCamera mrpt::obs::CObservationStereoImages::leftCamera |
Parameters for the left/right cameras: individual intrinsic and distortion parameters of the cameras.
See the tutorial for a discussion of these parameters.
Definition at line 85 of file obs/CObservationStereoImages.h.
mrpt::utils::TCamera mrpt::obs::CObservationStereoImages::rightCamera |
Definition at line 85 of file obs/CObservationStereoImages.h.
mrpt::poses::CPose3DQuat mrpt::obs::CObservationStereoImages::rightCameraPose |
The pose of the right camera, relative to the left one: Note that using the conventional reference coordinates for the left camera (x points to the right, y down), the "right" camera is situated at position (BL, 0, 0) with yaw=pitch=roll=0, where BL is the BASELINE.
Definition at line 94 of file obs/CObservationStereoImages.h.
|
inherited |
An arbitrary label that can be used to identify the sensor.
Definition at line 69 of file obs/CObservation.h.
|
inherited |
The associated time-stamp.
Definition at line 65 of file obs/CObservation.h.
Page generated by Doxygen 1.8.11 for MRPT 1.3.2 SVN: at Wed May 25 02:34:21 UTC 2016 |