MRPT  2.0.4
List of all members | Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Attributes
mrpt::detectors::CDetectorDoorCrossing Class Reference

Detailed Description

See also
CPointsMap

Definition at line 25 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...
 

Static Public Member Functions

static std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > & logging_levels_to_colors ()
 Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
 
static std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > & logging_levels_to_names ()
 Map from VerbosityLevels to their corresponding names. More...
 

Public Attributes

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

Protected Attributes

VerbosityLevel m_min_verbosity_level {LVL_INFO}
 Provided messages with VerbosityLevel smaller than this value shall be ignored. 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 {false}
 

Logging methods

bool logging_enable_console_output {true}
 [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 {false}
 [Default=false] Enables storing all messages into an internal list. More...
 
void logStr (const VerbosityLevel level, std::string_view 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=nullptr) 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().

Here is the call graph for this function:

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const
inherited

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

See also
writeToFile

Definition at line 190 of file COutputLogger.cpp.

◆ getLogAsString() [1/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 154 of file COutputLogger.cpp.

◆ getLogAsString() [2/2]

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

Get the history of COutputLogger instance in a string representation.

Definition at line 159 of file COutputLogger.cpp.

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

Here is the caller graph for this function:

◆ getLoggerLastMsg() [1/2]

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

Return the last Tmsg instance registered in the logger history.

Definition at line 195 of file COutputLogger.cpp.

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

Here is the call graph for this function:

◆ 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 201 of file COutputLogger.cpp.

◆ getLoggerName()

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

Return the name of the COutputLogger instance.

See also
setLoggerName

Definition at line 143 of file COutputLogger.cpp.

◆ getMinLoggingLevel()

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

◆ isLoggingLevelVisible()

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

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

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

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

Here is the caller graph for this function:

◆ 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 131 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 291 of file COutputLogger.cpp.

References getAddress(), and mrpt::system::COutputLogger::m_listCallbacks.

Here is the call graph for this function:

◆ 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 206 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

◆ logging_levels_to_colors()

std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_colors ( )
staticinherited

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

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

Definition at line 47 of file COutputLogger.cpp.

References logging_levels_to_colors.

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

Here is the caller graph for this function:

◆ logging_levels_to_names()

std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_names ( )
staticinherited

Map from VerbosityLevels to their corresponding names.

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

Definition at line 60 of file COutputLogger.cpp.

References logging_levels_to_names.

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

Here is the caller graph for this function:

◆ logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc)
inherited

Definition at line 278 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::m_listCallbacks.

◆ logStr()

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

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

See also
logCond, logFmt

Definition at line 72 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(), mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper(), and mrpt::system::CTimeLoggerSaveAtDtor::~CTimeLoggerSaveAtDtor().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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_poseChangeThe odometry (or any other meanway) based change in the robot pose since last observation to this one.
in_sfThe observations.
out_estimationThe estimation results.
See also
TDoorCrossingOutParams

Definition at line 48 of file CDetectorDoorCrossing.cpp.

References ASSERT_, CLASS_ID, mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::cumulativeTurning, mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::enoughInformation, entropy, mrpt::obs::CRawlog::getAsAction(), mrpt::obs::CRawlog::getAsObservations(), mrpt::detectors::CDetectorDoorCrossing::TOptions::gridResolution, mrpt::maps::COccupancyGridMap2D::TEntropyInfo::I, mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::informationGain, mrpt::obs::CRawlog::insert(), lastEntropy, lastEntropyValid, lastObs, mrpt::maps::CMultiMetricMap::mapByClass(), MRPT_END, MRPT_START, options, mrpt::poses::CPose2D::phi(), mrpt::detectors::CDetectorDoorCrossing::TDoorCrossingOutParams::pointsMap, mrpt::obs::CActionRobotMovement2D::poseChange, mrpt::maps::TSetOfMetricMapInitializers::push_back(), mrpt::obs::CRawlog::remove(), mrpt::maps::COccupancyGridMap2D::TMapDefinition::resolution, mrpt::obs::CRawlog::size(), and mrpt::detectors::CDetectorDoorCrossing::TOptions::windowSize.

Here is the call graph for this function:

◆ 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 144 of file COutputLogger.cpp.

Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), generic_kf_slam_test(), generic_pf_test(), generic_rbpf_slam_test(), mrpt::apps::RawlogGrabberApp::initialize(), mrpt::hwdrivers::CHokuyoURG::initialize(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams(), mrpt::apps::CGridMapAlignerApp::run(), mrpt::apps::RBPF_SLAM_App_Base::run(), and mrpt::apps::ICP_SLAM_App_Base::run().

Here is the caller graph for this function:

◆ setVerbosityLevel()

void COutputLogger::setVerbosityLevel ( const VerbosityLevel  level)
inherited

◆ writeLogToFile()

void COutputLogger::writeLogToFile ( const std::string *  fname_in = nullptr) 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 165 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

Here is the call graph for this function:

Member Data Documentation

◆ entropy

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

Entropy of current, and last "map patchs".

Definition at line 104 of file CDetectorDoorCrossing.h.

Referenced by process().

◆ lastEntropy

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

Definition at line 104 of file CDetectorDoorCrossing.h.

Referenced by process().

◆ lastEntropyValid

bool mrpt::detectors::CDetectorDoorCrossing::lastEntropyValid {false}
private

Definition at line 105 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 101 of file CDetectorDoorCrossing.h.

Referenced by clear(), and process().

◆ logging_enable_console_output

bool mrpt::system::COutputLogger::logging_enable_console_output {true}
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 240 of file system/COutputLogger.h.

◆ logging_enable_keep_record

bool mrpt::system::COutputLogger::logging_enable_keep_record {false}
inherited

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

See also
writeLogToFile, getLogAsString

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

◆ m_min_verbosity_level

VerbosityLevel mrpt::system::COutputLogger::m_min_verbosity_level {LVL_INFO}
protectedinherited

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

Definition at line 253 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().




Page generated by Doxygen 1.8.14 for MRPT 2.0.4 Git: 33de1d0ad Sat Jun 20 11:02:42 2020 +0200 at sáb jun 20 17:35:17 CEST 2020