Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | Friends
mrpt::hmtslam::CHMTSLAM Class Reference

Detailed Description

An implementation of Hybrid Metric Topological SLAM (HMT-SLAM).

The main entry points for a user are pushAction() and pushObservations(). Several parameters can be modified through m_options.

The mathematical models of this approach have been reported in:

More information in the wiki page: http://www.mrpt.org/HMT-SLAM . A complete working application can be found in "MRPT/apps/hmt-slam".

The complete state of the SLAM framework is serializable, so it can be saved and restore to/from a binary dump. This class implements mrpt::serialization::CSerializable, so it can be saved with "stream << slam_object;" and restored with "stream >> slam_object;". Alternatively, the methods CHMTSLAM::saveState and CHMTSLAM::loadState can be invoked, which in turn call internally to the CSerializable interface.

See also
CHierarchicalMHMap

Definition at line 68 of file CHMTSLAM.h.

#include <mrpt/hmtslam/CHMTSLAM.h>

Inheritance diagram for mrpt::hmtslam::CHMTSLAM:
Inheritance graph

Classes

struct  TMessageLSLAMfromAA
 Message definition: More...
 
struct  TMessageLSLAMfromTBI
 Message definition: More...
 
struct  TMessageLSLAMtoTBI
 Message definition: More...
 
struct  TOptions
 A variety of options and configuration params (private, use loadOptions). More...
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 CHMTSLAM ()
 Default constructor. More...
 
 CHMTSLAM (const CHMTSLAM &)
 
const CHMTSLAMoperator= (const CHMTSLAM &)
 
virtual ~CHMTSLAM ()
 Destructor. More...
 
bool abortedDueToErrors ()
 Return true if an exception has been caught in any thread leading to the end of the mapping application: no more actions/observations will be processed from now on. More...
 
void generateLogFiles (unsigned int nIteration)
 Called from LSLAM thread when log files must be created. More...
 
void getAs3DScene (mrpt::opengl::COpenGLScene &outScene)
 Gets a 3D representation of the current state of the whole mapping framework. More...
 
virtual mxArraywriteToMatlab () 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...
 
High-level map management
void loadOptions (const std::string &configFile)
 Loads the options from a config file. More...
 
void loadOptions (const mrpt::config::CConfigFileBase &cfgSource)
 Loads the options from a config source. More...
 
void initializeEmptyMap ()
 Initializes the whole HMT-SLAM framework, reseting to an empty map (It also clears the logs directory) - this must be called AFTER loading the options with CHMTSLAM::loadOptions. More...
 
bool saveState (mrpt::serialization::CArchive &out) const
 Save the state of the whole HMT-SLAM framework to some binary stream (e.g. More...
 
bool loadState (mrpt::serialization::CArchive &in)
 Load the state of the whole HMT-SLAM framework from some binary stream (e.g. More...
 

Static Public Member Functions

static voidoperator new (size_t size, void *ptr)
 

Public Attributes

The important data.
CHierarchicalMHMap m_map
 The hiearchical, multi-hypothesis graph-based map. More...
 
mrpt::aligned_std_map< THypothesisID, CLocalMetricHypothesism_LMHs
 The list of LMHs at each instant. More...
 

Static Public Attributes

static mrpt::system::TConsoleColor logging_levels_to_colors [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
 
static std::string logging_levels_to_names [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding names. More...
 

Protected Member Functions

CSerializable virtual methods
uint8_t serializeGetVersion () const override
 Must return the current versioning number of the object. More...
 
void serializeTo (mrpt::serialization::CArchive &out) const override
 Pure virtual method for writing (serializing) to an abstract archive. More...
 
void serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
 Pure virtual method for reading (deserializing) from an abstract archive. More...
 
HMT-SLAM sub-processes.
void LSLAM_process_message (const mrpt::serialization::CMessage &msg)
 Auxiliary method within thread_LSLAM. More...
 
void LSLAM_process_message_from_AA (const TMessageLSLAMfromAA &myMsg)
 No critical section locks are assumed at the entrance of this method. More...
 
void LSLAM_process_message_from_TBI (const TMessageLSLAMfromTBI &myMsg)
 No critical section locks are assumed at the entrance of this method. More...
 
void perform_TLC (CLocalMetricHypothesis &LMH, const CHMHMapNode::TNodeID areaInLMH, const CHMHMapNode::TNodeID areaLoopClosure, const mrpt::poses::CPose3DPDFGaussian &pose1wrt2)
 Topological Loop Closure: Performs all the required operations to close a loop between two areas which have been determined to be the same. More...
 

Static Protected Member Functions

static TMessageLSLAMfromAA::Ptr areaAbstraction (CLocalMetricHypothesis *LMH, const TPoseIDList &newPoseIDs)
 The Area Abstraction (AA) method, invoked from LSLAM. More...
 
static TMessageLSLAMfromTBI::Ptr TBI_main_method (CLocalMetricHypothesis *LMH, const CHMHMapNode::TNodeID &areaID)
 The entry point for Topological Bayesian Inference (TBI) engines, invoked from LSLAM. More...
 
static std::string generateUniqueAreaLabel ()
 Generates a new and unique area textual label (currently this generates "0","1",...) More...
 
static TPoseID generatePoseID ()
 Generates a new and unique pose ID. More...
 
static THypothesisID generateHypothesisID ()
 Generates a new and unique hypothesis ID. More...
 

Protected Attributes

bool m_terminateThreads
 Termination flag for signaling all threads to terminate. More...
 
bool m_terminationFlag_LSLAM
 Threads termination flags: More...
 
bool m_terminationFlag_TBI
 
bool m_terminationFlag_3D_viewer
 
mrpt::hmtslam::CHMTSLAM::TOptions m_options
 
VerbosityLevel m_min_verbosity_level
 Provided messages with VerbosityLevel smaller than this value shall be ignored. More...
 
The different SLAM algorithms that can be invoked from the LSLAM

thread.

CLSLAMAlgorithmBasem_LSLAM_method
 An instance of a local SLAM method, to be applied to each LMH - initialized by "initializeEmptyMap" or "loadState". More...
 

Static Protected Attributes

static int64_t m_nextAreaLabel = 0
 
static TPoseID m_nextPoseID = 0
 
static THypothesisID m_nextHypID = COMMON_TOPOLOG_HYP + 1
 

Private Member Functions

std::string generateStringFromFormat (const char *fmt, va_list argp) const
 Helper method for generating a std::string instance from printf-like arguments. More...
 

Private Attributes

std::string m_logger_name
 
std::deque< TMsgm_history
 
std::deque< output_logger_callback_t > m_listCallbacks
 

Friends

class CLocalMetricHypothesis
 
class CLSLAM_RBPF_2DLASER
 
class CTopLCDetector_GridMatching
 
class CTopLCDetector_FabMap
 

RTTI stuff


using Ptr = std::shared_ptr< CHMTSLAM >
 
using ConstPtr = std::shared_ptr< const CHMTSLAM >
 
using UniquePtr = std::unique_ptr< CHMTSLAM >
 
using ConstUniquePtr = std::unique_ptr< const CHMTSLAM >
 
static mrpt::rtti::CLASSINIT _init_CHMTSLAM
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CHMTSLAM"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Inter-thread communication queues:

using CMessageQueue = mrpt::containers::CThreadSafeQueue< mrpt::serialization::CMessage >
 LSLAM thread input queue, messages of type CHMTSLAM::TMessageLSLAMfromAA. More...
 
CMessageQueue m_LSLAM_queue
 

Related to the input queue:

enum  TLSlamMethod { lsmRBPF_2DLASER = 1 }
 
std::queue< mrpt::serialization::CSerializable::Ptrm_inputQueue
 The queue of pending actions/observations supplied by the user waiting for being processed. More...
 
std::mutex m_inputQueue_cs
 Critical section for accessing m_inputQueue. More...
 
std::mutex m_map_cs
 Critical section for accessing m_map. More...
 
std::mutex m_LMHs_cs
 Critical section for accessing m_LMHs. More...
 
void clearInputQueue ()
 Empty the input queue. More...
 
bool isInputQueueEmpty ()
 Returns true if the input queue is empty (Note that the queue must not be empty to the user to enqueue more actions/observaitions) More...
 
size_t inputQueueSize ()
 Returns the number of objects waiting for processing in the input queue. More...
 
void pushAction (const mrpt::obs::CActionCollection::Ptr &acts)
 Here the user can enter an action into the system (will go to the SLAM process). More...
 
void pushObservations (const mrpt::obs::CSensoryFrame::Ptr &sf)
 Here the user can enter observations into the system (will go to the SLAM process). More...
 
void pushObservation (const mrpt::obs::CObservation::Ptr &obs)
 Here the user can enter an observation into the system (will go to the SLAM process). More...
 
mrpt::serialization::CSerializable::Ptr getNextObjectFromInputQueue ()
 Used from the LSLAM thread to retrieve the next object from the queue. More...
 

Threads stuff

std::thread m_hThread_LSLAM
 Threads handles. More...
 
std::thread m_hThread_TBI
 
std::thread m_hThread_3D_viewer
 
void thread_LSLAM ()
 The function for the "Local SLAM" thread. More...
 
void thread_TBI ()
 The function for the "TBI" thread. More...
 
void thread_3D_viewer ()
 The function for the "3D viewer" thread. More...
 

The different Loop-Closure modules that are to be executed in the

TBI thread.

using TLopLCDetectorFactory = CTopLCDetectorBase *(*)(CHMTSLAM *)
 
std::map< std::string, TLopLCDetectorFactorym_registeredLCDetectors
 
std::deque< CTopLCDetectorBase * > m_topLCdets
 The list of LC modules in operation - initialized by "initializeEmptyMap" or "loadState". More...
 
std::mutex m_topLCdets_cs
 The critical section for accessing m_topLCdets. More...
 
void registerLoopClosureDetector (const std::string &name, CTopLCDetectorBase *(*ptrCreateObject)(CHMTSLAM *))
 Must be invoked before calling initializeEmptyMap, so LC objects can be created. More...
 
CTopLCDetectorBaseloopClosureDetector_factory (const std::string &name)
 The class factory for topological loop closure detectors. More...
 

Logging methods

bool logging_enable_console_output
 [Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically. More...
 
bool logging_enable_keep_record
 [Default=false] Enables storing all messages into an internal list. More...
 
void logStr (const VerbosityLevel level, const std::string &msg_str) const
 Main method to add the specified message string to the logger. More...
 
void logFmt (const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
 Alternative logging method, which mimics the printf behavior. More...
 
void void logCond (const VerbosityLevel level, bool cond, const std::string &msg_str) const
 Log the given message only if the condition is satisfied. More...
 
void setLoggerName (const std::string &name)
 Set the name of the COutputLogger instance. More...
 
std::string getLoggerName () const
 Return the name of the COutputLogger instance. More...
 
void setMinLoggingLevel (const VerbosityLevel level)
 Set the minimum logging level for which the incoming logs are going to be taken into account. More...
 
void setVerbosityLevel (const VerbosityLevel level)
 alias of setMinLoggingLevel() More...
 
VerbosityLevel getMinLoggingLevel () const
 
bool isLoggingLevelVisible (VerbosityLevel level) const
 
void getLogAsString (std::string &log_contents) const
 Fill the provided string with the contents of the logger's history in std::string representation. More...
 
std::string getLogAsString () const
 Get the history of COutputLogger instance in a string representation. More...
 
void writeLogToFile (const std::string *fname_in=NULL) const
 Write the contents of the COutputLogger instance to an external file. More...
 
void dumpLogToConsole () const
 Dump the current contents of the COutputLogger instance in the terminal window. More...
 
std::string getLoggerLastMsg () const
 Return the last Tmsg instance registered in the logger history. More...
 
void getLoggerLastMsg (std::string &msg_str) const
 Fill inputtted string with the contents of the last message in history. More...
 
void loggerReset ()
 Reset the contents of the logger instance. More...
 
void logRegisterCallback (output_logger_callback_t userFunc)
 
bool logDeregisterCallback (output_logger_callback_t userFunc)
 

Member Typedef Documentation

◆ CMessageQueue

LSLAM thread input queue, messages of type CHMTSLAM::TMessageLSLAMfromAA.

Definition at line 162 of file CHMTSLAM.h.

◆ ConstPtr

using mrpt::hmtslam::CHMTSLAM::ConstPtr = std::shared_ptr<const CHMTSLAM >

Definition at line 76 of file CHMTSLAM.h.

◆ ConstUniquePtr

using mrpt::hmtslam::CHMTSLAM::ConstUniquePtr = std::unique_ptr<const CHMTSLAM >

Definition at line 76 of file CHMTSLAM.h.

◆ Ptr

using mrpt::hmtslam::CHMTSLAM::Ptr = std::shared_ptr< CHMTSLAM >

A type for the associated smart pointer

Definition at line 76 of file CHMTSLAM.h.

◆ TLopLCDetectorFactory

Definition at line 310 of file CHMTSLAM.h.

◆ UniquePtr

using mrpt::hmtslam::CHMTSLAM::UniquePtr = std::unique_ptr< CHMTSLAM >

Definition at line 76 of file CHMTSLAM.h.

Member Enumeration Documentation

◆ TLSlamMethod

Enumerator
lsmRBPF_2DLASER 

Definition at line 230 of file CHMTSLAM.h.

Constructor & Destructor Documentation

◆ CHMTSLAM() [1/2]

CHMTSLAM::CHMTSLAM ( )

Default constructor.

Parameters
debug_out_streamIf debug output messages should be redirected to any other stream apart from std::cout

Definition at line 56 of file CHMTSLAM_main.cpp.

◆ CHMTSLAM() [2/2]

mrpt::hmtslam::CHMTSLAM::CHMTSLAM ( const CHMTSLAM )
inline

Definition at line 366 of file CHMTSLAM.h.

References THROW_EXCEPTION.

◆ ~CHMTSLAM()

CHMTSLAM::~CHMTSLAM ( )
virtual

Destructor.

Definition at line 87 of file CHMTSLAM_main.cpp.

References mrpt::format(), MRPT_LOG_DEBUG, and MRPT_LOG_WARN.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::hmtslam::CHMTSLAM::_GetBaseClass ( )
staticprotected

◆ abortedDueToErrors()

bool CHMTSLAM::abortedDueToErrors ( )

Return true if an exception has been caught in any thread leading to the end of the mapping application: no more actions/observations will be processed from now on.

Definition at line 549 of file CHMTSLAM_main.cpp.

◆ areaAbstraction()

CHMTSLAM::TMessageLSLAMfromAA::Ptr CHMTSLAM::areaAbstraction ( CLocalMetricHypothesis LMH,
const TPoseIDList newPoseIDs 
)
staticprotected

◆ clearInputQueue()

void CHMTSLAM::clearInputQueue ( )

Empty the input queue.

Definition at line 157 of file CHMTSLAM_main.cpp.

◆ clone()

virtual mrpt::rtti::CObject* mrpt::hmtslam::CHMTSLAM::clone ( ) const
overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>
static Ptr mrpt::hmtslam::CHMTSLAM::Create ( Args &&...  args)
inlinestatic

Definition at line 76 of file CHMTSLAM.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::hmtslam::CHMTSLAM::CreateObject ( )
static

◆ CreateUnique()

template<typename... Args>
static UniquePtr mrpt::hmtslam::CHMTSLAM::CreateUnique ( Args &&...  args)
inlinestatic

Definition at line 76 of file CHMTSLAM.h.

◆ dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const
inherited

Dump the current contents of the COutputLogger instance in the terminal window.

See also
writeToFile

Definition at line 179 of file COutputLogger.cpp.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr 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 169 of file CObject.h.

References mrpt::rtti::CObject::clone().

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

◆ generateHypothesisID()

THypothesisID CHMTSLAM::generateHypothesisID ( )
staticprotected

Generates a new and unique hypothesis ID.

Definition at line 537 of file CHMTSLAM_main.cpp.

◆ generateLogFiles()

void CHMTSLAM::generateLogFiles ( unsigned int  nIteration)

◆ generatePoseID()

TPoseID CHMTSLAM::generatePoseID ( )
staticprotected

Generates a new and unique pose ID.

Definition at line 533 of file CHMTSLAM_main.cpp.

Referenced by mrpt::hmtslam::CLSLAM_RBPF_2DLASER::processOneLMH().

◆ generateStringFromFormat()

std::string COutputLogger::generateStringFromFormat ( const char *  fmt,
va_list  argp 
) const
privateinherited

Helper method for generating a std::string instance from printf-like arguments.

Definition at line 99 of file COutputLogger.cpp.

References mrpt::system::os::vsnprintf().

◆ generateUniqueAreaLabel()

std::string CHMTSLAM::generateUniqueAreaLabel ( )
staticprotected

Generates a new and unique area textual label (currently this generates "0","1",...)

Definition at line 525 of file CHMTSLAM_main.cpp.

References mrpt::format().

◆ getAs3DScene()

void CHMTSLAM::getAs3DScene ( mrpt::opengl::COpenGLScene outScene)

Gets a 3D representation of the current state of the whole mapping framework.

Definition at line 541 of file CHMTSLAM_main.cpp.

References MRPT_UNUSED_PARAM.

◆ getClassName()

static constexpr auto mrpt::hmtslam::CHMTSLAM::getClassName ( )
inlinestaticconstexpr

Definition at line 76 of file CHMTSLAM.h.

◆ getLogAsString() [1/2]

std::string COutputLogger::getLogAsString ( ) const
inherited

Get the history of COutputLogger instance in a string representation.

Definition at line 148 of file COutputLogger.cpp.

Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().

◆ getLogAsString() [2/2]

void COutputLogger::getLogAsString ( std::string log_contents) const
inherited

Fill the provided string with the contents of the logger's history in std::string representation.

Definition at line 143 of file COutputLogger.cpp.

◆ getLoggerLastMsg() [1/2]

std::string COutputLogger::getLoggerLastMsg ( ) const
inherited

Return the last Tmsg instance registered in the logger history.

Definition at line 184 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::TMsg::getAsString().

◆ getLoggerLastMsg() [2/2]

void COutputLogger::getLoggerLastMsg ( std::string msg_str) const
inherited

Fill inputtted string with the contents of the last message in history.

Definition at line 190 of file COutputLogger.cpp.

◆ getLoggerName()

std::string COutputLogger::getLoggerName ( ) const
inherited

Return the name of the COutputLogger instance.

See also
setLoggerName

Definition at line 132 of file COutputLogger.cpp.

Referenced by mrpt::system::COutputLogger::TMsg::TMsg().

◆ getMinLoggingLevel()

VerbosityLevel mrpt::system::COutputLogger::getMinLoggingLevel ( ) const
inlineinherited

◆ getNextObjectFromInputQueue()

CSerializable::Ptr CHMTSLAM::getNextObjectFromInputQueue ( )
protected

Used from the LSLAM thread to retrieve the next object from the queue.

Returns
The object, or nullptr if empty.

Definition at line 387 of file CHMTSLAM_main.cpp.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::hmtslam::CHMTSLAM::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::hmtslam::CHMTSLAM::GetRuntimeClassIdStatic ( )
static

◆ initializeEmptyMap()

void CHMTSLAM::initializeEmptyMap ( )

◆ inputQueueSize()

size_t CHMTSLAM::inputQueueSize ( )

Returns the number of objects waiting for processing in the input queue.

See also
pushAction,pushObservations, isInputQueueEmpty

Definition at line 374 of file CHMTSLAM_main.cpp.

◆ isInputQueueEmpty()

bool CHMTSLAM::isInputQueueEmpty ( )

Returns true if the input queue is empty (Note that the queue must not be empty to the user to enqueue more actions/observaitions)

See also
pushAction,pushObservations, inputQueueSize

Definition at line 360 of file CHMTSLAM_main.cpp.

◆ isLoggingLevelVisible()

bool mrpt::system::COutputLogger::isLoggingLevelVisible ( VerbosityLevel  level) const
inlineinherited

◆ loadOptions() [1/2]

void CHMTSLAM::loadOptions ( const mrpt::config::CConfigFileBase cfgSource)

Loads the options from a config source.

Definition at line 232 of file CHMTSLAM_main.cpp.

◆ loadOptions() [2/2]

void CHMTSLAM::loadOptions ( const std::string configFile)

Loads the options from a config file.

Definition at line 254 of file CHMTSLAM_main.cpp.

References ASSERT_, and mrpt::system::fileExists().

◆ loadState()

bool CHMTSLAM::loadState ( mrpt::serialization::CArchive in)

Load the state of the whole HMT-SLAM framework from some binary stream (e.g.

a file).

Returns
true if everything goes OK.
See also
saveState

Definition at line 593 of file CHMTSLAM_main.cpp.

◆ logCond()

void COutputLogger::logCond ( const VerbosityLevel  level,
bool  cond,
const std::string msg_str 
) const
inherited

Log the given message only if the condition is satisfied.

See also
log, logFmt

Definition at line 120 of file COutputLogger.cpp.

◆ logDeregisterCallback()

bool COutputLogger::logDeregisterCallback ( output_logger_callback_t  userFunc)
inherited
Returns
true if an entry was found and deleted.

Definition at line 287 of file COutputLogger.cpp.

References getAddress().

◆ logFmt()

void COutputLogger::logFmt ( const VerbosityLevel  level,
const char *  fmt,
  ... 
) const
inherited

◆ loggerReset()

void COutputLogger::loggerReset ( )
inherited

Reset the contents of the logger instance.

Called upon construction.

Definition at line 195 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

◆ logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc)
inherited

Definition at line 274 of file COutputLogger.cpp.

◆ logStr()

void COutputLogger::logStr ( const VerbosityLevel  level,
const std::string msg_str 
) const
inherited

◆ loopClosureDetector_factory()

CTopLCDetectorBase * CHMTSLAM::loopClosureDetector_factory ( const std::string name)

The class factory for topological loop closure detectors.

Possible values are enumerated in TOptions::TLC_detectors

Exceptions
std::exceptionOn unknown name.

Definition at line 567 of file CHMTSLAM_main.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION_FMT.

◆ LSLAM_process_message()

void CHMTSLAM::LSLAM_process_message ( const mrpt::serialization::CMessage msg)
protected

Auxiliary method within thread_LSLAM.

Definition at line 282 of file CHMTSLAM_LSLAM.cpp.

References MRPT_END, MRPT_START, and MRPT_UNUSED_PARAM.

◆ LSLAM_process_message_from_AA()

void CHMTSLAM::LSLAM_process_message_from_AA ( const TMessageLSLAMfromAA myMsg)
protected

No critical section locks are assumed at the entrance of this method.

Definition at line 312 of file CHMTSLAM_LSLAM.cpp.

References ARC_ANNOTATION_DELTA, ARC_ANNOTATION_DELTA_SRC_POSEID, ARC_ANNOTATION_DELTA_TRG_POSEID, mrpt::serialization::archiveFrom(), AREAID_INVALID, ASSERT_, begin(), mrpt::hmtslam::CLocalMetricHypothesis::changeCoordinateOrigin(), mrpt::poses::CPose3DPDFGaussian::copyFrom(), mrpt::poses::CPose3DPDFGaussian::cov, mrpt::DEG2RAD(), mrpt::poses::CPose3D::distanceEuclidean6D(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distanceTo(), mrpt::hmtslam::CLocalMetricHypothesis::dumpAsText(), mrpt::opengl::COpenGLScene::enableFollowCamera(), mrpt::containers::erase_return_next(), mrpt::bayes::CParticleFilterDataImpl< Derived, particle_list_t >::ESS(), mrpt::containers::list_searchable< T >::find(), mrpt::format(), mrpt::hmtslam::CLocalMetricHypothesis::getAs3DScene(), mrpt::poses::CPose3DPDFGaussian::getMean(), mrpt::hmtslam::CLocalMetricHypothesis::getMeans(), mrpt::bayes::CParticleFilterData< T, STORAGE >::getMostLikelyParticle(), mrpt::hmtslam::CLocalMetricHypothesis::getRelativePose(), mrpt::hmtslam::CHMTSLAM::TMessageLSLAMfromAA::hypothesisID, mrpt::containers::list_searchable< T >::insert(), mrpt::opengl::COpenGLScene::insert(), mrpt::obs::CSensoryFrame::insertObservationsInto(), mrpt::poses::CPose3DPDFGaussian::inverse(), mrpt::system::LVL_INFO, mrpt::hmtslam::CLocalMetricHypothesis::m_areasPendingTBI, mrpt::hmtslam::CLocalMetricHypothesis::m_currentRobotPose, mrpt::hmtslam::CLocalMetricHypothesis::m_ID, mrpt::hmtslam::CLocalMetricHypothesis::m_neighbors, mrpt::hmtslam::CLocalMetricHypothesis::m_nodeIDmemberships, mrpt::bayes::CParticleFilterData< T, STORAGE >::m_particles, mrpt::hmtslam::CLocalMetricHypothesis::m_posesPendingAddPartitioner, mrpt::hmtslam::CLocalMetricHypothesis::m_SFs, mrpt::poses::CPose3DPDFGaussian::mean, MRPT_END, MRPT_LOG_DEBUG_STREAM, MRPT_START, NODE_ANNOTATION_METRIC_MAPS, NODE_ANNOTATION_POSES_GRAPH, NODE_ANNOTATION_REF_POSEID, mrpt::hmtslam::CHMTSLAM::TMessageLSLAMfromAA::partitions, mrpt::hmtslam::TPoseInfo::pdf, POSEID_INVALID, mrpt::RAD2DEG(), mrpt::hmtslam::CLocalMetricHypothesis::removeAreaFromLMH(), mrpt::hmtslam::TPoseInfo::sf, mrpt::square(), mrpt::system::stringListAsString(), mrpt::system::CTicTac::Tac(), THROW_EXCEPTION, THROW_EXCEPTION_FMT, mrpt::system::CTicTac::Tic(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y(), and mrpt::poses::CPose3D::yaw().

◆ LSLAM_process_message_from_TBI()

void CHMTSLAM::LSLAM_process_message_from_TBI ( const TMessageLSLAMfromTBI myMsg)
protected

◆ operator delete() [1/3]

void mrpt::hmtslam::CHMTSLAM::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 76 of file CHMTSLAM.h.

◆ operator delete() [2/3]

void mrpt::hmtslam::CHMTSLAM::operator delete ( void ptr)
inlinenoexcept

Definition at line 76 of file CHMTSLAM.h.

◆ operator delete() [3/3]

void mrpt::hmtslam::CHMTSLAM::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 76 of file CHMTSLAM.h.

◆ operator delete[]()

void mrpt::hmtslam::CHMTSLAM::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 76 of file CHMTSLAM.h.

◆ operator new() [1/3]

void* mrpt::hmtslam::CHMTSLAM::operator new ( size_t  size)
inline

Definition at line 76 of file CHMTSLAM.h.

◆ operator new() [2/3]

void* mrpt::hmtslam::CHMTSLAM::operator new ( size_t  size,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 76 of file CHMTSLAM.h.

◆ operator new() [3/3]

static void* mrpt::hmtslam::CHMTSLAM::operator new ( size_t  size,
void ptr 
)
inlinestatic

Definition at line 76 of file CHMTSLAM.h.

◆ operator new[]()

void* mrpt::hmtslam::CHMTSLAM::operator new[] ( size_t  size)
inline

Definition at line 76 of file CHMTSLAM.h.

◆ operator=()

const CHMTSLAM& mrpt::hmtslam::CHMTSLAM::operator= ( const CHMTSLAM )
inline

Definition at line 370 of file CHMTSLAM.h.

References THROW_EXCEPTION.

◆ perform_TLC()

void CHMTSLAM::perform_TLC ( CLocalMetricHypothesis LMH,
const CHMHMapNode::TNodeID  areaInLMH,
const CHMHMapNode::TNodeID  areaLoopClosure,
const mrpt::poses::CPose3DPDFGaussian pose1wrt2 
)
protected

◆ pushAction()

void CHMTSLAM::pushAction ( const mrpt::obs::CActionCollection::Ptr acts)

Here the user can enter an action into the system (will go to the SLAM process).

This class will delete the passed object when required, so DO NOT DELETE the passed object after calling this.

See also
pushObservations,pushObservation

Definition at line 174 of file CHMTSLAM_main.cpp.

◆ pushObservation()

void CHMTSLAM::pushObservation ( const mrpt::obs::CObservation::Ptr obs)

Here the user can enter an observation into the system (will go to the SLAM process).

This class will delete the passed object when required, so DO NOT DELETE the passed object after calling this.

See also
pushAction,pushObservation

Definition at line 210 of file CHMTSLAM_main.cpp.

◆ pushObservations()

void CHMTSLAM::pushObservations ( const mrpt::obs::CSensoryFrame::Ptr sf)

Here the user can enter observations into the system (will go to the SLAM process).

This class will delete the passed object when required, so DO NOT DELETE the passed object after calling this.

See also
pushAction,pushObservation

Definition at line 192 of file CHMTSLAM_main.cpp.

◆ registerLoopClosureDetector()

void CHMTSLAM::registerLoopClosureDetector ( const std::string name,
CTopLCDetectorBase *(*)(CHMTSLAM *)  ptrCreateObject 
)

Must be invoked before calling initializeEmptyMap, so LC objects can be created.

Definition at line 558 of file CHMTSLAM_main.cpp.

◆ saveState()

bool CHMTSLAM::saveState ( mrpt::serialization::CArchive out) const

Save the state of the whole HMT-SLAM framework to some binary stream (e.g.

a file).

Returns
true if everything goes OK.
See also
loadState

Definition at line 580 of file CHMTSLAM_main.cpp.

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel().

◆ serializeFrom()

void CHMTSLAM::serializeFrom ( mrpt::serialization::CArchive in,
uint8_t  serial_version 
)
overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

Parameters
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 609 of file CHMTSLAM_main.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CHMTSLAM::serializeGetVersion ( ) const
overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 633 of file CHMTSLAM_main.cpp.

◆ serializeTo()

void CHMTSLAM::serializeTo ( mrpt::serialization::CArchive out) const
overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions
std::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 634 of file CHMTSLAM_main.cpp.

◆ setLoggerName()

void COutputLogger::setLoggerName ( const std::string name)
inherited

◆ setMinLoggingLevel()

void COutputLogger::setMinLoggingLevel ( const VerbosityLevel  level)
inherited

Set the minimum logging level for which the incoming logs are going to be taken into account.

String messages with specified VerbosityLevel smaller than the min, will not be outputted to the screen and neither will a record of them be stored in by the COutputLogger instance

Definition at line 133 of file COutputLogger.cpp.

Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::hwdrivers::CHokuyoURG::initialize(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams().

◆ setVerbosityLevel()

void COutputLogger::setVerbosityLevel ( const VerbosityLevel  level)
inherited

◆ TBI_main_method()

CHMTSLAM::TMessageLSLAMfromTBI::Ptr CHMTSLAM::TBI_main_method ( CLocalMetricHypothesis LMH,
const CHMHMapNode::TNodeID areaID 
)
staticprotected

The entry point for Topological Bayesian Inference (TBI) engines, invoked from LSLAM.

Parameters
LMH(IN) The LMH which to this query applies.
areaID(IN) The area ID to consider for potential loop-closures.
Note
The critical section for LMH must be locked BEFORE calling this method (it does NOT lock any critical section).

Definition at line 103 of file CHMTSLAM_TBI.cpp.

References ASSERT_, mrpt::poses::CPose3DPDFSOG::clear(), mrpt::hmtslam::CHMTSLAM::TMessageLSLAMfromTBI::TBI_info::delta_new_cur, IS_CLASS, mrpt::hmtslam::CHMTSLAM::TMessageLSLAMfromTBI::TBI_info::log_lik, mrpt::system::LVL_DEBUG, mrpt::hmtslam::CLocalMetricHypothesis::m_ID, mrpt::hmtslam::CLocalMetricHypothesis::m_neighbors, mrpt::hmtslam::CLocalMetricHypothesis::m_parent, MRPT_END, MRPT_START, and mrpt::hmtslam::CLocalMetricHypothesis::updateAreaFromLMH().

◆ thread_3D_viewer()

void CHMTSLAM::thread_3D_viewer ( )
protected

The function for the "3D viewer" thread.

Definition at line 31 of file CHMTSLAM_3D_viewer.cpp.

References mrpt::system::LVL_DEBUG, mrpt::system::LVL_ERROR, and MRPT_TODO.

◆ thread_LSLAM()

void CHMTSLAM::thread_LSLAM ( )
protected

◆ thread_TBI()

void CHMTSLAM::thread_TBI ( )
protected

◆ writeLogToFile()

void COutputLogger::writeLogToFile ( const std::string fname_in = NULL) const
inherited

Write the contents of the COutputLogger instance to an external file.

Upon call to this method, COutputLogger dumps the contents of all the logged commands so far to the specified external file. By default the filename is set to ${LOGGERNAME}.log except if the fname parameter is provided

See also
dumpToConsole, getAsString

Definition at line 154 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 nullptr is class does not support conversion to MATLAB.

Definition at line 70 of file CSerializable.h.

Friends And Related Function Documentation

◆ CLocalMetricHypothesis

friend class CLocalMetricHypothesis
friend

Definition at line 71 of file CHMTSLAM.h.

◆ CLSLAM_RBPF_2DLASER

friend class CLSLAM_RBPF_2DLASER
friend

Definition at line 72 of file CHMTSLAM.h.

◆ CTopLCDetector_FabMap

friend class CTopLCDetector_FabMap
friend

Definition at line 74 of file CHMTSLAM.h.

◆ CTopLCDetector_GridMatching

friend class CTopLCDetector_GridMatching
friend

Definition at line 73 of file CHMTSLAM.h.

Member Data Documentation

◆ _init_CHMTSLAM

mrpt::rtti::CLASSINIT mrpt::hmtslam::CHMTSLAM::_init_CHMTSLAM
staticprotected

Definition at line 76 of file CHMTSLAM.h.

◆ className

constexpr const char* mrpt::hmtslam::CHMTSLAM::className = "CHMTSLAM"
staticconstexpr

Definition at line 76 of file CHMTSLAM.h.

◆ logging_enable_console_output

bool mrpt::system::COutputLogger::logging_enable_console_output
inherited

[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically.

Definition at line 239 of file system/COutputLogger.h.

◆ logging_enable_keep_record

bool mrpt::system::COutputLogger::logging_enable_keep_record
inherited

[Default=false] Enables storing all messages into an internal list.

See also
writeLogToFile, getLogAsString

Definition at line 242 of file system/COutputLogger.h.

◆ logging_levels_to_colors

mrpt::system::TConsoleColor COutputLogger::logging_levels_to_colors
staticinherited
Initial value:

Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor.

Implementation file for the COutputLogger header class.

Handy for coloring the input based on the verbosity of the message

Definition at line 124 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::TMsg::dumpToConsole().

◆ logging_levels_to_names

std::string COutputLogger::logging_levels_to_names
staticinherited
Initial value:
=
{
"DEBUG",
"INFO ",
"WARN ",
"ERROR"
}

Map from VerbosityLevels to their corresponding names.

Handy for printing the current message VerbosityLevel along with the actual content

Definition at line 129 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::TMsg::getAsString().

◆ m_history

std::deque<TMsg> mrpt::system::COutputLogger::m_history
mutableprivateinherited

Definition at line 312 of file system/COutputLogger.h.

◆ m_hThread_3D_viewer

std::thread mrpt::hmtslam::CHMTSLAM::m_hThread_3D_viewer
protected

Definition at line 268 of file CHMTSLAM.h.

◆ m_hThread_LSLAM

std::thread mrpt::hmtslam::CHMTSLAM::m_hThread_LSLAM
protected

Threads handles.

Definition at line 268 of file CHMTSLAM.h.

◆ m_hThread_TBI

std::thread mrpt::hmtslam::CHMTSLAM::m_hThread_TBI
protected

Definition at line 268 of file CHMTSLAM.h.

◆ m_inputQueue

std::queue<mrpt::serialization::CSerializable::Ptr> mrpt::hmtslam::CHMTSLAM::m_inputQueue
protected

The queue of pending actions/observations supplied by the user waiting for being processed.

Definition at line 243 of file CHMTSLAM.h.

◆ m_inputQueue_cs

std::mutex mrpt::hmtslam::CHMTSLAM::m_inputQueue_cs
mutableprotected

Critical section for accessing m_inputQueue.

Definition at line 246 of file CHMTSLAM.h.

◆ m_listCallbacks

std::deque<output_logger_callback_t> mrpt::system::COutputLogger::m_listCallbacks
privateinherited

Definition at line 314 of file system/COutputLogger.h.

◆ m_LMHs

mrpt::aligned_std_map<THypothesisID, CLocalMetricHypothesis> mrpt::hmtslam::CHMTSLAM::m_LMHs

The list of LMHs at each instant.

Definition at line 418 of file CHMTSLAM.h.

◆ m_LMHs_cs

std::mutex mrpt::hmtslam::CHMTSLAM::m_LMHs_cs
mutableprotected

Critical section for accessing m_LMHs.

Definition at line 252 of file CHMTSLAM.h.

◆ m_logger_name

std::string mrpt::system::COutputLogger::m_logger_name
privateinherited

Definition at line 310 of file system/COutputLogger.h.

◆ m_LSLAM_method

CLSLAMAlgorithmBase* mrpt::hmtslam::CHMTSLAM::m_LSLAM_method
protected

An instance of a local SLAM method, to be applied to each LMH - initialized by "initializeEmptyMap" or "loadState".

Definition at line 302 of file CHMTSLAM.h.

◆ m_LSLAM_queue

CMessageQueue mrpt::hmtslam::CHMTSLAM::m_LSLAM_queue
protected

Definition at line 164 of file CHMTSLAM.h.

◆ m_map

CHierarchicalMHMap mrpt::hmtslam::CHMTSLAM::m_map

The hiearchical, multi-hypothesis graph-based map.

Definition at line 416 of file CHMTSLAM.h.

◆ m_map_cs

std::mutex mrpt::hmtslam::CHMTSLAM::m_map_cs
mutableprotected

Critical section for accessing m_map.

Definition at line 249 of file CHMTSLAM.h.

◆ m_min_verbosity_level

VerbosityLevel mrpt::system::COutputLogger::m_min_verbosity_level
protectedinherited

Provided messages with VerbosityLevel smaller than this value shall be ignored.

Definition at line 252 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::getMinLoggingLevel(), and mrpt::system::COutputLogger::isLoggingLevelVisible().

◆ m_nextAreaLabel

int64_t CHMTSLAM::m_nextAreaLabel = 0
staticprotected

Definition at line 355 of file CHMTSLAM.h.

◆ m_nextHypID

THypothesisID CHMTSLAM::m_nextHypID = COMMON_TOPOLOG_HYP + 1
staticprotected

Definition at line 357 of file CHMTSLAM.h.

◆ m_nextPoseID

TPoseID CHMTSLAM::m_nextPoseID = 0
staticprotected

Definition at line 356 of file CHMTSLAM.h.

◆ m_options

mrpt::hmtslam::CHMTSLAM::TOptions mrpt::hmtslam::CHMTSLAM::m_options
protected

◆ m_registeredLCDetectors

std::map<std::string, TLopLCDetectorFactory> mrpt::hmtslam::CHMTSLAM::m_registeredLCDetectors
protected

Definition at line 312 of file CHMTSLAM.h.

◆ m_terminateThreads

bool mrpt::hmtslam::CHMTSLAM::m_terminateThreads
protected

Termination flag for signaling all threads to terminate.

Definition at line 338 of file CHMTSLAM.h.

◆ m_terminationFlag_3D_viewer

bool mrpt::hmtslam::CHMTSLAM::m_terminationFlag_3D_viewer
protected

Definition at line 343 of file CHMTSLAM.h.

◆ m_terminationFlag_LSLAM

bool mrpt::hmtslam::CHMTSLAM::m_terminationFlag_LSLAM
protected

Threads termination flags:

Definition at line 342 of file CHMTSLAM.h.

◆ m_terminationFlag_TBI

bool mrpt::hmtslam::CHMTSLAM::m_terminationFlag_TBI
protected

Definition at line 342 of file CHMTSLAM.h.

◆ m_topLCdets

std::deque<CTopLCDetectorBase*> mrpt::hmtslam::CHMTSLAM::m_topLCdets
protected

The list of LC modules in operation - initialized by "initializeEmptyMap" or "loadState".


Definition at line 316 of file CHMTSLAM.h.

◆ m_topLCdets_cs

std::mutex mrpt::hmtslam::CHMTSLAM::m_topLCdets_cs
protected

The critical section for accessing m_topLCdets.

Definition at line 319 of file CHMTSLAM.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::hmtslam::CHMTSLAM::runtimeClassId
staticprotected

Definition at line 76 of file CHMTSLAM.h.

mrpt::system::COutputLogger::logStr
void logStr(const VerbosityLevel level, const std::string &msg_str) const
Main method to add the specified message string to the logger.
Definition: COutputLogger.cpp:61
mrpt::system::CONCOL_GREEN
@ CONCOL_GREEN
Definition: os.h:179
mrpt::system::CONCOL_BLUE
@ CONCOL_BLUE
Definition: os.h:178
mrpt::system::CONCOL_RED
@ CONCOL_RED
Definition: os.h:180
mrpt::system::COutputLogger::logFmt
void logFmt(const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
Alternative logging method, which mimics the printf behavior.
Definition: COutputLogger.cpp:80
mrpt::format
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:16
mrpt::system::CONCOL_NORMAL
@ CONCOL_NORMAL
Definition: os.h:177



Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST