Detailed Description

An observation of the current (cumulative) odometry for a wheeled robot.

This kind of observation will only occur in a "observation-only" rawlog file, otherwise odometry are modeled with actions. Refer to the page on rawlogs.

See also: CObservation, CActionRobotMovement2D

Definition at line 32 of file obs/CObservationOdometry.h.

#include <mrpt/obs/CObservationOdometry.h>

Inheritance diagram for mrpt::obs::CObservationOdometry:

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 ()

	CObservationOdometry ()
	Default ctor. More...

void	getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const MRPT_OVERRIDE
	A general method to retrieve the sensor pose on the robot. More...

void	setSensorPose (const mrpt::poses::CPose3D &) MRPT_OVERRIDE
	A general method to change the sensor pose on the robot. More...

void	getDescriptionAsText (std::ostream &o) const MRPT_OVERRIDE
	Build a detailed, multi-line textual description of the observation contents and dump it to the output stream. 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...

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...

RTTI classes and functions
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...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
mrpt::poses::CPose2D	odometry
	The absolute odometry measurement (IT IS NOT INCREMENTAL) More...

bool	hasEncodersInfo
	"true" means that "encoderLeftTicks" and "encoderRightTicks" contain valid values. More...

int32_t	encoderLeftTicks
	For differential-driven robots: The ticks count for each wheel in ABSOLUTE VALUE (IT IS NOT INCREMENTAL) (positive means FORWARD, for both wheels);. More...

int32_t	encoderRightTicks

bool	hasVelocities
	"true" means that `velocityLocal` contains valid values. More...

mrpt::math::TTwist2D	velocityLocal
	Velocity, in the robot (local) frame of reference (+X=forward). 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...

Data common to any observation
mrpt::system::TTimeStamp	timestamp
	The associated UTC time-stamp. Where available, this should contain the accurate satellite-based timestamp of the sensor reading. More...

std::string	sensorLabel
	An arbitrary label that can be used to identify the sensor. More...

mrpt::system::TTimeStamp	getTimeStamp () const
	Returns CObservation::timestamp for all kind of observations. More...

virtual mrpt::system::TTimeStamp	getOriginalReceivedTimeStamp () const
	By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp. More...

RTTI stuff
typedef CObservationOdometryPtr	Ptr

typedef CObservationOdometryPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CObservationOdometry

static mrpt::utils::TRuntimeClassId	classCObservationOdometry

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 CObservationOdometryPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CObservationOdometryPtr mrpt::obs::CObservationOdometry::ConstPtr

Definition at line 35 of file obs/CObservationOdometry.h.

◆ Ptr

typedef CObservationOdometryPtr mrpt::obs::CObservationOdometry::Ptr

A typedef for the associated smart pointer

Definition at line 35 of file obs/CObservationOdometry.h.

Constructor & Destructor Documentation

◆ CObservationOdometry()

CObservationOdometry::CObservationOdometry ( )

Default ctor.

Constructor.

Definition at line 25 of file CObservationOdometry.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservationOdometry::_GetBaseClass ( )

staticprotected

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ Create()

static CObservationOdometryPtr mrpt::obs::CObservationOdometry::Create ( )

static

Referenced by mrpt::slam::CMetricMapBuilderICP::processActionObservation().

◆ CreateObject()

static mrpt::utils::CObject* mrpt::obs::CObservationOdometry::CreateObject ( )

static

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::obs::CObservationOdometry::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

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).

Definition at line 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ getDescriptionAsText()

void CObservationOdometry::getDescriptionAsText ( std::ostream & o ) const

virtual

Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.

Note: If overried by derived classes, call base CObservation::getDescriptionAsText() first to show common information.; This is the text that appears in RawLogViewer when selecting an object in the dataset

Reimplemented from mrpt::obs::CObservation.

Definition at line 110 of file CObservationOdometry.cpp.

References mrpt::format(), and mrpt::obs::CObservation::getDescriptionAsText().

◆ getOriginalReceivedTimeStamp()

virtual mrpt::system::TTimeStamp mrpt::obs::CObservation::getOriginalReceivedTimeStamp ( ) const

inlinevirtualinherited

By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp.

See also: getTimeStamp()

Reimplemented in mrpt::obs::CObservationGPS, and mrpt::obs::CObservationVelodyneScan.

Definition at line 58 of file obs/CObservation.h.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservationOdometry::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::obs::CObservation.

◆ getSensorPose() [1/2]

void mrpt::obs::CObservationOdometry::getSensorPose ( mrpt::poses::CPose3D & out_sensorPose ) const

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.

See also: setSensorPose

Implements mrpt::obs::CObservation.

Definition at line 50 of file obs/CObservationOdometry.h.

◆ getSensorPose() [2/2]

void CObservation::getSensorPose ( mrpt::math::TPose3D & out_sensorPose ) const

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.

See also: setSensorPose

Definition at line 38 of file CObservation.cpp.

◆ getTimeStamp()

mrpt::system::TTimeStamp mrpt::obs::CObservation::getTimeStamp ( ) const

inlineinherited

Returns CObservation::timestamp for all kind of observations.

See also: getOriginalReceivedTimeStamp()

Definition at line 56 of file obs/CObservation.h.

◆ insertObservationInto()

template<class METRICMAP >

bool mrpt::obs::CObservation::insertObservationInto	(	METRICMAP *	theMap,
		const mrpt::poses::CPose3D *	robotPose = `NULL`
	)		const

inlineinherited

This method is equivalent to:

map->insertObservation(this, robotPose)

Parameters

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)

Returns: Returns true if the map has been updated, or false if this observations has nothing to do with a metric map (for example, a sound observation).

See: Maps and observations compatibility matrix

See also: CMetricMap, CMetricMap::insertObservation

Definition at line 77 of file obs/CObservation.h.

Referenced by mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_CellsDifference().

◆ load()

virtual void mrpt::obs::CObservation::load ( ) const

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.

See also: unload

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 119 of file obs/CObservation.h.

◆ operator delete() [1/3]

void mrpt::obs::CObservationOdometry::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator delete() [2/3]

void mrpt::obs::CObservationOdometry::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator delete() [3/3]

void mrpt::obs::CObservationOdometry::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator delete[]()

void mrpt::obs::CObservationOdometry::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator new() [1/3]

static void* mrpt::obs::CObservationOdometry::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator new() [2/3]

void* mrpt::obs::CObservationOdometry::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator new() [3/3]

void* mrpt::obs::CObservationOdometry::operator new ( size_t size )

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ operator new[]()

void* mrpt::obs::CObservationOdometry::operator new[] ( size_t size )

inline

Definition at line 35 of file obs/CObservationOdometry.h.

◆ readFromStream()

void CObservationOdometry::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

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.

Parameters

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.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 63 of file CObservationOdometry.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, MRPT_UNUSED_PARAM, and version.

◆ setSensorPose() [1/2]

void mrpt::obs::CObservationOdometry::setSensorPose ( const mrpt::poses::CPose3D & newSensorPose )

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.

See also: getSensorPose

Implements mrpt::obs::CObservation.

Definition at line 51 of file obs/CObservationOdometry.h.

◆ setSensorPose() [2/2]

void CObservation::setSensorPose ( const mrpt::math::TPose3D & newSensorPose )

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.

See also: getSensorPose

Definition at line 45 of file CObservation.cpp.

◆ swap()

void CObservation::swap ( CObservation & o )

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.

Definition at line 50 of file CObservation.cpp.

References mrpt::obs::CObservation::sensorLabel, and mrpt::obs::CObservation::timestamp.

Referenced by mrpt::obs::CObservationStereoImages::swap(), and mrpt::obs::CObservation3DRangeScan::swap().

◆ unload()

virtual void mrpt::obs::CObservation::unload ( )

inlinevirtualinherited

Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).

See also: load

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 123 of file obs/CObservation.h.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

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.

Returns: A new 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.

◆ writeToStream()

void CObservationOdometry::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

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.

Parameters

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.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 38 of file CObservationOdometry.cpp.

References MRPT_UNUSED_PARAM, and version.

Member Data Documentation

◆ _init_CObservationOdometry

mrpt::utils::CLASSINIT mrpt::obs::CObservationOdometry::_init_CObservationOdometry

staticprotected

Definition at line 35 of file obs/CObservationOdometry.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 118 of file CObject.h.

◆ classCObservation

const mrpt::utils::TRuntimeClassId mrpt::obs::CObservation::classCObservation

staticinherited

Definition at line 43 of file obs/CObservation.h.

◆ classCObservationOdometry

mrpt::utils::TRuntimeClassId mrpt::obs::CObservationOdometry::classCObservationOdometry

static

Definition at line 35 of file obs/CObservationOdometry.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservationOdometry::classinfo

static

Definition at line 35 of file obs/CObservationOdometry.h.

◆ encoderLeftTicks

int32_t mrpt::obs::CObservationOdometry::encoderLeftTicks

For differential-driven robots: The ticks count for each wheel in ABSOLUTE VALUE (IT IS NOT INCREMENTAL) (positive means FORWARD, for both wheels);.

See also: hasEncodersInfo

Definition at line 44 of file obs/CObservationOdometry.h.

◆ encoderRightTicks

int32_t mrpt::obs::CObservationOdometry::encoderRightTicks

Definition at line 44 of file obs/CObservationOdometry.h.

◆ hasEncodersInfo

bool mrpt::obs::CObservationOdometry::hasEncodersInfo

"true" means that "encoderLeftTicks" and "encoderRightTicks" contain valid values.

Definition at line 42 of file obs/CObservationOdometry.h.

◆ hasVelocities

bool mrpt::obs::CObservationOdometry::hasVelocities

"true" means that velocityLocal contains valid values.

Definition at line 46 of file obs/CObservationOdometry.h.

◆ odometry

mrpt::poses::CPose2D mrpt::obs::CObservationOdometry::odometry

The absolute odometry measurement (IT IS NOT INCREMENTAL)

Definition at line 40 of file obs/CObservationOdometry.h.

◆ sensorLabel

std::string mrpt::obs::CObservation::sensorLabel

inherited

An arbitrary label that can be used to identify the sensor.

Definition at line 53 of file obs/CObservation.h.

◆ timestamp

mrpt::system::TTimeStamp mrpt::obs::CObservation::timestamp

inherited

The associated UTC time-stamp. Where available, this should contain the accurate satellite-based timestamp of the sensor reading.

See also: getOriginalReceivedTimeStamp(), getTimeStamp()

Definition at line 52 of file obs/CObservation.h.

◆ velocityLocal

mrpt::math::TTwist2D mrpt::obs::CObservationOdometry::velocityLocal

Velocity, in the robot (local) frame of reference (+X=forward).

Definition at line 47 of file obs/CObservationOdometry.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Data common to any observation

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CObservationOdometry()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ getDescriptionAsText()

◆ getOriginalReceivedTimeStamp()

◆ GetRuntimeClass()

◆ getSensorPose() [1/2]

◆ getSensorPose() [2/2]

◆ getTimeStamp()

◆ insertObservationInto()

◆ load()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ readFromStream()

◆ setSensorPose() [1/2]

◆ setSensorPose() [2/2]

◆ swap()

◆ unload()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CObservationOdometry

◆ classCObject

◆ classCObservation

◆ classCObservationOdometry

◆ classCSerializable

◆ classinfo

◆ encoderLeftTicks

◆ encoderRightTicks

◆ hasEncodersInfo

◆ hasVelocities

◆ odometry

◆ sensorLabel

◆ timestamp

◆ velocityLocal