Detailed Description

A class for very simple 2D SLAM based on ICP.

This is a non-probabilistic pose tracking algorithm. Map are stored as in files as binary dumps of "mrpt::maps::CSimpleMap" objects. The methods are thread-safe.

Definition at line 27 of file CMetricMapBuilderICP.h.

#include <mrpt/slam/CMetricMapBuilderICP.h>

Inheritance diagram for mrpt::slam::CMetricMapBuilderICP:

Classes
struct	TConfigParams
	Algorithm configuration params. More...

struct	TDist
	Traveled distances from last map update / ICP-based localization. More...

Public Member Functions
	CMetricMapBuilderICP ()
	Default constructor - Upon construction, you can set the parameters in ICP_options, then call "initialize". More...

virtual	~CMetricMapBuilderICP ()
	Destructor: More...

void	initialize (const mrpt::maps::CSimpleMap &initialMap=mrpt::maps::CSimpleMap(), const mrpt::poses::CPosePDF *x0=nullptr) override
	Initialize the method, starting with a known location PDF "x0"(if supplied, set to nullptr to left unmodified) and a given fixed, past map. More...

mrpt::poses::CPose3DPDF::Ptr	getCurrentPoseEstimation () const override
	Returns a copy of the current best pose estimation as a pose PDF. More...

void	setCurrentMapFile (const char *mapFile)
	Sets the "current map file", thus that map will be loaded if it exists or a new one will be created if it does not, and the updated map will be save to that file when destroying the object. More...

void	processActionObservation (mrpt::obs::CActionCollection &action, mrpt::obs::CSensoryFrame &in_SF) override
	Appends a new action and observations to update this map: See the description of the class at the top of this page to see a more complete description. More...

void	processObservation (const mrpt::obs::CObservation::Ptr &obs)
	The main method of this class: Process one odometry or sensor observation. More...

void	getCurrentlyBuiltMap (mrpt::maps::CSimpleMap &out_map) const override
	Fills "out_map" with the set of "poses"-"sensory-frames", thus the so far built map. More...

void	getCurrentMapPoints (std::vector< float > &x, std::vector< float > &y)
	Returns the 2D points of current local map. More...

const mrpt::maps::CMultiMetricMap *	getCurrentlyBuiltMetricMap () const override
	Returns the map built so far. More...

unsigned int	getCurrentlyBuiltMapSize () override
	Returns just how many sensory-frames are stored in the currently build map. More...

void	saveCurrentEstimationToImage (const std::string &file, bool formatEMF_BMP=true) override
	A useful method for debugging: the current map (and/or poses) estimation is dumped to an image file. More...

void	clear ()
	Clear all elements of the maps, and reset localization to (0,0,0deg). More...

void	enableMapUpdating (bool enable)
	Enables or disables the map updating (default state is enabled) More...

void	loadCurrentMapFromFile (const std::string &fileName)
	Load map (mrpt::maps::CSimpleMap) from a ".simplemap" file. More...

void	saveCurrentMapToFile (const std::string &fileName, bool compressGZ=true) const
	Save map (mrpt::maps::CSimpleMap) to a ".simplemap" file. More...

Public Attributes
TConfigParams	ICP_options
	Options for the ICP-SLAM application. More...

CICP::TConfigParams	ICP_params
	Options for the ICP algorithm itself. More...

TOptions	options

Protected Member Functions
void	enterCriticalSection ()
	Enter critical section for map updating. More...

void	leaveCriticalSection ()
	Leave critical section for map updating. More...

Protected Attributes
std::mutex	critZoneChangingMap
	Critical zones. More...

Private Member Functions
void	accumulateRobotDisplacementCounters (const mrpt::poses::CPose2D &new_pose)

void	resetRobotDisplacementCounters (const mrpt::poses::CPose2D &new_pose)

Private Attributes
mrpt::maps::CSimpleMap	SF_Poses_seq
	The set of observations that leads to current map: More...

mrpt::maps::CMultiMetricMap	metricMap
	The metric map representation as a points map: More...

std::string	currentMapFile
	Current map file. More...

mrpt::poses::CRobot2DPoseEstimator	m_lastPoseEst
	The pose estimation by the alignment algorithm (ICP). More...

mrpt::math::CMatrixDouble33	m_lastPoseEst_cov
	Last pose estimation (covariance) More...

std::deque< mrpt::math::TPose2D >	m_estRobotPath
	The estimated robot path: More...

mrpt::poses::CPose2D	m_auxAccumOdometry

TDist	m_distSinceLastICP

mrpt::aligned_containers< std::string, TDist >::map_t	m_distSinceLastInsertion
	Indexed by sensor label. More...

bool	m_there_has_been_an_odometry

Constructor & Destructor Documentation

◆ CMetricMapBuilderICP()

CMetricMapBuilderICP::CMetricMapBuilderICP ( )

Default constructor - Upon construction, you can set the parameters in ICP_options, then call "initialize".

Definition at line 32 of file CMetricMapBuilderICP.cpp.

References initialize().

Here is the call graph for this function:

◆ ~CMetricMapBuilderICP()

CMetricMapBuilderICP::~CMetricMapBuilderICP ( )

virtual

Destructor:

Definition at line 42 of file CMetricMapBuilderICP.cpp.

References mrpt::slam::CMetricMapBuilder::enterCriticalSection(), mrpt::slam::CMetricMapBuilder::leaveCriticalSection(), and setCurrentMapFile().

Here is the call graph for this function:

Member Function Documentation

◆ accumulateRobotDisplacementCounters()

void CMetricMapBuilderICP::accumulateRobotDisplacementCounters ( const mrpt::poses::CPose2D & new_pose )

private

Definition at line 682 of file CMetricMapBuilderICP.cpp.

References m_distSinceLastICP, m_distSinceLastInsertion, and mrpt::slam::CMetricMapBuilderICP::TDist::updateDistances().

Referenced by processObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void CMetricMapBuilder::clear ( )

inherited

Clear all elements of the maps, and reset localization to (0,0,0deg).

Definition at line 41 of file CMetricMapBuilder.cpp.

References mrpt::slam::CMetricMapBuilder::initialize(), and MRPT_LOG_DEBUG.

Here is the call graph for this function:

◆ enableMapUpdating()

void mrpt::slam::CMetricMapBuilder::enableMapUpdating ( bool enable )

inlineinherited

Enables or disables the map updating (default state is enabled)

Definition at line 106 of file CMetricMapBuilder.h.

References mrpt::slam::CMetricMapBuilder::TOptions::enableMapUpdating, and mrpt::slam::CMetricMapBuilder::options.

◆ enterCriticalSection()

void mrpt::slam::CMetricMapBuilder::enterCriticalSection ( )

inlineprotectedinherited

Enter critical section for map updating.

Definition at line 41 of file CMetricMapBuilder.h.

References mrpt::slam::CMetricMapBuilder::critZoneChangingMap.

Referenced by getCurrentMapPoints(), and ~CMetricMapBuilderICP().

Here is the caller graph for this function:

◆ getCurrentlyBuiltMap()

void CMetricMapBuilderICP::getCurrentlyBuiltMap ( mrpt::maps::CSimpleMap & out_map ) const

overridevirtual

Fills "out_map" with the set of "poses"-"sensory-frames", thus the so far built map.

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 610 of file CMetricMapBuilderICP.cpp.

References SF_Poses_seq.

◆ getCurrentlyBuiltMapSize()

unsigned int CMetricMapBuilderICP::getCurrentlyBuiltMapSize ( )

overridevirtual

Returns just how many sensory-frames are stored in the currently build map.

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 623 of file CMetricMapBuilderICP.cpp.

References SF_Poses_seq, and mrpt::maps::CSimpleMap::size().

Here is the call graph for this function:

◆ getCurrentlyBuiltMetricMap()

const CMultiMetricMap * CMetricMapBuilderICP::getCurrentlyBuiltMetricMap ( ) const

overridevirtual

Returns the map built so far.

NOTE that for efficiency a pointer to the internal object is passed, DO NOT delete nor modify the object in any way, if desired, make a copy of ir with "clone()".

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 615 of file CMetricMapBuilderICP.cpp.

References metricMap.

◆ getCurrentMapPoints()

void CMetricMapBuilderICP::getCurrentMapPoints	(	std::vector< float > &	x,
		std::vector< float > &	y
	)

Returns the 2D points of current local map.

Definition at line 594 of file CMetricMapBuilderICP.cpp.

References ASSERT_, mrpt::slam::CMetricMapBuilder::enterCriticalSection(), mrpt::slam::CMetricMapBuilder::leaveCriticalSection(), mrpt::maps::CMultiMetricMap::m_pointsMaps, metricMap, and mrpt::maps::CMultiMetricMap::ProxyFilterContainerByClass< SELECTED_CLASS_PTR, CONTAINER >::size().

Here is the call graph for this function:

◆ getCurrentPoseEstimation()

CPose3DPDF::Ptr CMetricMapBuilderICP::getCurrentPoseEstimation ( ) const

overridevirtual

Returns a copy of the current best pose estimation as a pose PDF.

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 509 of file CMetricMapBuilderICP.cpp.

References mrpt::poses::CPosePDFGaussian::cov, mrpt::poses::CRobot2DPoseEstimator::getLatestRobotPose(), m_lastPoseEst, m_lastPoseEst_cov, and mrpt::poses::CPosePDFGaussian::mean.

Here is the call graph for this function:

◆ initialize()

void CMetricMapBuilderICP::initialize	(	const mrpt::maps::CSimpleMap &	initialMap = `mrpt::maps::CSimpleMap()`,
		const mrpt::poses::CPosePDF *	x0 = `nullptr`
	)

overridevirtual

Initialize the method, starting with a known location PDF "x0"(if supplied, set to nullptr to left unmodified) and a given fixed, past map.

This method MUST be called if using the default constructor, after loading the configuration into ICP_options. In particular, TConfigParams::mapInitializers

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 524 of file CMetricMapBuilderICP.cpp.

References mrpt::slam::CMetricMapBuilderICP::TDist::ang, mrpt::slam::CMetricMapBuilder::critZoneChangingMap, mrpt::maps::CSimpleMap::get(), mrpt::utils::CProbabilityDensityFunction< TDATA, STATE_LEN >::getMeanVal(), ICP_options, mrpt::slam::CMetricMapBuilderICP::TDist::lin, m_auxAccumOdometry, m_distSinceLastICP, m_distSinceLastInsertion, m_estRobotPath, m_lastPoseEst, m_there_has_been_an_odometry, mrpt::slam::CMetricMapBuilderICP::TConfigParams::mapInitializers, metricMap, MRPT_END, MRPT_LOG_INFO, MRPT_START, mrpt::system::now(), mrpt::poses::CRobot2DPoseEstimator::processUpdateNewPoseLocalization(), mrpt::poses::CRobot2DPoseEstimator::reset(), mrpt::maps::CMultiMetricMap::setListOfMaps(), SF_Poses_seq, and mrpt::maps::CSimpleMap::size().

Referenced by CMetricMapBuilderICP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ leaveCriticalSection()

void mrpt::slam::CMetricMapBuilder::leaveCriticalSection ( )

inlineprotectedinherited

Leave critical section for map updating.

Definition at line 43 of file CMetricMapBuilder.h.

References mrpt::slam::CMetricMapBuilder::critZoneChangingMap.

Referenced by getCurrentMapPoints(), and ~CMetricMapBuilderICP().

Here is the caller graph for this function:

◆ loadCurrentMapFromFile()

void CMetricMapBuilder::loadCurrentMapFromFile ( const std::string & fileName )

inherited

Load map (mrpt::maps::CSimpleMap) from a ".simplemap" file.

Definition at line 54 of file CMetricMapBuilder.cpp.

References mrpt::maps::CSimpleMap::clear(), mrpt::system::fileExists(), mrpt::slam::CMetricMapBuilder::initialize(), MRPT_LOG_INFO_STREAM, and MRPT_LOG_WARN_STREAM.

Referenced by setCurrentMapFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processActionObservation()

void CMetricMapBuilderICP::processActionObservation	(	mrpt::obs::CActionCollection &	action,
		mrpt::obs::CSensoryFrame &	in_SF
	)

overridevirtual

Appends a new action and observations to update this map: See the description of the class at the top of this page to see a more complete description.

Parameters

action	The estimation of the incremental pose change in the robot pose.
in_SF	The set of observations that robot senses at the new pose. See params in CMetricMapBuilder::options and CMetricMapBuilderICP::ICP_options

See also: processObservation

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 468 of file CMetricMapBuilderICP.cpp.

References mrpt::obs::CSensoryFrame::begin(), mrpt::poses::CPose2D::composeFrom(), mrpt::obs::CSensoryFrame::end(), mrpt::obs::CActionCollection::getBestMovementEstimation(), m_auxAccumOdometry, and processObservation().

Here is the call graph for this function:

◆ processObservation()

void CMetricMapBuilderICP::processObservation ( const mrpt::obs::CObservation::Ptr & obs )

The main method of this class: Process one odometry or sensor observation.

The new entry point of the algorithm (the old one was processActionObservation, which now is a wrapper to this method). See params in CMetricMapBuilder::options and CMetricMapBuilderICP::ICP_options

Definition at line 133 of file CMetricMapBuilderICP.cpp.

Referenced by processActionObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetRobotDisplacementCounters()

void CMetricMapBuilderICP::resetRobotDisplacementCounters ( const mrpt::poses::CPose2D & new_pose )

private

Definition at line 694 of file CMetricMapBuilderICP.cpp.

References m_distSinceLastICP, m_distSinceLastInsertion, and mrpt::slam::CMetricMapBuilderICP::TDist::updatePose().

Referenced by processObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCurrentEstimationToImage()

void CMetricMapBuilderICP::saveCurrentEstimationToImage	(	const std::string &	file,
		bool	formatEMF_BMP = `true`
	)

overridevirtual

A useful method for debugging: the current map (and/or poses) estimation is dumped to an image file.

Parameters

file	The output file name
formatEMF_BMP	Output format = true:EMF, false:BMP

Implements mrpt::slam::CMetricMapBuilder.

Definition at line 631 of file CMetricMapBuilderICP.cpp.

References ASSERT_, mrpt::utils::CEnhancedMetaFile::drawImage(), mrpt::utils::CEnhancedMetaFile::line(), m_estRobotPath, mrpt::maps::CMultiMetricMap::m_gridMaps, metricMap, MRPT_END, MRPT_START, mrpt::maps::CMultiMetricMap::ProxyFilterContainerByClass< SELECTED_CLASS_PTR, CONTAINER >::size(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ saveCurrentMapToFile()

void CMetricMapBuilder::saveCurrentMapToFile	(	const std::string &	fileName,
		bool	compressGZ = `true`
	)		const

inherited

Save map (mrpt::maps::CSimpleMap) to a ".simplemap" file.

Definition at line 86 of file CMetricMapBuilder.cpp.

References CFileGZOutputStream, mrpt::slam::CMetricMapBuilder::getCurrentlyBuiltMap(), and MRPT_LOG_INFO_STREAM.

Referenced by setCurrentMapFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentMapFile()

void CMetricMapBuilderICP::setCurrentMapFile ( const char * mapFile )

Sets the "current map file", thus that map will be loaded if it exists or a new one will be created if it does not, and the updated map will be save to that file when destroying the object.

Definition at line 494 of file CMetricMapBuilderICP.cpp.

References currentMapFile, mrpt::slam::CMetricMapBuilder::loadCurrentMapFromFile(), and mrpt::slam::CMetricMapBuilder::saveCurrentMapToFile().

Referenced by ~CMetricMapBuilderICP().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ critZoneChangingMap

std::mutex mrpt::slam::CMetricMapBuilder::critZoneChangingMap

protectedinherited

Critical zones.

Definition at line 39 of file CMetricMapBuilder.h.

Referenced by mrpt::slam::CMetricMapBuilderRBPF::clear(), mrpt::slam::CMetricMapBuilder::enterCriticalSection(), initialize(), mrpt::slam::CMetricMapBuilderRBPF::initialize(), mrpt::slam::CMetricMapBuilder::leaveCriticalSection(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and processObservation().

◆ currentMapFile

std::string mrpt::slam::CMetricMapBuilderICP::currentMapFile

private

Current map file.

Definition at line 166 of file CMetricMapBuilderICP.h.

Referenced by setCurrentMapFile().

◆ ICP_options

TConfigParams mrpt::slam::CMetricMapBuilderICP::ICP_options

Options for the ICP-SLAM application.

See also: ICP_params

Definition at line 88 of file CMetricMapBuilderICP.h.

Referenced by initialize(), and processObservation().

◆ ICP_params

CICP::TConfigParams mrpt::slam::CMetricMapBuilderICP::ICP_params

Options for the ICP algorithm itself.

See also: ICP_options

Definition at line 90 of file CMetricMapBuilderICP.h.

Referenced by processObservation().

◆ m_auxAccumOdometry

mrpt::poses::CPose2D mrpt::slam::CMetricMapBuilderICP::m_auxAccumOdometry

private

Definition at line 177 of file CMetricMapBuilderICP.h.

Referenced by initialize(), and processActionObservation().

◆ m_distSinceLastICP

TDist mrpt::slam::CMetricMapBuilderICP::m_distSinceLastICP

private

Definition at line 190 of file CMetricMapBuilderICP.h.

Referenced by accumulateRobotDisplacementCounters(), initialize(), processObservation(), and resetRobotDisplacementCounters().

◆ m_distSinceLastInsertion

mrpt::aligned_containers<std::string, TDist>::map_t mrpt::slam::CMetricMapBuilderICP::m_distSinceLastInsertion

private

Indexed by sensor label.

Definition at line 193 of file CMetricMapBuilderICP.h.

Referenced by accumulateRobotDisplacementCounters(), initialize(), processObservation(), and resetRobotDisplacementCounters().

◆ m_estRobotPath

std::deque<mrpt::math::TPose2D> mrpt::slam::CMetricMapBuilderICP::m_estRobotPath

private

The estimated robot path:

Definition at line 176 of file CMetricMapBuilderICP.h.

Referenced by initialize(), processObservation(), and saveCurrentEstimationToImage().

◆ m_lastPoseEst

mrpt::poses::CRobot2DPoseEstimator mrpt::slam::CMetricMapBuilderICP::m_lastPoseEst

private

The pose estimation by the alignment algorithm (ICP).

Last pose estimation (Mean)

Definition at line 170 of file CMetricMapBuilderICP.h.

Referenced by getCurrentPoseEstimation(), initialize(), and processObservation().

◆ m_lastPoseEst_cov

mrpt::math::CMatrixDouble33 mrpt::slam::CMetricMapBuilderICP::m_lastPoseEst_cov

private

Last pose estimation (covariance)

Definition at line 172 of file CMetricMapBuilderICP.h.

Referenced by getCurrentPoseEstimation(), and processObservation().

◆ m_there_has_been_an_odometry

bool mrpt::slam::CMetricMapBuilderICP::m_there_has_been_an_odometry

private

Definition at line 194 of file CMetricMapBuilderICP.h.

Referenced by initialize(), and processObservation().

◆ metricMap

mrpt::maps::CMultiMetricMap mrpt::slam::CMetricMapBuilderICP::metricMap

private

The metric map representation as a points map:

Definition at line 163 of file CMetricMapBuilderICP.h.

Referenced by getCurrentlyBuiltMetricMap(), getCurrentMapPoints(), initialize(), processObservation(), and saveCurrentEstimationToImage().

◆ options

TOptions mrpt::slam::CMetricMapBuilder::options

inherited

Definition at line 143 of file CMetricMapBuilder.h.

Referenced by mrpt::slam::CMetricMapBuilder::enableMapUpdating(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and processObservation().

◆ SF_Poses_seq

mrpt::maps::CSimpleMap mrpt::slam::CMetricMapBuilderICP::SF_Poses_seq

private

The set of observations that leads to current map:

Definition at line 160 of file CMetricMapBuilderICP.h.

Referenced by getCurrentlyBuiltMap(), getCurrentlyBuiltMapSize(), initialize(), and processObservation().

Detailed Description

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ CMetricMapBuilderICP()

◆ ~CMetricMapBuilderICP()

Member Function Documentation

◆ accumulateRobotDisplacementCounters()

◆ clear()

◆ enableMapUpdating()

◆ enterCriticalSection()

◆ getCurrentlyBuiltMap()

◆ getCurrentlyBuiltMapSize()

◆ getCurrentlyBuiltMetricMap()

◆ getCurrentMapPoints()

◆ getCurrentPoseEstimation()

◆ initialize()

◆ leaveCriticalSection()

◆ loadCurrentMapFromFile()

◆ processActionObservation()

◆ processObservation()

◆ resetRobotDisplacementCounters()

◆ saveCurrentEstimationToImage()

◆ saveCurrentMapToFile()

◆ setCurrentMapFile()

Member Data Documentation

◆ critZoneChangingMap

◆ currentMapFile

◆ ICP_options

◆ ICP_params

◆ m_auxAccumOdometry

◆ m_distSinceLastICP

◆ m_distSinceLastInsertion

◆ m_estRobotPath

◆ m_lastPoseEst

◆ m_lastPoseEst_cov

◆ m_there_has_been_an_odometry

◆ metricMap

◆ options

◆ SF_Poses_seq