Detailed Description

Represents a probabilistic 2D movement of the robot mobile base.

See the tutorial on probabilistic motion models.

See also: CAction

Definition at line 34 of file CActionRobotMovement2D.h.

#include <mrpt/slam/CActionRobotMovement2D.h>

Inheritance diagram for mrpt::slam::CActionRobotMovement2D:

Classes
struct	TMotionModelOptions
	The parameter to be passed to "computeFromOdometry". More...

Public Types
enum	TEstimationMethod { emOdometry = 0, emScan2DMatching }
	A list of posible ways for estimating the content of a CActionRobotMovement2D object. More...

enum	TDrawSampleMotionModel { mmGaussian = 0, mmThrun }

Public Member Functions
	CActionRobotMovement2D ()
	Constructor. More...

	CActionRobotMovement2D (const CActionRobotMovement2D &o)
	Copy constructor. More...

CActionRobotMovement2D &	operator= (const CActionRobotMovement2D &o)
	Copy operator. More...

	~CActionRobotMovement2D ()
	Destructor. More...

void	computeFromOdometry (const CPose2D &odometryIncrement, const TMotionModelOptions &options)
	Computes the PDF of the pose increment from an odometry reading and according to the given motion model (speed and encoder ticks information is not modified). More...

void	computeFromEncoders (double K_left, double K_right, double D)
	If "hasEncodersInfo"=true, this method updates the pose estimation according to the ticks from both encoders and the passed parameters, which is passed internally to the method "computeFromOdometry" with the last used PDF options (or the defualt ones if not explicitly called by the user). More...

void	drawSingleSample (CPose2D &outSample) const
	Using this method instead of "poseChange->drawSingleSample()" may be more efficient in most situations. More...

void	prepareFastDrawSingleSamples () const
	Call this before calling a high number of times "fastDrawSingleSample", which is much faster than "drawSingleSample". More...

void	fastDrawSingleSample (CPose2D &outSample) const
	Faster version than "drawSingleSample", but requires a previous call to "prepareFastDrawSingleSamples". 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...

Public Attributes
CPosePDFPtr	poseChange
	The 2D pose change probabilistic estimation. More...

CPose2D	rawOdometryIncrementReading
	This is the raw odometry reading, and only is used when "estimationMethod" is "TEstimationMethod::emOdometry". More...

TEstimationMethod	estimationMethod
	This fields indicates the way this estimation was obtained. More...

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

int32_t	encoderLeftTicks
	For odometry only: the ticks count for each wheel FROM the last reading (positive means FORWARD, for both wheels);. More...

int32_t	encoderRightTicks

bool	hasVelocities
	If "true" means that "velocityLin" and "velocityAng" contain valid values. More...

float	velocityLin
	The velocity of the robot, linear in meters/sec and angular in rad/sec. More...

float	velocityAng

struct OBS_IMPEXP mrpt::slam::CActionRobotMovement2D::TMotionModelOptions	motionModelConfiguration

mrpt::system::TTimeStamp	timestamp
	The associated time-stamp. More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCAction

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
void	computeFromOdometry_modelGaussian (const CPose2D &odometryIncrement, const TMotionModelOptions &o)
	Computes the PDF of the pose increment from an odometry reading, using a Gaussian approximation as the motion model. More...

void	computeFromOdometry_modelThrun (const CPose2D &odometryIncrement, const TMotionModelOptions &o)
	Computes the PDF of the pose increment from an odometry reading, using the motion model from Thrun's book. More...

void	drawSingleSample_modelGaussian (CPose2D &outSample) const
	The sample generator for the model "computeFromOdometry_modelGaussian", internally called when the user invokes "drawSingleSample". More...

void	drawSingleSample_modelThrun (CPose2D &outSample) const
	The sample generator for the model "computeFromOdometry_modelThrun", internally called when the user invokes "drawSingleSample". More...

void	prepareFastDrawSingleSample_modelGaussian () const
	Internal use. More...

void	prepareFastDrawSingleSample_modelThrun () const
	Internal use. More...

void	fastDrawSingleSample_modelGaussian (CPose2D &outSample) const
	Internal use. More...

void	fastDrawSingleSample_modelThrun (CPose2D &outSample) const
	Internal use. 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...

Protected Attributes
CMatrixDouble33	m_fastDrawGauss_Z
	Auxiliary matrix. More...

CPose2D	m_fastDrawGauss_M

RTTI stuff
typedef CActionRobotMovement2DPtr	SmartPtr

static mrpt::utils::CLASSINIT	_init_CActionRobotMovement2D

static mrpt::utils::TRuntimeClassId	classCActionRobotMovement2D

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

Member Typedef Documentation

◆ SmartPtr

typedef CActionRobotMovement2DPtr mrpt::slam::CActionRobotMovement2D::SmartPtr

A typedef for the associated smart pointer

Definition at line 37 of file CActionRobotMovement2D.h.

Member Enumeration Documentation

◆ TDrawSampleMotionModel

enum mrpt::slam::CActionRobotMovement2D::TDrawSampleMotionModel

Enumerator
mmGaussian
mmThrun

Definition at line 93 of file CActionRobotMovement2D.h.

◆ TEstimationMethod

enum mrpt::slam::CActionRobotMovement2D::TEstimationMethod

A list of posible ways for estimating the content of a CActionRobotMovement2D object.

Enumerator
emOdometry
emScan2DMatching

Definition at line 42 of file CActionRobotMovement2D.h.

Constructor & Destructor Documentation

◆ CActionRobotMovement2D() [1/2]

mrpt::slam::CActionRobotMovement2D::CActionRobotMovement2D ( )

Constructor.

◆ CActionRobotMovement2D() [2/2]

mrpt::slam::CActionRobotMovement2D::CActionRobotMovement2D ( const CActionRobotMovement2D & o )

Copy constructor.

◆ ~CActionRobotMovement2D()

mrpt::slam::CActionRobotMovement2D::~CActionRobotMovement2D ( )

Destructor.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::slam::CActionRobotMovement2D::_GetBaseClass ( )

staticprotected

◆ clone()

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

inlineinherited

Cloning interface for smart pointers.

Definition at line 135 of file CObject.h.

◆ computeFromEncoders()

void mrpt::slam::CActionRobotMovement2D::computeFromEncoders	(	double	K_left,
		double	K_right,
		double	D
	)

If "hasEncodersInfo"=true, this method updates the pose estimation according to the ticks from both encoders and the passed parameters, which is passed internally to the method "computeFromOdometry" with the last used PDF options (or the defualt ones if not explicitly called by the user).

Parameters

K_left	The meters / tick ratio for the left encoder.
K_right	The meters / tick ratio for the right encoder.
D	The distance between both wheels, in meters.

◆ computeFromOdometry()

void mrpt::slam::CActionRobotMovement2D::computeFromOdometry	(	const CPose2D &	odometryIncrement,
		const TMotionModelOptions &	options
	)

Computes the PDF of the pose increment from an odometry reading and according to the given motion model (speed and encoder ticks information is not modified).

According to the parameters in the passed struct, it will be called one the private sampling functions (see "see also" next).

See also: computeFromOdometry_modelGaussian, computeFromOdometry_modelThrun

Referenced by mrpt::slam::PF_implementation< CPose2D, CMonteCarloLocalization2D >::PF_SLAM_implementation_gatherActionsCheckBothActObs().

◆ computeFromOdometry_modelGaussian()

void mrpt::slam::CActionRobotMovement2D::computeFromOdometry_modelGaussian	(	const CPose2D &	odometryIncrement,
		const TMotionModelOptions &	o
	)

protected

Computes the PDF of the pose increment from an odometry reading, using a Gaussian approximation as the motion model.

See also: computeFromOdometry

◆ computeFromOdometry_modelThrun()

void mrpt::slam::CActionRobotMovement2D::computeFromOdometry_modelThrun	(	const CPose2D &	odometryIncrement,
		const TMotionModelOptions &	o
	)

protected

Computes the PDF of the pose increment from an odometry reading, using the motion model from Thrun's book.

This model is discussed in "Probabilistic Robotics", Thrun, Burgard, and Fox, 2006, pp.136.

See also: computeFromOdometry

◆ Create()

static CActionRobotMovement2DPtr mrpt::slam::CActionRobotMovement2D::Create ( )

static

◆ CreateObject()

static mrpt::utils::CObject* mrpt::slam::CActionRobotMovement2D::CreateObject ( )

static

◆ drawSingleSample()

void mrpt::slam::CActionRobotMovement2D::drawSingleSample ( CPose2D & outSample ) const

Using this method instead of "poseChange->drawSingleSample()" may be more efficient in most situations.

See also: CPosePDF::drawSingleSample

◆ drawSingleSample_modelGaussian()

void mrpt::slam::CActionRobotMovement2D::drawSingleSample_modelGaussian ( CPose2D & outSample ) const

protected

The sample generator for the model "computeFromOdometry_modelGaussian", internally called when the user invokes "drawSingleSample".

◆ drawSingleSample_modelThrun()

void mrpt::slam::CActionRobotMovement2D::drawSingleSample_modelThrun ( CPose2D & outSample ) const

protected

The sample generator for the model "computeFromOdometry_modelThrun", internally called when the user invokes "drawSingleSample".

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::slam::CActionRobotMovement2D::duplicate ( ) const

virtual

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

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr mrpt::utils::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 132 of file CObject.h.

◆ fastDrawSingleSample()

void mrpt::slam::CActionRobotMovement2D::fastDrawSingleSample ( CPose2D & outSample ) const

Faster version than "drawSingleSample", but requires a previous call to "prepareFastDrawSingleSamples".

◆ fastDrawSingleSample_modelGaussian()

void mrpt::slam::CActionRobotMovement2D::fastDrawSingleSample_modelGaussian ( CPose2D & outSample ) const

protected

Internal use.

◆ fastDrawSingleSample_modelThrun()

void mrpt::slam::CActionRobotMovement2D::fastDrawSingleSample_modelThrun ( CPose2D & outSample ) const

protected

Internal use.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::slam::CActionRobotMovement2D::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::slam::CAction.

◆ operator=()

CActionRobotMovement2D& mrpt::slam::CActionRobotMovement2D::operator= ( const CActionRobotMovement2D & o )

Copy operator.

◆ prepareFastDrawSingleSample_modelGaussian()

void mrpt::slam::CActionRobotMovement2D::prepareFastDrawSingleSample_modelGaussian ( ) const

protected

Internal use.

◆ prepareFastDrawSingleSample_modelThrun()

void mrpt::slam::CActionRobotMovement2D::prepareFastDrawSingleSample_modelThrun ( ) const

protected

Internal use.

◆ prepareFastDrawSingleSamples()

void mrpt::slam::CActionRobotMovement2D::prepareFastDrawSingleSamples ( ) const

Call this before calling a high number of times "fastDrawSingleSample", which is much faster than "drawSingleSample".

◆ readFromStream()

void mrpt::slam::CActionRobotMovement2D::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.

◆ writeToStream()

void mrpt::slam::CActionRobotMovement2D::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.

Member Data Documentation

◆ _init_CActionRobotMovement2D

mrpt::utils::CLASSINIT mrpt::slam::CActionRobotMovement2D::_init_CActionRobotMovement2D

staticprotected

Definition at line 37 of file CActionRobotMovement2D.h.

◆ classCAction

const mrpt::utils::TRuntimeClassId mrpt::slam::CAction::classCAction

staticinherited

Definition at line 36 of file CAction.h.

◆ classCActionRobotMovement2D

mrpt::utils::TRuntimeClassId mrpt::slam::CActionRobotMovement2D::classCActionRobotMovement2D

static

Definition at line 37 of file CActionRobotMovement2D.h.

◆ classCObject

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

staticinherited

Definition at line 120 of file CObject.h.

◆ classCSerializable

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

staticinherited

Definition at line 35 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::slam::CActionRobotMovement2D::classinfo

static

Definition at line 37 of file CActionRobotMovement2D.h.

◆ encoderLeftTicks

int32_t mrpt::slam::CActionRobotMovement2D::encoderLeftTicks

For odometry only: the ticks count for each wheel FROM the last reading (positive means FORWARD, for both wheels);.

See also: hasEncodersInfo

Definition at line 83 of file CActionRobotMovement2D.h.

◆ encoderRightTicks

int32_t mrpt::slam::CActionRobotMovement2D::encoderRightTicks

Definition at line 83 of file CActionRobotMovement2D.h.

◆ estimationMethod

TEstimationMethod mrpt::slam::CActionRobotMovement2D::estimationMethod

This fields indicates the way this estimation was obtained.

Definition at line 74 of file CActionRobotMovement2D.h.

◆ hasEncodersInfo

bool mrpt::slam::CActionRobotMovement2D::hasEncodersInfo

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

Definition at line 78 of file CActionRobotMovement2D.h.

◆ hasVelocities

bool mrpt::slam::CActionRobotMovement2D::hasVelocities

If "true" means that "velocityLin" and "velocityAng" contain valid values.

Definition at line 87 of file CActionRobotMovement2D.h.

◆ m_fastDrawGauss_M

CPose2D mrpt::slam::CActionRobotMovement2D::m_fastDrawGauss_M

mutableprotected

Definition at line 214 of file CActionRobotMovement2D.h.

◆ m_fastDrawGauss_Z

CMatrixDouble33 mrpt::slam::CActionRobotMovement2D::m_fastDrawGauss_Z

mutableprotected

Auxiliary matrix.

Definition at line 213 of file CActionRobotMovement2D.h.

◆ motionModelConfiguration

struct OBS_IMPEXP mrpt::slam::CActionRobotMovement2D::TMotionModelOptions mrpt::slam::CActionRobotMovement2D::motionModelConfiguration

Referenced by mrpt::slam::PF_implementation< CPose2D, CMonteCarloLocalization2D >::PF_SLAM_implementation_gatherActionsCheckBothActObs().

◆ poseChange

CPosePDFPtr mrpt::slam::CActionRobotMovement2D::poseChange

The 2D pose change probabilistic estimation.

Definition at line 66 of file CActionRobotMovement2D.h.

Referenced by mrpt::slam::PF_implementation< CPose2D, CMonteCarloLocalization2D >::PF_SLAM_implementation_gatherActionsCheckBothActObs(), and mrpt::slam::PF_implementation< CPose2D, CMonteCarloLocalization2D >::PF_SLAM_implementation_pfStandardProposal().

◆ rawOdometryIncrementReading

CPose2D mrpt::slam::CActionRobotMovement2D::rawOdometryIncrementReading

This is the raw odometry reading, and only is used when "estimationMethod" is "TEstimationMethod::emOdometry".

Definition at line 70 of file CActionRobotMovement2D.h.

◆ timestamp

mrpt::system::TTimeStamp mrpt::slam::CAction::timestamp

inherited

The associated time-stamp.

This was added at 2-Dec-2007, new serialization versions have been added to derived classes to manage this time-stamp. Prior versions will be read as having a INVALID_TIMESTAMP value.

Definition at line 50 of file CAction.h.

◆ velocityAng

float mrpt::slam::CActionRobotMovement2D::velocityAng

Definition at line 91 of file CActionRobotMovement2D.h.

◆ velocityLin

float mrpt::slam::CActionRobotMovement2D::velocityLin

The velocity of the robot, linear in meters/sec and angular in rad/sec.

Definition at line 91 of file CActionRobotMovement2D.h.

Detailed Description

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

RTTI stuff

Member Typedef Documentation

◆ SmartPtr

Member Enumeration Documentation

◆ TDrawSampleMotionModel

◆ TEstimationMethod

Constructor & Destructor Documentation

◆ CActionRobotMovement2D() [1/2]

◆ CActionRobotMovement2D() [2/2]

◆ ~CActionRobotMovement2D()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ computeFromEncoders()

◆ computeFromOdometry()

◆ computeFromOdometry_modelGaussian()

◆ computeFromOdometry_modelThrun()

◆ Create()

◆ CreateObject()

◆ drawSingleSample()

◆ drawSingleSample_modelGaussian()

◆ drawSingleSample_modelThrun()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ fastDrawSingleSample()

◆ fastDrawSingleSample_modelGaussian()

◆ fastDrawSingleSample_modelThrun()

◆ GetRuntimeClass()

◆ operator=()

◆ prepareFastDrawSingleSample_modelGaussian()

◆ prepareFastDrawSingleSample_modelThrun()

◆ prepareFastDrawSingleSamples()

◆ readFromStream()

◆ writeToStream()

Member Data Documentation

◆ _init_CActionRobotMovement2D

◆ classCAction

◆ classCActionRobotMovement2D

◆ classCObject

◆ classCSerializable

◆ classinfo

◆ encoderLeftTicks

◆ encoderRightTicks

◆ estimationMethod

◆ hasEncodersInfo

◆ hasVelocities

◆ m_fastDrawGauss_M

◆ m_fastDrawGauss_Z

◆ motionModelConfiguration

◆ poseChange

◆ rawOdometryIncrementReading

◆ timestamp

◆ velocityAng

◆ velocityLin