Detailed Description

See also: CPointsMap

Definition at line 28 of file CDetectorDoorCrossing.h.

#include <mrpt/detectors/CDetectorDoorCrossing.h>

Inheritance diagram for mrpt::detectors::CDetectorDoorCrossing:

Classes
struct	TDoorCrossingOutParams
	A structure used as output in this method. More...

struct	TOptions
	In this structure parameters can be changed to customize the behaviour of this algorithm. More...

Public Member Functions
	CDetectorDoorCrossing ()
	The constructor. More...

void	process (mrpt::obs::CActionRobotMovement2D &in_poseChange, mrpt::obs::CSensoryFrame &in_sf, TDoorCrossingOutParams &out_estimation)
	The main method, where a new action/observation pair is added to the list. More...

void	clear ()
	Reset the detector, i.e. More...

Public Attributes
struct mrpt::detectors::CDetectorDoorCrossing::TOptions	options

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 Attributes
VerbosityLevel	m_min_verbosity_level
	Provided messages with VerbosityLevel smaller than this value shall be ignored. More...

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
mrpt::obs::CRawlog	lastObs
	The last observations and consecutive actions are stored here: Indexes (0,1) is the earlier (act,obs) pair, and the lastest pair is in indexes ((M-1)2,(M-1)2-1). More...

mrpt::maps::COccupancyGridMap2D::TEntropyInfo	entropy
	Entropy of current, and last "map patchs". More...

mrpt::maps::COccupancyGridMap2D::TEntropyInfo	lastEntropy

bool	lastEntropyValid

std::string	m_logger_name

std::deque< TMsg >	m_history

std::deque< output_logger_callback_t >	m_listCallbacks

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)

Constructor & Destructor Documentation

◆ CDetectorDoorCrossing()

CDetectorDoorCrossing::CDetectorDoorCrossing ( )

The constructor.

See options for customizing the default parameters.

Definition at line 25 of file CDetectorDoorCrossing.cpp.

References clear().

Member Function Documentation

◆ clear()

void CDetectorDoorCrossing::clear ( )

Reset the detector, i.e.

it erases all previous observations.

Definition at line 39 of file CDetectorDoorCrossing.cpp.

References mrpt::obs::CRawlog::clear(), lastEntropyValid, and lastObs.

Referenced by CDetectorDoorCrossing().

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

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

◆ 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

See also: setMinLoggingLevel

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

References mrpt::system::COutputLogger::m_min_verbosity_level.

Referenced by mrpt::maps::CRandomFieldGridMap2D::isEnabledVerbose(), and mrpt::slam::CMetricMapBuilderRBPF::processActionObservation().

◆ isLoggingLevelVisible()

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

inlineinherited

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

References mrpt::system::COutputLogger::m_min_verbosity_level.

Referenced by mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper().

◆ 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

Alternative logging method, which mimics the printf behavior.

Handy for not having to first use mrpt::format to pass a std::string message to logStr

// instead of:
logStr(mrpt::format("Today is the %d of %s, %d", 15, "July", 2016));
 
// one can use:
logFmt("Today is the %d of %s, %d", 15, "July", 2016);

See also: logStr, logCond

Definition at line 80 of file COutputLogger.cpp.

Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::CICPCriteriaNRD(), mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), CGraphSlamHandler< GRAPH_T >::execute(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), CGraphSlamHandler< GRAPH_T >::initOutputDir(), CGraphSlamHandler< GRAPH_T >::initVisualization(), mrpt::nav::CNavigatorManualSequence::navigationStep(), mrpt::nav::CAbstractNavigator::performNavigationStepNavigating(), CGraphSlamHandler< GRAPH_T >::readConfigFname(), CGraphSlamHandler< GRAPH_T >::saveResults(), CGraphSlamHandler< GRAPH_T >::setResultsDirName(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), and CGraphSlamHandler< GRAPH_T >::~CGraphSlamHandler().

◆ 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

Main method to add the specified message string to the logger.

See also: logCond, logFmt

Definition at line 61 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::TMsg::body, mrpt::system::COutputLogger::TMsg::dumpToConsole(), mrpt::system::COutputLogger::TMsg::level, mrpt::system::COutputLogger::TMsg::name, and mrpt::system::COutputLogger::TMsg::timestamp.

Referenced by mrpt::slam::PF_implementation< mrpt::math::TPose3D, CMonteCarloLocalization3D, mrpt::bayes::particle_storage_mode::VALUE >::PF_SLAM_implementation_pfAuxiliaryPFStandardAndOptimal(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), and mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper().

◆ process()

void CDetectorDoorCrossing::process	(	mrpt::obs::CActionRobotMovement2D &	in_poseChange,
		mrpt::obs::CSensoryFrame &	in_sf,
		TDoorCrossingOutParams &	out_estimation
	)

The main method, where a new action/observation pair is added to the list.

Here the list of old observations is updated, and a value with the probability of having pass a door is returned.

Parameters

in_poseChange	The odometry (or any other meanway) based change in the robot pose since last observation to this one.
in_sf	The observations.
out_estimation	The estimation results.

See also: TDoorCrossingOutParams

Definition at line 48 of file CDetectorDoorCrossing.cpp.

References mrpt::obs::CRawlog::addAction(), mrpt::obs::CRawlog::addObservations(), ASSERT_, CLASS_ID, mrpt::maps::CSimplePointsMap::copyFrom(), mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::cumulativeTurning, mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::enoughtInformation, entropy, mrpt::obs::CRawlog::getAsAction(), mrpt::obs::CRawlog::getAsObservations(), mrpt::detectors::CDetectorDoorCrossing::TOptions::gridResolution, mrpt::maps::COccupancyGridMap2D::TEntropyInfo::I, mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::informationGain, lastEntropy, lastEntropyValid, lastObs, mrpt::maps::CMultiMetricMap::m_gridMaps, mrpt::maps::CMultiMetricMap::m_pointsMaps, MRPT_END, MRPT_START, options, mrpt::poses::CPose2D::phi(), mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::pointsMap, mrpt::maps::TSetOfMetricMapInitializers::push_back(), mrpt::obs::CRawlog::remove(), mrpt::maps::COccupancyGridMap2D::TMapDefinition::resolution, mrpt::obs::CRawlog::size(), and mrpt::detectors::CDetectorDoorCrossing::TOptions::windowSize.

◆ setLoggerName()

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

inherited

Set the name of the COutputLogger instance.

See also: getLoggerName

Definition at line 127 of file COutputLogger.cpp.

Referenced by mrpt::slam::CMetricMapBuilderICP::CMetricMapBuilderICP(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::slam::CMonteCarloLocalization2D::CMonteCarloLocalization2D(), mrpt::slam::CMonteCarloLocalization3D::CMonteCarloLocalization3D(), and mrpt::graphslam::CWindowManager::initCWindowManager().

◆ 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

alias of setMinLoggingLevel()

Definition at line 138 of file COutputLogger.cpp.

Referenced by mrpt::nav::CAbstractNavigator::CAbstractNavigator(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::comms::CServerTCPSocket::CServerTCPSocket(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and mrpt::math::ransac_detect_2D_lines().

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

Member Data Documentation

◆ entropy

mrpt::maps::COccupancyGridMap2D::TEntropyInfo mrpt::detectors::CDetectorDoorCrossing::entropy

private

Entropy of current, and last "map patchs".

Definition at line 119 of file CDetectorDoorCrossing.h.

Referenced by process().

◆ lastEntropy

mrpt::maps::COccupancyGridMap2D::TEntropyInfo mrpt::detectors::CDetectorDoorCrossing::lastEntropy

private

Definition at line 119 of file CDetectorDoorCrossing.h.

Referenced by process().

◆ lastEntropyValid

bool mrpt::detectors::CDetectorDoorCrossing::lastEntropyValid

private

Definition at line 120 of file CDetectorDoorCrossing.h.

Referenced by clear(), and process().

◆ lastObs

mrpt::obs::CRawlog mrpt::detectors::CDetectorDoorCrossing::lastObs

private

The last observations and consecutive actions are stored here: Indexes (0,1) is the earlier (act,obs) pair, and the lastest pair is in indexes ((M-1)*2,(M-1)*2-1).

Always contains (Action, Observation) pairs, in that order.

Definition at line 116 of file CDetectorDoorCrossing.h.

Referenced by clear(), and process().

◆ 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:

= {
                CONCOL_BLUE,  
                CONCOL_NORMAL,  
                CONCOL_GREEN,  
                CONCOL_RED  
}

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_listCallbacks

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

privateinherited

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

◆ m_logger_name

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

privateinherited

Definition at line 310 of file system/COutputLogger.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().

◆ options

struct mrpt::detectors::CDetectorDoorCrossing::TOptions mrpt::detectors::CDetectorDoorCrossing::options

Referenced by process().

Detailed Description

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Logging methods

Constructor & Destructor Documentation

◆ CDetectorDoorCrossing()

Member Function Documentation

◆ clear()

◆ dumpLogToConsole()

◆ generateStringFromFormat()

◆ getLogAsString() [1/2]

◆ getLogAsString() [2/2]

◆ getLoggerLastMsg() [1/2]

◆ getLoggerLastMsg() [2/2]

◆ getLoggerName()

◆ getMinLoggingLevel()

◆ isLoggingLevelVisible()

◆ logCond()

◆ logDeregisterCallback()

◆ logFmt()

◆ loggerReset()

◆ logRegisterCallback()

◆ logStr()

◆ process()

◆ setLoggerName()

◆ setMinLoggingLevel()

◆ setVerbosityLevel()

◆ writeLogToFile()

Member Data Documentation

◆ entropy

◆ lastEntropy

◆ lastEntropyValid

◆ lastObs

◆ logging_enable_console_output

◆ logging_enable_keep_record

◆ logging_levels_to_colors

◆ logging_levels_to_names

◆ m_history

◆ m_listCallbacks

◆ m_logger_name

◆ m_min_verbosity_level

◆ options