Detailed Description

A class for storing a map of 3D probabilistic landmarks.

Currently these types of landmarks are defined: (see mrpt::maps::CLandmark)

For "visual landmarks" from images: features with associated descriptors.
For laser scanners: each of the range measuremnts, as "occupancy" landmarks.
For grid maps: "Panoramic descriptor" feature points.
For range-only localization and SLAM: Beacons. It is also supported the simulation of expected beacon-to-sensor readings, observation likelihood,...
How to load landmarks from observations:
When invoking CLandmarksMap::insertObservation(), the values in CLandmarksMap::insertionOptions will determinate the kind of landmarks that will be extracted and fused into the map. Supported feature extraction processes are listed next:

Observation class:	Generated Landmarks:	Comments:
CObservationImage	vlSIFT	1) A SIFT feature is created for each SIFT detected in the image, 2) Correspondences between SIFTs features and existing ones are finded by computeMatchingWith3DLandmarks, 3) The corresponding feaures are fused, and the new ones added, with an initial uncertainty according to insertionOptions
CObservationStereoImages	vlSIFT	Each image is separately procesed by the method for CObservationImage observations
CObservationStereoImages	vlColor	TODO...
CObservation2DRangeScan	glOccupancy	A landmark is added for each range in the scan, with its appropiate covariance matrix derived from the jacobians matrixes.

See also: CMetricMap

Definition at line 75 of file CLandmarksMap.h.

#include <mrpt/maps/CLandmarksMap.h>

Inheritance diagram for mrpt::maps::CLandmarksMap:

Classes
struct	TCustomSequenceLandmarks
	The list of landmarks: the wrapper class is just for maintaining the KD-Tree representation. More...

struct	TFuseOptions
	With this struct options are provided to the fusion process. More...

struct	TInsertionOptions
	With this struct options are provided to the observation insertion process. More...

struct	TInsertionResults
	This struct stores extra results from invoking insertObservation. More...

struct	TLikelihoodOptions
	With this struct options are provided to the likelihood computations. More...

struct	TMapDefinition

struct	TMapDefinitionBase

Public Types
typedef mrpt::maps::CLandmark	landmark_type

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

double	internal_computeObservationLikelihood (const mrpt::obs::CObservation *obs, const mrpt::poses::CPose3D &takenFrom) override
	Computes the (logarithmic) likelihood that a given observation was taken from a given pose in the world being modeled with this map. More...

	CLandmarksMap ()
	Constructor. More...

virtual	~CLandmarksMap ()
	Virtual destructor. More...

mrpt::maps::CLandmark::TLandmarkID	getMapMaxID ()

float	compute3DMatchingRatio (const mrpt::maps::CMetricMap *otherMap, const mrpt::poses::CPose3D &otherMapPose, const TMatchingRatioParams &params) const override
	Computes the ratio in [0,1] of correspondences between "this" and the "otherMap" map, whose 6D pose relative to "this" is "otherMapPose" In the case of a multi-metric map, this returns the average between the maps. More...

bool	saveToTextFile (std::string file)
	Save to a text file. More...

bool	saveToMATLABScript2D (std::string file, const char *style="b", float stdCount=2.0f)
	Save to a MATLAB script which displays 2D error ellipses for the map (top-view, projection on the XY plane). More...

bool	saveToMATLABScript3D (std::string file, const char *style="b", float confInterval=0.95f) const
	Save to a MATLAB script which displays 3D error ellipses for the map. More...

size_t	size () const
	Returns the stored landmarks count. More...

double	computeLikelihood_RSLC_2007 (const CLandmarksMap *s, const mrpt::poses::CPose2D &sensorPose)
	Computes the (logarithmic) likelihood function for a sensed observation "o" according to "this" map. More...

void	loadSiftFeaturesFromImageObservation (const mrpt::obs::CObservationImage &obs, const mrpt::vision::CFeatureExtraction::TOptions &feat_options=mrpt::vision::CFeatureExtraction::TOptions(mrpt::vision::featSIFT))
	Loads into this landmarks map the SIFT features extracted from an image observation (Previous contents of map will be erased) The robot is assumed to be at the origin of the map. More...

void	loadSiftFeaturesFromStereoImageObservation (const mrpt::obs::CObservationStereoImages &obs, mrpt::maps::CLandmark::TLandmarkID fID, const mrpt::vision::CFeatureExtraction::TOptions &feat_options=mrpt::vision::CFeatureExtraction::TOptions(mrpt::vision::featSIFT))
	Loads into this landmarks map the SIFT features extracted from an observation consisting of a pair of stereo-image (Previous contents of map will be erased) The robot is assumed to be at the origin of the map. More...

void	loadOccupancyFeaturesFrom2DRangeScan (const mrpt::obs::CObservation2DRangeScan &obs, const mrpt::poses::CPose3D *robotPose=nullptr, unsigned int downSampleFactor=1)
	Loads into this landmarks-map a set of occupancy features according to a 2D range scan (Previous contents of map will be erased) More...

void	computeMatchingWith2D (const mrpt::maps::CMetricMap otherMap, const mrpt::poses::CPose2D &otherMapPose, float maxDistForCorrespondence, float maxAngularDistForCorrespondence, const mrpt::poses::CPose2D &angularDistPivotPoint, mrpt::utils::TMatchingPairList &correspondences, float &correspondencesRatio, float sumSqrDist=nullptr, bool onlyKeepTheClosest=false, bool onlyUniqueRobust=false) const

void	computeMatchingWith3DLandmarks (const mrpt::maps::CLandmarksMap *otherMap, mrpt::utils::TMatchingPairList &correspondences, float &correspondencesRatio, std::vector< bool > &otherCorrespondences) const
	Perform a search for correspondences between "this" and another lansmarks map: In this class, the matching is established solely based on the landmarks' IDs. More...

void	changeCoordinatesReference (const mrpt::poses::CPose3D &newOrg)
	Changes the reference system of the map to a given 3D pose. More...

void	changeCoordinatesReference (const mrpt::poses::CPose3D &newOrg, const mrpt::maps::CLandmarksMap *otherMap)
	Changes the reference system of the map "otherMap" and save the result in "this" map. More...

void	fuseWith (CLandmarksMap &other, bool justInsertAllOfThem=false)
	Fuses the contents of another map with this one, updating "this" object with the result. More...

double	computeLikelihood_SIFT_LandmarkMap (CLandmarksMap map, mrpt::utils::TMatchingPairList correspondences=nullptr, std::vector< bool > *otherCorrespondences=nullptr)
	Returns the (logarithmic) likelihood of a set of landmarks "map" given "this" map. More...

bool	isEmpty () const override
	Returns true if the map is empty/no observation has been inserted. More...

void	simulateBeaconReadings (const mrpt::poses::CPose3D &in_robotPose, const mrpt::poses::CPoint3D &in_sensorLocationOnRobot, mrpt::obs::CObservationBeaconRanges &out_Observations) const
	Simulates a noisy reading toward each of the beacons in the landmarks map, if any. More...

void	simulateRangeBearingReadings (const mrpt::poses::CPose3D &robotPose, const mrpt::poses::CPose3D &sensorLocationOnRobot, mrpt::obs::CObservationBearingRange &observations, bool sensorDetectsIDs=true, const float stdRange=0.01f, const float stdYaw=mrpt::utils::DEG2RAD(0.1f), const float stdPitch=mrpt::utils::DEG2RAD(0.1f), vector_size_t *real_associations=nullptr, const double spurious_count_mean=0, const double spurious_count_std=0) const
	Simulates a noisy bearing-range observation of all the beacons (landamrks with type glBeacon) in the landmarks map, if any. More...

void	saveMetricMapRepresentationToFile (const std::string &filNamePrefix) const override
	This virtual method saves the map to a file "filNamePrefix"+< some_file_extension >, as an image or in any other applicable way (Notice that other methods to save the map may be implemented in classes implementing this virtual interface). More...

void	getAs3DObject (mrpt::opengl::CSetOfObjects::Ptr &outObj) const override
	Returns a 3D object representing the map. More...

virtual void	auxParticleFilterCleanUp () override
	This method is called at the end of each "prediction-update-map insertion" cycle within "mrpt::slam::CMetricMapBuilderRBPF::processActionObservation". More...

void	clear ()
	Erase all the contents of the map. More...

void	loadFromProbabilisticPosesAndObservations (const mrpt::maps::CSimpleMap &Map)
	Load the map contents from a CSimpleMap object, erasing all previous content of the map. More...

void	loadFromSimpleMap (const mrpt::maps::CSimpleMap &Map)
	! More...

bool	insertObservation (const mrpt::obs::CObservation obs, const mrpt::poses::CPose3D robotPose=NULL)
	Insert the observation information into this map. More...

bool	insertObservationPtr (const mrpt::obs::CObservation::Ptr &obs, const mrpt::poses::CPose3D *robotPose=NULL)
	A wrapper for smart pointers, just calls the non-smart pointer version. More...

double	computeObservationLikelihood (const mrpt::obs::CObservation *obs, const mrpt::poses::CPose3D &takenFrom)
	Computes the log-likelihood of a given observation given an arbitrary robot 3D pose. More...

double	computeObservationLikelihood (const mrpt::obs::CObservation *obs, const mrpt::poses::CPose2D &takenFrom)

virtual bool	canComputeObservationLikelihood (const mrpt::obs::CObservation *obs) const
	Returns true if this map is able to compute a sensible likelihood function for this observation (i.e. More...

bool	canComputeObservationLikelihood (const mrpt::obs::CObservation::Ptr &obs) const

double	computeObservationsLikelihood (const mrpt::obs::CSensoryFrame &sf, const mrpt::poses::CPose2D &takenFrom)
	Returns the sum of the log-likelihoods of each individual observation within a mrpt::obs::CSensoryFrame. More...

bool	canComputeObservationsLikelihood (const mrpt::obs::CSensoryFrame &sf) const
	Returns true if this map is able to compute a sensible likelihood function for this observation (i.e. More...

virtual void	determineMatching2D (const mrpt::maps::CMetricMap *otherMap, const mrpt::poses::CPose2D &otherMapPose, mrpt::utils::TMatchingPairList &correspondences, const TMatchingParams &params, TMatchingExtraResults &extraResults) const
	Computes the matching between this and another 2D point map, which includes finding: More...

virtual void	determineMatching3D (const mrpt::maps::CMetricMap *otherMap, const mrpt::poses::CPose3D &otherMapPose, mrpt::utils::TMatchingPairList &correspondences, const TMatchingParams &params, TMatchingExtraResults &extraResults) const
	Computes the matchings between this and another 3D points map - method used in 3D-ICP. More...

virtual float	squareDistanceToClosestCorrespondence (float x0, float y0) const
	Returns the square distance from the 2D point (x0,y0) to the closest correspondence in the map. More...

virtual const mrpt::maps::CSimplePointsMap *	getAsSimplePointsMap () const
	If the map is a simple points map or it's a multi-metric map that contains EXACTLY one simple points map, return it. More...

virtual mrpt::maps::CSimplePointsMap *	getAsSimplePointsMap ()

virtual mxArray *	writeToMatlab () 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...

RTTI classes and functions
mrpt::utils::CObject::Ptr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
struct mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks	landmarks

mrpt::maps::CLandmarksMap::TInsertionOptions	insertionOptions

mrpt::maps::CLandmarksMap::TLikelihoodOptions	likelihoodOptions

struct mrpt::maps::CLandmarksMap::TInsertionResults	insertionResults

struct mrpt::maps::CLandmarksMap::TFuseOptions	fuseOptions

TMapGenericParams	genericMapParams
	Common params to all maps. More...

Static Public Attributes
static mrpt::utils::TColorf	COLOR_LANDMARKS_IN_3DSCENES
	The color of landmark ellipsoids in CLandmarksMap::getAs3DObject. More...

static std::map< std::pair< mrpt::maps::CLandmark::TLandmarkID, mrpt::maps::CLandmark::TLandmarkID >, double >	_mEDD
	Map of the Euclidean Distance between the descriptors of two SIFT-based landmarks. More...

static mrpt::maps::CLandmark::TLandmarkID	_mapMaxID

static bool	_maxIDUpdated = false

Protected Member Functions
void	publishEvent (const mrptEvent &e) const
	Called when you want this object to emit an event to all the observers currently subscribed to this object. More...

bool	hasSubscribers () const
	Can be called by a derived class before preparing an event for publishing with publishEvent to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read. More...

CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version) override
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

Private Member Functions
void	internal_clear () override
	Internal method called by clear() More...

bool	internal_insertObservation (const mrpt::obs::CObservation obs, const mrpt::poses::CPose3D robotPose=nullptr) override
	Internal method called by insertObservation() More...

RTTI stuff
using	Ptr = std::shared_ptr< CLandmarksMap >

using	ConstPtr = std::shared_ptr< const CLandmarksMap >

static mrpt::utils::CLASSINIT	_init_CLandmarksMap

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CLandmarksMap"

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

static const mrpt::utils::TRuntimeClassId &	GetRuntimeClassIdStatic ()

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

template<typename... Args>
static Ptr	Create (Args &&... args)

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Map Definition Interface stuff (see * mrpt::maps::TMetricMapInitializer) @{
static const size_t	m_private_map_register_id = mrpt::maps::internal::TMetricMapTypesRegistry::Instance().doRegister( "CLandmarksMap,landmarksMap" , & mrpt::maps::CLandmarksMap ::MapDefinition, & mrpt::maps::CLandmarksMap ::internal_CreateFromMapDefinition)
	ID used to initialize class registration (just ignore it) More...

static mrpt::maps::TMetricMapInitializer *	MapDefinition ()
	Returns default map definition initializer. More...

static CLandmarksMap *	CreateFromMapDefinition (const mrpt::maps::TMetricMapInitializer &def)
	Constructor from a map definition structure: initializes the map and * its parameters accordingly. More...

static mrpt::maps::CMetricMap *	internal_CreateFromMapDefinition (const mrpt::maps::TMetricMapInitializer &def)

Member Typedef Documentation

◆ ConstPtr

using mrpt::maps::CLandmarksMap::ConstPtr = std::shared_ptr<const CLandmarksMap >

Definition at line 77 of file CLandmarksMap.h.

◆ landmark_type

typedef mrpt::maps::CLandmark mrpt::maps::CLandmarksMap::landmark_type

Definition at line 130 of file CLandmarksMap.h.

◆ Ptr

using mrpt::maps::CLandmarksMap::Ptr = std::shared_ptr< CLandmarksMap >

A typedef for the associated smart pointer

Definition at line 77 of file CLandmarksMap.h.

Constructor & Destructor Documentation

◆ CLandmarksMap()

CLandmarksMap::CLandmarksMap ( )

Constructor.

Definition at line 147 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::clear(), and landmarks.

Here is the call graph for this function:

◆ ~CLandmarksMap()

CLandmarksMap::~CLandmarksMap ( )

virtual

Virtual destructor.

Definition at line 162 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::clear(), and landmarks.

Here is the call graph for this function:

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::maps::CLandmarksMap::_GetBaseClass ( )

staticprotected

◆ auxParticleFilterCleanUp()

void CLandmarksMap::auxParticleFilterCleanUp ( )

overridevirtual

This method is called at the end of each "prediction-update-map insertion" cycle within "mrpt::slam::CMetricMapBuilderRBPF::processActionObservation".

This method should normally do nothing, but in some cases can be used to free auxiliary cached variables.

Reimplemented from mrpt::maps::CMetricMap.

Definition at line 2875 of file CLandmarksMap.cpp.

References _maxIDUpdated, and _mEDD.

◆ canComputeObservationLikelihood() [1/2]

bool CMetricMap::canComputeObservationLikelihood ( const mrpt::obs::CObservation * obs ) const

virtualinherited

Returns true if this map is able to compute a sensible likelihood function for this observation (i.e.

an occupancy grid map cannot with an image). See: Maps and observations compatibility matrix

Parameters

obs	The observation.

See also: computeObservationLikelihood, genericMapParams.enableObservationLikelihood

Definition at line 180 of file CMetricMap.cpp.

◆ canComputeObservationLikelihood() [2/2]

bool CMetricMap::canComputeObservationLikelihood ( const mrpt::obs::CObservation::Ptr & obs ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 121 of file CMetricMap.cpp.

◆ canComputeObservationsLikelihood()

bool CMetricMap::canComputeObservationsLikelihood ( const mrpt::obs::CSensoryFrame & sf ) const

inherited

Returns true if this map is able to compute a sensible likelihood function for this observation (i.e.

an occupancy grid map cannot with an image). See: Maps and observations compatibility matrix

Parameters

sf	The observations.

See also: canComputeObservationLikelihood

Definition at line 86 of file CMetricMap.cpp.

References mrpt::obs::CSensoryFrame::begin(), and mrpt::obs::CSensoryFrame::end().

Here is the call graph for this function:

◆ changeCoordinatesReference() [1/2]

void CLandmarksMap::changeCoordinatesReference ( const mrpt::poses::CPose3D & newOrg )

Changes the reference system of the map to a given 3D pose.

Definition at line 815 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::poses::CPose3D::composePoint(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::poses::CPose3D::getHomogeneousMatrix(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::hasBeenModifiedAll(), and landmarks.

Referenced by computeMatchingWith2D(), internal_computeObservationLikelihood(), internal_insertObservation(), loadOccupancyFeaturesFrom2DRangeScan(), and loadSiftFeaturesFromStereoImageObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeCoordinatesReference() [2/2]

void CLandmarksMap::changeCoordinatesReference	(	const mrpt::poses::CPose3D &	newOrg,
		const mrpt::maps::CLandmarksMap *	otherMap
	)

Changes the reference system of the map "otherMap" and save the result in "this" map.

Definition at line 896 of file CLandmarksMap.cpp.

Here is the call graph for this function:

◆ clear()

void CMetricMap::clear ( )

inherited

Erase all the contents of the map.

Definition at line 31 of file CMetricMap.cpp.

Referenced by mrpt::maps::CHeightGridMap2D_MRF::CHeightGridMap2D_MRF(), mrpt::maps::CReflectivityGridMap2D::clear(), mrpt::maps::CHeightGridMap2D::clear(), mrpt::maps::CRandomFieldGridMap2D::clear(), mrpt::maps::CPointsMap::extractCylinder(), mrpt::maps::CPointsMap::extractPoints(), mrpt::opengl::CAngularObservationMesh::generatePointCloud(), mrpt::maps::COccupancyGridMap2D::getAsPointCloud(), mrpt::opengl::CPlanarLaserScan::getBoundingBox(), mrpt::maps::CPointsMap::load2Dor3D_from_text_file(), loadOccupancyFeaturesFrom2DRangeScan(), mrpt::nav::CReactiveNavigationSystem3D::loggingGetWSObstaclesAndShape(), mrpt::hmtslam::CLocalMetricHypothesis::prediction_and_update(), mrpt::vision::projectMatchedFeatures(), mrpt::opengl::CPlanarLaserScan::render_dl(), run_rnav_test(), mrpt::maps::CPointsMap::setFromPCLPointCloud(), mrpt::maps::CColouredPointsMap::setFromPCLPointCloudRGB(), mrpt::maps::CRandomFieldGridMap2D::setSize(), mrpt::nav::PlannerTPS_VirtualBase::transformPointcloudWithSquareClipping(), and mrpt::hmtslam::CLocalMetricHypothesis::updateAreaFromLMH().

Here is the caller graph for this function:

◆ clone()

virtual mrpt::utils::CObject* mrpt::maps::CLandmarksMap::clone ( ) const

overridevirtual

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

Implements mrpt::utils::CObject.

◆ compute3DMatchingRatio()

float CLandmarksMap::compute3DMatchingRatio	(	const mrpt::maps::CMetricMap *	otherMap,
		const mrpt::poses::CPose3D &	otherMapPose,
		const TMatchingRatioParams &	params
	)		const

overridevirtual

Computes the ratio in [0,1] of correspondences between "this" and the "otherMap" map, whose 6D pose relative to "this" is "otherMapPose" In the case of a multi-metric map, this returns the average between the maps.

This method always return 0 for grid maps.

Parameters

otherMap	[IN] The other map to compute the matching with.
otherMapPose	[IN] The 6D pose of the other map as seen from "this".
params	[IN] Matching parameters

Returns: The matching ratio [0,1]

See also: determineMatching2D

Reimplemented from mrpt::maps::CMetricMap.

Definition at line 2744 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), CLASS_ID, mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::poses::CPose3D::getHomogeneousMatrix(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getLargestDistanceFromOrigin(), mrpt::maps::CMetricMap::GetRuntimeClass(), landmarks, MRPT_END, MRPT_START, mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::size(), and mrpt::math::square().

Here is the call graph for this function:

◆ computeLikelihood_RSLC_2007()

double CLandmarksMap::computeLikelihood_RSLC_2007	(	const CLandmarksMap *	s,
		const mrpt::poses::CPose2D &	sensorPose
	)

Computes the (logarithmic) likelihood function for a sensed observation "o" according to "this" map.

This is the implementation of the algorithm reported in the paper: J.L. Blanco, J. Gonzalez, and J.A. Fernandez-Madrigal, "A Consensus-based Approach for Estimating the Observation Likelihood of Accurate Range Sensors", in IEEE International Conference on Robotics and Automation (ICRA), Rome (Italy), Apr 10-14, 2007

Definition at line 1731 of file CLandmarksMap.cpp.

References ASSERT_, mrpt::utils::CDynamicGrid< T >::cellByIndex(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::get(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getGrid(), mrpt::maps::CLandmark::getPose(), mrpt::utils::CDynamicGrid< T >::getSizeX(), mrpt::utils::CDynamicGrid< T >::getSizeY(), landmarks, min, MRPT_CHECK_NORMAL_NUMBER, MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, mrpt::maps::CLandmark::pose_mean, mrpt::poses::CPointPDFGaussian::productIntegralNormalizedWith2D(), mrpt::math::TPoint3D::x, mrpt::utils::CDynamicGrid< T >::x2idx(), mrpt::math::TPoint3D::y, and mrpt::utils::CDynamicGrid< T >::y2idx().

Referenced by internal_computeObservationLikelihood().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeLikelihood_SIFT_LandmarkMap()

double CLandmarksMap::computeLikelihood_SIFT_LandmarkMap	(	CLandmarksMap *	map,
		mrpt::utils::TMatchingPairList *	correspondences = `nullptr`,
		std::vector< bool > *	otherCorrespondences = `nullptr`
	)

Returns the (logarithmic) likelihood of a set of landmarks "map" given "this" map.

See paper: JJAA 2006

/ saveToMATLABScript3D(std::string(("ver_ref.m")),"b."); theMap->saveToMATLABScript3D(std::string(("ver_sensed.m")),"r."); theMap->saveToTextFile(std::string("debug_map1.txt")); this->saveToTextFile(std::string("debug_map2.txt")); /

Definition at line 2027 of file CLandmarksMap.cpp.

Referenced by internal_computeObservationLikelihood().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMatchingWith2D()

void CLandmarksMap::computeMatchingWith2D	(	const mrpt::maps::CMetricMap *	otherMap,
		const mrpt::poses::CPose2D &	otherMapPose,
		float	maxDistForCorrespondence,
		float	maxAngularDistForCorrespondence,
		const mrpt::poses::CPose2D &	angularDistPivotPoint,
		mrpt::utils::TMatchingPairList &	correspondences,
		float &	correspondencesRatio,
		float *	sumSqrDist = `nullptr`,
		bool	onlyKeepTheClosest = `false`,
		bool	onlyUniqueRobust = `false`
	)		const

Definition at line 604 of file CLandmarksMap.cpp.

References ASSERT_, changeCoordinatesReference(), CLASS_ID, computeMatchingWith3DLandmarks(), mrpt::maps::CMetricMap::GetRuntimeClass(), MRPT_END, MRPT_START, and MRPT_UNUSED_PARAM.

Here is the call graph for this function:

◆ computeMatchingWith3DLandmarks()

void CLandmarksMap::computeMatchingWith3DLandmarks	(	const mrpt::maps::CLandmarksMap *	otherMap,
		mrpt::utils::TMatchingPairList &	correspondences,
		float &	correspondencesRatio,
		std::vector< bool > &	otherCorrespondences
	)		const

Perform a search for correspondences between "this" and another lansmarks map: In this class, the matching is established solely based on the landmarks' IDs.

Parameters

otherMap	[IN] The other map.
correspondences	[OUT] The matched pairs between maps.
correspondencesRatio	[OUT] This is NumberOfMatchings / NumberOfLandmarksInTheAnotherMap
otherCorrespondences	[OUT] Will be returned with a vector containing "true" for the indexes of the other map's landmarks with a correspondence.

Definition at line 1103 of file CLandmarksMap.cpp.

Referenced by computeMatchingWith2D(), and fuseWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeObservationLikelihood() [1/2]

double CMetricMap::computeObservationLikelihood	(	const mrpt::obs::CObservation *	obs,
		const mrpt::poses::CPose3D &	takenFrom
	)

inherited

Computes the log-likelihood of a given observation given an arbitrary robot 3D pose.

See: Maps and observations compatibility matrix

Parameters

takenFrom	The robot's pose the observation is supposed to be taken from.
obs	The observation.

Returns: This method returns a log-likelihood.

See also: Used in particle filter algorithms, see: CMultiMetricMapPDF::update

Definition at line 189 of file CMetricMap.cpp.

Referenced by mrpt::maps::CMultiMetricMapPDF::PF_SLAM_computeObservationLikelihoodForParticle().

Here is the caller graph for this function:

◆ computeObservationLikelihood() [2/2]

double CMetricMap::computeObservationLikelihood	(	const mrpt::obs::CObservation *	obs,
		const mrpt::poses::CPose2D &	takenFrom
	)

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 77 of file CMetricMap.cpp.

◆ computeObservationsLikelihood()

double CMetricMap::computeObservationsLikelihood	(	const mrpt::obs::CSensoryFrame &	sf,
		const mrpt::poses::CPose2D &	takenFrom
	)

inherited

Returns the sum of the log-likelihoods of each individual observation within a mrpt::obs::CSensoryFrame.

See: Maps and observations compatibility matrix

Parameters

takenFrom	The robot's pose the observation is supposed to be taken from.
sf	The set of observations in a CSensoryFrame.

Returns: This method returns a log-likelihood.

See also: canComputeObservationsLikelihood

Definition at line 67 of file CMetricMap.cpp.

References mrpt::obs::CSensoryFrame::begin(), and mrpt::obs::CSensoryFrame::end().

Referenced by mrpt::hmtslam::CLocalMetricHypothesis::auxiliarComputeObservationLikelihood().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

template<typename... Args>

static Ptr mrpt::maps::CLandmarksMap::Create ( Args &&... args )

inlinestatic

Definition at line 77 of file CLandmarksMap.h.

◆ CreateFromMapDefinition()

mrpt::maps::CLandmarksMap * mrpt::maps::CLandmarksMap::CreateFromMapDefinition ( const mrpt::maps::TMetricMapInitializer & def )

static

Constructor from a map definition structure: initializes the map and * its parameters accordingly.

Definition at line 46 of file CLandmarksMap.cpp.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::maps::CLandmarksMap::CreateObject ( )

static

◆ determineMatching2D()

void CMetricMap::determineMatching2D	(	const mrpt::maps::CMetricMap *	otherMap,
		const mrpt::poses::CPose2D &	otherMapPose,
		mrpt::utils::TMatchingPairList &	correspondences,
		const TMatchingParams &	params,
		TMatchingExtraResults &	extraResults
	)		const

virtualinherited

Computes the matching between this and another 2D point map, which includes finding:

The set of points pairs in each map
The mean squared distance between corresponding pairs.

The algorithm is:

For each point in "otherMap":
- Transform the point according to otherMapPose
- Search with a KD-TREE the closest correspondences in "this" map.
- Add to the set of candidate matchings, if it passes all the thresholds in params.

This method is the most time critical one into ICP-like algorithms.

Parameters

otherMap	[IN] The other map to compute the matching with.
otherMapPose	[IN] The pose of the other map as seen from "this".
params	[IN] Parameters for the determination of pairings.
correspondences	[OUT] The detected matchings pairs.
extraResults	[OUT] Other results.

See also: compute3DMatchingRatio

Reimplemented in mrpt::maps::COccupancyGridMap2D, mrpt::maps::CPointsMap, mrpt::maps::CMultiMetricMap, and mrpt::maps::CBeaconMap.

Definition at line 127 of file CMetricMap.cpp.

References MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

Referenced by mrpt::slam::CICP::ICP_Method_Classic().

Here is the caller graph for this function:

◆ determineMatching3D()

void CMetricMap::determineMatching3D	(	const mrpt::maps::CMetricMap *	otherMap,
		const mrpt::poses::CPose3D &	otherMapPose,
		mrpt::utils::TMatchingPairList &	correspondences,
		const TMatchingParams &	params,
		TMatchingExtraResults &	extraResults
	)		const

virtualinherited

Computes the matchings between this and another 3D points map - method used in 3D-ICP.

This method finds the set of point pairs in each map.

The method is the most time critical one into ICP-like algorithms.

The algorithm is:

For each point in "otherMap":
- Transform the point according to otherMapPose
- Search with a KD-TREE the closest correspondences in "this" map.
- Add to the set of candidate matchings, if it passes all the thresholds in params.

Parameters

otherMap	[IN] The other map to compute the matching with.
otherMapPose	[IN] The pose of the other map as seen from "this".
params	[IN] Parameters for the determination of pairings.
correspondences	[OUT] The detected matchings pairs.
extraResults	[OUT] Other results.

See also: compute3DMatchingRatio

Reimplemented in mrpt::maps::CPointsMap.

Definition at line 142 of file CMetricMap.cpp.

References MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

Referenced by mrpt::slam::CICP::ICP3D_Method_Classic().

Here is the caller graph for this function:

◆ fuseWith()

void CLandmarksMap::fuseWith	(	CLandmarksMap &	other,
		bool	justInsertAllOfThem = `false`
	)

Fuses the contents of another map with this one, updating "this" object with the result.

This process involves fusing corresponding landmarks, then adding the new ones.

Parameters

other	The other landmarkmap, whose landmarks will be inserted into "this"
justInsertAllOfThem	If set to "true", all the landmarks in "other" will be inserted into "this" without checking for possible correspondences (may appear duplicates ones, etc...)

Definition at line 989 of file CLandmarksMap.cpp.

Referenced by internal_insertObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAs3DObject()

void CLandmarksMap::getAs3DObject ( mrpt::opengl::CSetOfObjects::Ptr & outObj ) const

overridevirtual

Returns a 3D object representing the map.

See also: COLOR_LANDMARKS_IN_3DSCENES

Implements mrpt::maps::CMetricMap.

Definition at line 2659 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::poses::CPointPDFGaussian::cov, mrpt::maps::TMapGenericParams::enableSaveAs3DObject, mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::mrpt::format(), mrpt::maps::CMetricMap::genericMapParams, landmarks, and mrpt::poses::CPointPDFGaussian::mean.

Referenced by saveMetricMapRepresentationToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAsSimplePointsMap() [1/2]

virtual const mrpt::maps::CSimplePointsMap* mrpt::maps::CMetricMap::getAsSimplePointsMap ( ) const

inlinevirtualinherited

If the map is a simple points map or it's a multi-metric map that contains EXACTLY one simple points map, return it.

Otherwise, return NULL

Reimplemented in mrpt::maps::CPointsMap, mrpt::maps::CMultiMetricMap, and mrpt::maps::CSimplePointsMap.

Definition at line 301 of file CMetricMap.h.

Referenced by mrpt::maps::CPointsMap::compute3DMatchingRatio().

Here is the caller graph for this function:

◆ getAsSimplePointsMap() [2/2]

virtual mrpt::maps::CSimplePointsMap* mrpt::maps::CMetricMap::getAsSimplePointsMap ( )

inlinevirtualinherited

Reimplemented in mrpt::maps::CPointsMap, mrpt::maps::CMultiMetricMap, and mrpt::maps::CSimplePointsMap.

Definition at line 305 of file CMetricMap.h.

◆ getMapMaxID()

mrpt::maps::CLandmark::TLandmarkID CLandmarksMap::getMapMaxID ( )

Definition at line 2690 of file CLandmarksMap.cpp.

References _mapMaxID.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::maps::CLandmarksMap::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::maps::CMetricMap.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::maps::CLandmarksMap::GetRuntimeClassIdStatic ( )

static

◆ hasSubscribers()

bool mrpt::utils::CObservable::hasSubscribers ( ) const

inlineprotectedinherited

Can be called by a derived class before preparing an event for publishing with publishEvent to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read.

Definition at line 57 of file CObservable.h.

References mrpt::utils::CObservable::m_subscribers.

Referenced by mrpt::gui::CWindowDialog::OnMouseDown(), mrpt::gui::CWindowDialog::OnMouseMove(), mrpt::gui::CWindowDialog::OnResize(), and mrpt::opengl::COpenGLViewport::render().

Here is the caller graph for this function:

◆ insertObservation()

bool CMetricMap::insertObservation	(	const mrpt::obs::CObservation *	obs,
		const mrpt::poses::CPose3D *	robotPose = `NULL`
	)

inherited

Insert the observation information into this map.

This method must be implemented in derived classes. See: Maps and observations compatibility matrix

Parameters

obs	The observation
robotPose	The 3D pose of the robot mobile base in the map reference system, or NULL (default) if you want to use the origin.

See also: CObservation::insertObservationInto

Definition at line 95 of file CMetricMap.cpp.

Referenced by ICPTests::align2scans(), mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_likelihoodField_Thrun(), mrpt::opengl::CPlanarLaserScan::getBoundingBox(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::getICPEdge(), CAngularObservationMesh_fnctr::operator()(), mrpt::opengl::CPlanarLaserScan::render_dl(), TEST(), and mrpt::graphslam::CGraphSlamEngine< GRAPH_T >::updateMapVisualization().

Here is the caller graph for this function:

◆ insertObservationPtr()

bool CMetricMap::insertObservationPtr	(	const mrpt::obs::CObservation::Ptr &	obs,
		const mrpt::poses::CPose3D *	robotPose = `NULL`
	)

inherited

A wrapper for smart pointers, just calls the non-smart pointer version.

See: Maps and observations compatibility matrix

Definition at line 109 of file CMetricMap.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

Referenced by mrpt::slam::CMetricMapBuilderICP::processObservation().

Here is the caller graph for this function:

◆ internal_clear()

void CLandmarksMap::internal_clear ( )

overrideprivatevirtual

Internal method called by clear()

Implements mrpt::maps::CMetricMap.

Definition at line 166 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::clear(), and landmarks.

Here is the call graph for this function:

◆ internal_computeObservationLikelihood()

double CLandmarksMap::internal_computeObservationLikelihood	(	const mrpt::obs::CObservation *	obs,
		const mrpt::poses::CPose3D &	takenFrom
	)

overridevirtual

Computes the (logarithmic) likelihood that a given observation was taken from a given pose in the world being modeled with this map.

In the current implementation, this method behaves in a different way according to the nature of the observation's class:

"mrpt::obs::CObservation2DRangeScan": This calls "computeLikelihood_RSLC_2007".

"mrpt::obs::CObservationStereoImages": This calls "computeLikelihood_SIFT_LandmarkMap".

Observation class:	Generated Landmarks:	Comments:
CObservationImage	vlSIFT	1) A SIFT feature is created for each SIFT detected in the image, 2) Correspondences between SIFTs features and existing ones are found by computeMatchingWith3DLandmarks, 3) The corresponding feaures are fused, and the new ones added, with an initial uncertainty according to insertionOptions
CObservationStereoImages	vlSIFT	Each image is separately procesed by the method for CObservationImage observations
CObservationStereoImages	vlColor	TODO...
CObservation2DRangeScan	glOccupancy	A landmark is added for each range in the scan, with its appropiate covariance matrix derived from the jacobians matrixes.

Parameters

takenFrom	The robot's pose the observation is supposed to be taken from.
obs	The observation.

Returns: This method returns a likelihood value > 0.

See also: Used in particle filter algorithms, see: CMultiMetricMapPDF::update

Implements mrpt::maps::CMetricMap.

Definition at line 234 of file CLandmarksMap.cpp.

Here is the call graph for this function:

◆ internal_CreateFromMapDefinition()

mrpt::maps::CMetricMap * CLandmarksMap::internal_CreateFromMapDefinition ( const mrpt::maps::TMetricMapInitializer & def )

static

Definition at line 99 of file CLandmarksMap.cpp.

Here is the call graph for this function:

◆ internal_insertObservation()

bool CLandmarksMap::internal_insertObservation	(	const mrpt::obs::CObservation *	obs,
		const mrpt::poses::CPose3D *	robotPose = `nullptr`
	)

overrideprivatevirtual

Internal method called by insertObservation()

Implements mrpt::maps::CMetricMap.

Definition at line 479 of file CLandmarksMap.cpp.

References _mapMaxID, changeCoordinatesReference(), CLASS_ID, fuseWith(), mrpt::obs::CObservation::GetRuntimeClass(), mrpt::maps::CLandmarksMap::TInsertionOptions::insert_SIFTs_from_monocular_images, mrpt::maps::CLandmarksMap::TInsertionOptions::insert_SIFTs_from_stereo_images, insertionOptions, mrpt::obs::CObservationVisualLandmarks::landmarks, loadSiftFeaturesFromImageObservation(), loadSiftFeaturesFromStereoImageObservation(), MRPT_END, MRPT_START, mrpt::obs::CObservationVisualLandmarks::refCameraPose, and mrpt::maps::CLandmarksMap::TInsertionOptions::SIFT_feat_options.

Here is the call graph for this function:

◆ isEmpty()

bool CLandmarksMap::isEmpty ( ) const

overridevirtual

Returns true if the map is empty/no observation has been inserted.

Implements mrpt::maps::CMetricMap.

Definition at line 2572 of file CLandmarksMap.cpp.

References size().

Here is the call graph for this function:

◆ loadFromProbabilisticPosesAndObservations()

void CMetricMap::loadFromProbabilisticPosesAndObservations ( const mrpt::maps::CSimpleMap & Map )

inherited

Load the map contents from a CSimpleMap object, erasing all previous content of the map.

This is done invoking insertObservation() for each observation at the mean 3D robot pose of each pose-observations pair in the CSimpleMap object.

See also: insertObservation, CSimpleMap

Exceptions

std::exception Some internal steps in invoked methods can raise exceptions on invalid parameters, etc...

Definition at line 37 of file CMetricMap.cpp.

References ASSERTMSG_, mrpt::utils::clear(), mrpt::maps::CSimpleMap::get(), and mrpt::maps::CSimpleMap::size().

Referenced by mrpt::maps::CMetricMap::loadFromSimpleMap(), and run_test_pf_localization().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromSimpleMap()

void mrpt::maps::CMetricMap::loadFromSimpleMap ( const mrpt::maps::CSimpleMap & Map )

inlineinherited

!

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 109 of file CMetricMap.h.

References mrpt::maps::CMetricMap::loadFromProbabilisticPosesAndObservations().

Referenced by mrpt::maps::CRandomFieldGridMap2D::internal_clear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadOccupancyFeaturesFrom2DRangeScan()

void CLandmarksMap::loadOccupancyFeaturesFrom2DRangeScan	(	const mrpt::obs::CObservation2DRangeScan &	obs,
		const mrpt::poses::CPose3D *	robotPose = `nullptr`,
		unsigned int	downSampleFactor = `1`
	)

Loads into this landmarks-map a set of occupancy features according to a 2D range scan (Previous contents of map will be erased)

Parameters

obs	The observation
robotPose	The robot pose in the map (Default = the origin) Some options may be applicable from "insertionOptions"

Definition at line 1631 of file CLandmarksMap.cpp.

Referenced by internal_computeObservationLikelihood().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadSiftFeaturesFromImageObservation()

void CLandmarksMap::loadSiftFeaturesFromImageObservation	(	const mrpt::obs::CObservationImage &	obs,
		const mrpt::vision::CFeatureExtraction::TOptions &	feat_options = `mrpt::vision::CFeatureExtraction::TOptions(mrpt::vision::featSIFT)`
	)

Loads into this landmarks map the SIFT features extracted from an image observation (Previous contents of map will be erased) The robot is assumed to be at the origin of the map.

Some options may be applicable from "insertionOptions" (insertionOptions.SIFTsLoadDistanceOfTheMean)

Parameters

feat_options Optionally, you can pass here parameters for changing the default SIFT detector settings.

Definition at line 644 of file CLandmarksMap.cpp.

Referenced by internal_insertObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadSiftFeaturesFromStereoImageObservation()

void CLandmarksMap::loadSiftFeaturesFromStereoImageObservation	(	const mrpt::obs::CObservationStereoImages &	obs,
		mrpt::maps::CLandmark::TLandmarkID	fID,
		const mrpt::vision::CFeatureExtraction::TOptions &	feat_options = `mrpt::vision::CFeatureExtraction::TOptions(mrpt::vision::featSIFT)`
	)

Loads into this landmarks map the SIFT features extracted from an observation consisting of a pair of stereo-image (Previous contents of map will be erased) The robot is assumed to be at the origin of the map.

Some options may be applicable from "insertionOptions"

Parameters

feat_options Optionally, you can pass here parameters for changing the default SIFT detector settings.

Definition at line 730 of file CLandmarksMap.cpp.

Referenced by internal_computeObservationLikelihood(), and internal_insertObservation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MapDefinition()

mrpt::maps::TMetricMapInitializer * mrpt::maps::CLandmarksMap::MapDefinition ( )

static

Returns default map definition initializer.

See * mrpt::maps::TMetricMapInitializer

Definition at line 46 of file CLandmarksMap.cpp.

◆ operator delete() [1/3]

void mrpt::maps::CLandmarksMap::operator delete ( void * ptr )

inlinenoexcept

Definition at line 77 of file CLandmarksMap.h.

◆ operator delete() [2/3]

void mrpt::maps::CLandmarksMap::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 77 of file CLandmarksMap.h.

◆ operator delete() [3/3]

void mrpt::maps::CLandmarksMap::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 77 of file CLandmarksMap.h.

◆ operator delete[]()

void mrpt::maps::CLandmarksMap::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 77 of file CLandmarksMap.h.

◆ operator new() [1/3]

void* mrpt::maps::CLandmarksMap::operator new ( size_t size )

inline

Definition at line 77 of file CLandmarksMap.h.

◆ operator new() [2/3]

void* mrpt::maps::CLandmarksMap::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 77 of file CLandmarksMap.h.

◆ operator new() [3/3]

static void* mrpt::maps::CLandmarksMap::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 77 of file CLandmarksMap.h.

◆ operator new[]()

void* mrpt::maps::CLandmarksMap::operator new[] ( size_t size )

inline

Definition at line 77 of file CLandmarksMap.h.

◆ publishEvent()

void CObservable::publishEvent ( const mrptEvent & e ) const

protectedinherited

Called when you want this object to emit an event to all the observers currently subscribed to this object.

Definition at line 47 of file CObservable.cpp.

References MRPT_END, and MRPT_START.

Referenced by mrpt::gui::CDisplayWindow3D::internal_emitGrabImageEvent(), mrpt::gui::CWindowDialog::OnChar(), mrpt::gui::CWindowDialog::OnClose(), mrpt::gui::C3DWindowDialog::OnClose(), mrpt::gui::CWindowDialog::OnMouseDown(), mrpt::gui::CWindowDialog::OnMouseMove(), mrpt::gui::CWindowDialog::OnResize(), mrpt::gui::C3DWindowDialog::OnResize(), and mrpt::opengl::COpenGLViewport::render().

Here is the caller graph for this function:

◆ readFromStream()

void CLandmarksMap::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

overrideprotectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 199 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::clear(), landmarks, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::push_back().

Here is the call graph for this function:

◆ saveMetricMapRepresentationToFile()

void CLandmarksMap::saveMetricMapRepresentationToFile ( const std::string & filNamePrefix ) const

overridevirtual

This virtual method saves the map to a file "filNamePrefix"+< some_file_extension >, as an image or in any other applicable way (Notice that other methods to save the map may be implemented in classes implementing this virtual interface).

In the case of this class, these files are generated:

"filNamePrefix"+"_3D.m": A script for MATLAB for drawing landmarks as 3D ellipses.
"filNamePrefix"+"_3D.3DScene": A 3D scene with a "ground plane grid" and the set of ellipsoids in 3D.

Implements mrpt::maps::CMetricMap.

Definition at line 2627 of file CLandmarksMap.cpp.

References getAs3DObject(), mrpt::opengl::COpenGLScene::insert(), MRPT_END, MRPT_START, and saveToMATLABScript3D().

Here is the call graph for this function:

◆ saveToMATLABScript2D()

bool CLandmarksMap::saveToMATLABScript2D	(	std::string	file,
		const char *	style = `"b"`,
		float	stdCount = `2.0f`
	)

Save to a MATLAB script which displays 2D error ellipses for the map (top-view, projection on the XY plane).

Parameters

file	The name of the file to save the script to.
style	The MATLAB-like string for the style of the lines (see 'help plot' in MATLAB for posibilities)
stdCount	The ellipsoids will be drawn from the center to "stdCount" times the "standard deviations". (default is 2std = 95% confidence intervals)

Returns: Returns false if any error occured, true elsewere.

Definition at line 1537 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::math::cov(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::system::os::fclose(), mrpt::system::os::fopen(), mrpt::system::os::fprintf(), landmarks, and M_2PI.

Here is the call graph for this function:

◆ saveToMATLABScript3D()

bool CLandmarksMap::saveToMATLABScript3D	(	std::string	file,
		const char *	style = `"b"`,
		float	confInterval = `0.95f`
	)		const

Save to a MATLAB script which displays 3D error ellipses for the map.

Parameters

file	The name of the file to save the script to.
style	The MATLAB-like string for the style of the lines (see 'help plot' in MATLAB for posibilities)
stdCount	The ellipsoids will be drawn from the center to a given confidence interval in [0,1], e.g. 2 sigmas=0.95 (default is 2std = 0.95 confidence intervals)

Returns: Returns false if any error occured, true elsewere.

Definition at line 1486 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::system::os::fclose(), mrpt::system::os::fopen(), mrpt::system::os::fprintf(), and landmarks.

Referenced by saveMetricMapRepresentationToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToTextFile()

bool CLandmarksMap::saveToTextFile ( std::string file )

Save to a text file.

In line "i" there are the (x,y,z) mean values of the i'th landmark + type of landmark + # times seen + timestamp + RGB/descriptor + ID

Returns false if any error occured, true elsewere.

Definition at line 1438 of file CLandmarksMap.cpp.

References ASSERT_, mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), mrpt::system::extractDayTimeFromTimestamp(), mrpt::system::os::fclose(), mrpt::vision::featSIFT, mrpt::system::os::fopen(), mrpt::system::os::fprintf(), INVALID_TIMESTAMP, landmarks, MRPT_END, and MRPT_START.

Here is the call graph for this function:

◆ simulateBeaconReadings()

void CLandmarksMap::simulateBeaconReadings	(	const mrpt::poses::CPose3D &	in_robotPose,
		const mrpt::poses::CPoint3D &	in_sensorLocationOnRobot,
		mrpt::obs::CObservationBeaconRanges &	out_Observations
	)		const

Simulates a noisy reading toward each of the beacons in the landmarks map, if any.

Parameters

in_robotPose	This robot pose is used to simulate the ranges to each beacon.
in_sensorLocationOnRobot	The 3D position of the sensor on the robot
out_Observations	The results will be stored here. NOTICE that the fields "CObservationBeaconRanges::minSensorDistance","CObservationBeaconRanges::maxSensorDistance" and "CObservationBeaconRanges::stdError" MUST BE FILLED OUT before calling this function. An observation will be generated for each beacon in the map, but notice that some of them may be missed if out of the sensor maximum range.

Definition at line 2576 of file CLandmarksMap.cpp.

Here is the call graph for this function:

◆ simulateRangeBearingReadings()

void CLandmarksMap::simulateRangeBearingReadings	(	const mrpt::poses::CPose3D &	robotPose,
		const mrpt::poses::CPose3D &	sensorLocationOnRobot,
		mrpt::obs::CObservationBearingRange &	observations,
		bool	sensorDetectsIDs = `true`,
		const float	stdRange = `0.01f`,
		const float	stdYaw = `mrpt::utils::DEG2RAD(0.1f)`,
		const float	stdPitch = `mrpt::utils::DEG2RAD(0.1f)`,
		vector_size_t *	real_associations = `nullptr`,
		const double	spurious_count_mean = `0`,
		const double	spurious_count_std = `0`
	)		const

Simulates a noisy bearing-range observation of all the beacons (landamrks with type glBeacon) in the landmarks map, if any.

Parameters

[in]	robotPose	The robot pose.
[in]	sensorLocationOnRobot	The 3D position of the sensor on the robot
[out]	observations	The results will be stored here.
[in]	sensorDetectsIDs	If this is set to false, all the landmarks will be sensed with INVALID_LANDMARK_ID as ID.
[in]	stdRange	The sigma of the sensor noise in range (meters).
[in]	stdYaw	The sigma of the sensor noise in yaw (radians).
[in]	stdPitch	The sigma of the sensor noise in pitch (radians).
[out]	real_associations	If it's not a nullptr pointer, this will contain at the return the real indices of the landmarks in the map in the same order than they appear in out_Observations. Useful when sensorDetectsIDs=false. Spurious readings are assigned a std::string::npos (=-1) index.
[in]	spurious_count_mean	The mean number of spurious measurements (uniformly distributed in range & angle) to generate. The number of spurious is generated by rounding a random Gaussin number. If both this mean and the std are zero (the default) no spurious readings are generated.
[in]	spurious_count_std	Read spurious_count_mean above.

Note: The fields "CObservationBearingRange::fieldOfView_*","CObservationBearingRange::maxSensorDistance" and "CObservationBearingRange::minSensorDistance" MUST BE FILLED OUT before calling this function.; At output, the observation will have CObservationBearingRange::validCovariances set to "false" and the 3 sensor_std_* members correctly set to their values. An observation will be generated for each beacon in the map, but notice that some of them may be missed if out of the sensor maximum range or field of view-

Definition at line 2894 of file CLandmarksMap.cpp.

Here is the call graph for this function:

◆ size()

size_t CLandmarksMap::size ( ) const

Returns the stored landmarks count.

Definition at line 170 of file CLandmarksMap.cpp.

References landmarks, and mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::size().

Referenced by computeLikelihood_SIFT_LandmarkMap(), fuseWith(), internal_computeObservationLikelihood(), and isEmpty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ squareDistanceToClosestCorrespondence()

float CMetricMap::squareDistanceToClosestCorrespondence	(	float	x0,
		float	y0
	)		const

virtualinherited

Returns the square distance from the 2D point (x0,y0) to the closest correspondence in the map.

Reimplemented in mrpt::maps::CPointsMap.

Definition at line 170 of file CMetricMap.cpp.

References MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::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 89 of file CSerializable.h.

◆ writeToStream()

void CLandmarksMap::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

overrideprotectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If nullptr, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 176 of file CLandmarksMap.cpp.

References mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin(), mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end(), landmarks, and mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::size().

Here is the call graph for this function:

Member Data Documentation

◆ _init_CLandmarksMap

mrpt::utils::CLASSINIT mrpt::maps::CLandmarksMap::_init_CLandmarksMap

staticprotected

Definition at line 77 of file CLandmarksMap.h.

◆ _mapMaxID

mrpt::maps::CLandmark::TLandmarkID CLandmarksMap::_mapMaxID

static

Definition at line 216 of file CLandmarksMap.h.

Referenced by getMapMaxID(), internal_computeObservationLikelihood(), and internal_insertObservation().

◆ _maxIDUpdated

bool CLandmarksMap::_maxIDUpdated = false

static

Definition at line 217 of file CLandmarksMap.h.

Referenced by auxParticleFilterCleanUp(), and internal_computeObservationLikelihood().

◆ _mEDD

std::map< std::pair< mrpt::maps::CLandmark::TLandmarkID, mrpt::maps::CLandmark::TLandmarkID >, double > CLandmarksMap::_mEDD

static

Map of the Euclidean Distance between the descriptors of two SIFT-based landmarks.

Definition at line 215 of file CLandmarksMap.h.

Referenced by auxParticleFilterCleanUp(), computeLikelihood_SIFT_LandmarkMap(), and computeMatchingWith3DLandmarks().

◆ className

constexpr const char* mrpt::maps::CLandmarksMap::className = "CLandmarksMap"

static

Definition at line 77 of file CLandmarksMap.h.

◆ COLOR_LANDMARKS_IN_3DSCENES

mrpt::utils::TColorf mrpt::maps::CLandmarksMap::COLOR_LANDMARKS_IN_3DSCENES

static

The color of landmark ellipsoids in CLandmarksMap::getAs3DObject.

Definition at line 128 of file CLandmarksMap.h.

◆ fuseOptions

struct mrpt::maps::CLandmarksMap::TFuseOptions mrpt::maps::CLandmarksMap::fuseOptions

Referenced by fuseWith().

◆ genericMapParams

TMapGenericParams mrpt::maps::CMetricMap::genericMapParams

inherited

Common params to all maps.

Definition at line 281 of file CMetricMap.h.

Referenced by mrpt::maps::internal::TMetricMapTypesRegistry::factoryMapObjectFromDefinition(), mrpt::maps::CWirelessPowerGridMap2D::getAs3DObject(), mrpt::maps::CGasConcentrationGridMap2D::getAs3DObject(), mrpt::maps::CReflectivityGridMap2D::getAs3DObject(), mrpt::maps::CHeightGridMap2D::getAs3DObject(), mrpt::maps::CBeaconMap::getAs3DObject(), mrpt::maps::CRandomFieldGridMap2D::getAs3DObject(), getAs3DObject(), mrpt::maps::CPointsMap::getAs3DObject(), mrpt::maps::CWirelessPowerGridMap2D::readFromStream(), mrpt::maps::CGasConcentrationGridMap2D::readFromStream(), mrpt::maps::CReflectivityGridMap2D::readFromStream(), mrpt::maps::CHeightGridMap2D::readFromStream(), mrpt::maps::CWirelessPowerGridMap2D::writeToStream(), mrpt::maps::CGasConcentrationGridMap2D::writeToStream(), mrpt::maps::CReflectivityGridMap2D::writeToStream(), and mrpt::maps::CHeightGridMap2D::writeToStream().

◆ insertionOptions

mrpt::maps::CLandmarksMap::TInsertionOptions mrpt::maps::CLandmarksMap::insertionOptions

Referenced by mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), computeLikelihood_SIFT_LandmarkMap(), computeMatchingWith3DLandmarks(), internal_computeObservationLikelihood(), internal_insertObservation(), loadSiftFeaturesFromImageObservation(), and loadSiftFeaturesFromStereoImageObservation().

◆ insertionResults

struct mrpt::maps::CLandmarksMap::TInsertionResults mrpt::maps::CLandmarksMap::insertionResults

◆ landmarks

struct mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks mrpt::maps::CLandmarksMap::landmarks

Referenced by changeCoordinatesReference(), CLandmarksMap(), mrpt::vision::cloudsToMatchedList(), compute3DMatchingRatio(), computeLikelihood_RSLC_2007(), computeLikelihood_SIFT_LandmarkMap(), computeMatchingWith3DLandmarks(), fuseWith(), getAs3DObject(), internal_clear(), internal_computeObservationLikelihood(), loadOccupancyFeaturesFrom2DRangeScan(), loadSiftFeaturesFromImageObservation(), loadSiftFeaturesFromStereoImageObservation(), mrpt::vision::projectMatchedFeatures(), readFromStream(), saveToMATLABScript2D(), saveToMATLABScript3D(), saveToTextFile(), mrpt::slam::CRejectionSamplingRangeOnlyLocalization::setParams(), simulateBeaconReadings(), simulateRangeBearingReadings(), size(), mrpt::vision::StereoObs2BRObs(), mrpt::slam::COccupancyGridMapFeatureExtractor::uncached_extractFeatures(), writeToStream(), and ~CLandmarksMap().

◆ likelihoodOptions

mrpt::maps::CLandmarksMap::TLikelihoodOptions mrpt::maps::CLandmarksMap::likelihoodOptions

Referenced by computeLikelihood_SIFT_LandmarkMap(), computeMatchingWith3DLandmarks(), and internal_computeObservationLikelihood().

◆ m_private_map_register_id

const size_t mrpt::maps::CLandmarksMap::m_private_map_register_id = mrpt::maps::internal::TMetricMapTypesRegistry::Instance().doRegister( "CLandmarksMap,landmarksMap" , & mrpt::maps::CLandmarksMap ::MapDefinition, & mrpt::maps::CLandmarksMap ::internal_CreateFromMapDefinition)

static

ID used to initialize class registration (just ignore it)

Definition at line 711 of file CLandmarksMap.h.

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::maps::CLandmarksMap::runtimeClassId

staticprotected

Definition at line 77 of file CLandmarksMap.h.

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

RTTI stuff

Map Definition Interface stuff (see * mrpt::maps::TMetricMapInitializer) @{

Member Typedef Documentation

◆ ConstPtr

◆ landmark_type

◆ Ptr

Constructor & Destructor Documentation

◆ CLandmarksMap()

◆ ~CLandmarksMap()

Member Function Documentation

◆ _GetBaseClass()

◆ auxParticleFilterCleanUp()

◆ canComputeObservationLikelihood() [1/2]

◆ canComputeObservationLikelihood() [2/2]

◆ canComputeObservationsLikelihood()

◆ changeCoordinatesReference() [1/2]

◆ changeCoordinatesReference() [2/2]

◆ clear()

◆ clone()

◆ compute3DMatchingRatio()

◆ computeLikelihood_RSLC_2007()

◆ computeLikelihood_SIFT_LandmarkMap()

◆ computeMatchingWith2D()

◆ computeMatchingWith3DLandmarks()

◆ computeObservationLikelihood() [1/2]

◆ computeObservationLikelihood() [2/2]

◆ computeObservationsLikelihood()

◆ Create()

◆ CreateFromMapDefinition()

◆ CreateObject()

◆ determineMatching2D()

◆ determineMatching3D()

◆ fuseWith()

◆ getAs3DObject()

◆ getAsSimplePointsMap() [1/2]

◆ getAsSimplePointsMap() [2/2]

◆ getMapMaxID()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ hasSubscribers()

◆ insertObservation()

◆ insertObservationPtr()

◆ internal_clear()

◆ internal_computeObservationLikelihood()

◆ internal_CreateFromMapDefinition()

◆ internal_insertObservation()

◆ isEmpty()

◆ loadFromProbabilisticPosesAndObservations()

◆ loadFromSimpleMap()

◆ loadOccupancyFeaturesFrom2DRangeScan()

◆ loadSiftFeaturesFromImageObservation()

◆ loadSiftFeaturesFromStereoImageObservation()

◆ MapDefinition()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ publishEvent()

◆ readFromStream()

◆ saveMetricMapRepresentationToFile()

◆ saveToMATLABScript2D()

◆ saveToMATLABScript3D()

◆ saveToTextFile()

◆ simulateBeaconReadings()

◆ simulateRangeBearingReadings()

◆ size()

◆ squareDistanceToClosestCorrespondence()