Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types
mrpt::maps::CRandomFieldGridMap2D Class Referenceabstract

Detailed Description

CRandomFieldGridMap2D represents a 2D grid map where each cell is associated one real-valued property which is estimated by this map, either as a simple value or as a probility distribution (for each cell).

There are a number of methods available to build the MRF grid-map, depending on the value of TMapRepresentation maptype passed in the constructor.

The following papers describe the mapping alternatives implemented here:

Note that this class is virtual, since derived classes still have to implement:

[GMRF only] A custom connectivity pattern between cells can be defined by calling setCellsConnectivity().

See also
mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CMetricMap, mrpt::utils::CDynamicGrid, The application icp-slam, mrpt::maps::CMultiMetricMap

Definition at line 152 of file CRandomFieldGridMap2D.h.

#include <mrpt/maps/CRandomFieldGridMap2D.h>

Inheritance diagram for mrpt::maps::CRandomFieldGridMap2D:
Inheritance graph

Classes

struct  ConnectivityDescriptor
 Base class for user-supplied objects capable of describing cells connectivity, used to build prior factors of the MRF graph. More...
 
struct  TInsertionOptionsCommon
 Parameters common to any derived class. More...
 
struct  TObservationGMRF
 
struct  TPriorFactorGMRF
 

Public Types

enum  TMapRepresentation {
  mrKernelDM = 0, mrAchim = 0, mrKalmanFilter, mrKalmanApproximate,
  mrKernelDMV, mrGMRF_SD
}
 The type of map representation to be used, see CRandomFieldGridMap2D for a discussion. More...
 
enum  TGridInterpolationMethod { gimNearest = 0, gimBilinear }
 

Public Member Functions

void clear ()
 Calls the base CMetricMap::clear Declared here to avoid ambiguity between the two clear() in both base classes. More...
 
float cell2float (const TRandomFieldCell &c) const override
 
 CRandomFieldGridMap2D (TMapRepresentation mapType=mrKernelDM, double x_min=-2, double x_max=2, double y_min=-2, double y_max=2, double resolution=0.1)
 Constructor. More...
 
virtual ~CRandomFieldGridMap2D ()
 Destructor. More...
 
virtual bool isEmpty () const override
 Returns true if the map is empty/no observation has been inserted (in this class it always return false, unless redefined otherwise in base classes) More...
 
virtual void saveAsBitmapFile (const std::string &filName) const
 Save the current map as a graphical file (BMP,PNG,...). More...
 
virtual void getAsBitmapFile (mrpt::utils::CImage &out_img) const
 Returns an image just as described in saveAsBitmapFile. More...
 
virtual void getAsMatrix (mrpt::math::CMatrixDouble &out_mat) const
 Like saveAsBitmapFile(), but returns the data in matrix form (first row in the matrix is the upper (y_max) part of the map) More...
 
virtual void resize (double new_x_min, double new_x_max, double new_y_min, double new_y_max, const TRandomFieldCell &defaultValueNewCells, double additionalMarginMeters=1.0f) override
 Changes the size of the grid, maintaining previous contents. More...
 
virtual void setSize (const double x_min, const double x_max, const double y_min, const double y_max, const double resolution, const TRandomFieldCell *fill_value=nullptr)
 Changes the size of the grid, erasing previous contents. More...
 
void setCellsConnectivity (const ConnectivityDescriptor::Ptr &new_connectivity_descriptor)
 Sets a custom object to define the connectivity between cells. More...
 
float compute3DMatchingRatio (const mrpt::maps::CMetricMap *otherMap, const mrpt::poses::CPose3D &otherMapPose, const TMatchingRatioParams &params) const override
 See docs in base class: in this class this always returns 0. More...
 
virtual void saveMetricMapRepresentationToFile (const std::string &filNamePrefix) const override
 The implementation in this class just calls all the corresponding method of the contained metric maps. More...
 
virtual void saveAsMatlab3DGraph (const std::string &filName) const
 Save a matlab ".m" file which represents as 3D surfaces the mean and a given confidence level for the concentration of each cell. More...
 
void getAsMatlab3DGraphScript (std::string &out_script) const
 Return a large text block with a MATLAB script to plot the contents of this map. More...
 
virtual void getAs3DObject (mrpt::opengl::CSetOfObjects::Ptr &outObj) const override
 Returns a 3D object representing the map (mean) More...
 
virtual void getAs3DObject (mrpt::opengl::CSetOfObjects::Ptr &meanObj, mrpt::opengl::CSetOfObjects::Ptr &varObj) const
 Returns two 3D objects representing the mean and variance maps. More...
 
TMapRepresentation getMapType ()
 Return the type of the random-field grid map, according to parameters passed on construction. More...
 
void insertIndividualReading (const double sensorReading, const mrpt::math::TPoint2D &point, const bool update_map=true, const bool time_invariant=true, const double reading_stddev=.0)
 Direct update of the map with a reading in a given position of the map, using the appropriate method according to mapType passed in the constructor. More...
 
virtual void predictMeasurement (const double x, const double y, double &out_predict_response, double &out_predict_response_variance, bool do_sensor_normalization, const TGridInterpolationMethod interp_method=gimNearest)
 Returns the prediction of the measurement at some (x,y) coordinates, and its certainty (in the form of the expected variance). More...
 
void getMeanAndCov (mrpt::math::CVectorDouble &out_means, mrpt::math::CMatrixDouble &out_cov) const
 Return the mean and covariance vector of the full Kalman filter estimate (works for all KF-based methods). More...
 
void getMeanAndSTD (mrpt::math::CVectorDouble &out_means, mrpt::math::CVectorDouble &out_STD) const
 Return the mean and STD vectors of the full Kalman filter estimate (works for all KF-based methods). More...
 
void setMeanAndSTD (mrpt::math::CVectorDouble &out_means, mrpt::math::CVectorDouble &out_STD)
 Load the mean and STD vectors of the full Kalman filter estimate (works for all KF-based methods). More...
 
void updateMapEstimation ()
 Run the method-specific procedure required to ensure that the mean & variances are up-to-date with all inserted observations. More...
 
void enableVerbose (bool enable_verbose)
 
bool isEnabledVerbose () const
 
void enableProfiler (bool enable=true)
 
bool isProfilerEnabled () const
 
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 void auxParticleFilterCleanUp ()
 This method is called at the end of each "prediction-update-map insertion" cycle within "mrpt::slam::CMetricMapBuilderRBPF::processActionObservation". 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::CSimplePointsMapgetAsSimplePointsMap () 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::CSimplePointsMapgetAsSimplePointsMap ()
 
virtual mxArraywriteToMatlab () const
 Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More...
 
virtual CObjectclone () const =0
 Returns a deep copy (clone) of the object, indepently of its class. More...
 
void setSize (const double x_min, const double x_max, const double y_min, const double y_max, const double resolution, const TRandomFieldCell *fill_value=nullptr)
 Changes the size of the grid, ERASING all previous contents. More...
 
void fill (const TRandomFieldCell &value)
 Fills all the cells with the same value. More...
 
virtual void resize (double new_x_min, double new_x_max, double new_y_min, double new_y_max, const TRandomFieldCell &defaultValueNewCells, double additionalMarginMeters=2.0)
 Changes the size of the grid, maintaining previous contents. More...
 
TRandomFieldCellcellByPos (double x, double y)
 Returns a pointer to the contents of a cell given by its coordinates, or nullptr if it is out of the map extensions. More...
 
const TRandomFieldCellcellByPos (double x, double y) const
 
TRandomFieldCellcellByIndex (unsigned int cx, unsigned int cy)
 Returns a pointer to the contents of a cell given by its cell indexes, or nullptr if it is out of the map extensions. More...
 
const TRandomFieldCellcellByIndex (unsigned int cx, unsigned int cy) const
 Returns a pointer to the contents of a cell given by its cell indexes, or nullptr if it is out of the map extensions. More...
 
size_t getSizeX () const
 Returns the horizontal size of grid map in cells count. More...
 
size_t getSizeY () const
 Returns the vertical size of grid map in cells count. More...
 
double getXMin () const
 Returns the "x" coordinate of left side of grid map. More...
 
double getXMax () const
 Returns the "x" coordinate of right side of grid map. More...
 
double getYMin () const
 Returns the "y" coordinate of top side of grid map. More...
 
double getYMax () const
 Returns the "y" coordinate of bottom side of grid map. More...
 
double getResolution () const
 Returns the resolution of the grid map. More...
 
int x2idx (double x) const
 Transform a coordinate values into cell indexes. More...
 
int y2idx (double y) const
 
int xy2idx (double x, double y) const
 
void idx2cxcy (const int &idx, int &cx, int &cy) const
 Transform a global (linear) cell index value into its corresponding (x,y) cell indexes. More...
 
double idx2x (int cx) const
 Transform a cell index into a coordinate value of the cell central point. More...
 
double idx2y (int cy) const
 
void getAsMatrix (MAT &m) const
 Get the entire grid as a matrix. More...
 
virtual float cell2float (const TRandomFieldCell &c) const
 The user must implement this in order to provide "saveToTextFile" a way to convert each cell into a numeric value. More...
 
bool saveToTextFile (const std::string &fileName) const
 Saves a float representation of the grid (via "cell2float()") to a text file. 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...
 

Public Attributes

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

Protected Member Functions

virtual CRandomFieldGridMap2D::TInsertionOptionsCommongetCommonInsertOptions ()=0
 Get the part of the options common to all CRandomFieldGridMap2D classes. More...
 
void insertObservation_KernelDM_DMV (double normReading, const mrpt::math::TPoint2D &point, bool is_DMV)
 The implementation of "insertObservation" for Achim Lilienthal's map models DM & DM+V. More...
 
void insertObservation_KF (double normReading, const mrpt::math::TPoint2D &point)
 The implementation of "insertObservation" for the (whole) Kalman Filter map model. More...
 
void insertObservation_KF2 (double normReading, const mrpt::math::TPoint2D &point)
 The implementation of "insertObservation" for the Efficient Kalman Filter map model. More...
 
void insertObservation_GMRF (double normReading, const mrpt::math::TPoint2D &point, const bool update_map, const bool time_invariant, const double reading_information)
 The implementation of "insertObservation" for the Gaussian Markov Random Field map model. More...
 
void updateMapEstimation_GMRF ()
 solves the minimum quadratic system to determine the new concentration of each cell More...
 
double computeConfidenceCellValue_DM_DMV (const TRandomFieldCell *cell) const
 Computes the confidence of the cell concentration (alpha) More...
 
double computeMeanCellValue_DM_DMV (const TRandomFieldCell *cell) const
 Computes the average cell concentration, or the overall average value if it has never been observed. More...
 
double computeVarCellValue_DM_DMV (const TRandomFieldCell *cell) const
 Computes the estimated variance of the cell concentration, or the overall average variance if it has never been observed. More...
 
void recoverMeanAndCov () const
 In the KF2 implementation, takes the auxiliary matrices and from them update the cells' mean and std values. More...
 
virtual void internal_clear () override
 Erase all the contents of the map. More...
 
bool exist_relation_between2cells (const mrpt::maps::COccupancyGridMap2D *m_Ocgridmap, size_t cxo_min, size_t cxo_max, size_t cyo_min, size_t cyo_max, const size_t seed_cxo, const size_t seed_cyo, const size_t objective_cxo, const size_t objective_cyo)
 Check if two cells of the gridmap (m_map) are connected, based on the provided occupancy gridmap. More...
 
virtual void writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
virtual void readFromStream (mrpt::utils::CStream &in, int version)=0
 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...
 
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...
 
std::vector< TRandomFieldCell > & m_map_castaway_const () const
 Used only from logically const method that really need to modify the object. More...
 
void dyngridcommon_writeToStream (mrpt::utils::CStream &out) const
 
void dyngridcommon_readFromStream (mrpt::utils::CStream &in, bool cast_from_float=false)
 

Protected Attributes

bool m_rfgm_run_update_upon_clear
 
TInsertionOptionsCommonm_insertOptions_common
 Common options to all random-field grid maps: pointer that is set to the derived-class instance of "insertOptions" upon construction of this class. More...
 
TMapRepresentation m_mapType
 The map representation type of this map, as passed in the constructor. More...
 
mrpt::math::CMatrixD m_cov
 The whole covariance matrix, used for the Kalman Filter map representation. More...
 
mrpt::math::CMatrixD m_stackedCov
 The compressed band diagonal matrix for the KF2 implementation. More...
 
bool m_hasToRecoverMeanAndCov
 Only for the KF2 implementation. More...
 
ConnectivityDescriptor::Ptr m_gmrf_connectivity
 Empty: default. More...
 
mrpt::graphs::ScalarFactorGraph m_gmrf
 
std::vector< std::list< TObservationGMRF > > m_mrf_factors_activeObs
 Vector with the active observations and their respective Information. More...
 
std::deque< TPriorFactorGMRFm_mrf_factors_priors
 Vector with the precomputed priors for each GMRF model. More...
 
std::vector< TRandomFieldCellm_map
 The cells. More...
 
double m_x_min
 
double m_x_max
 
double m_y_min
 
double m_y_max
 
double m_resolution
 
size_t m_size_x
 
size_t m_size_y
 
Auxiliary vars for DM & DM+V methods
float m_DM_lastCutOff
 
std::vector< float > m_DM_gaussWindow
 
double m_average_normreadings_mean
 
double m_average_normreadings_var
 
size_t m_average_normreadings_count
 

Private Types

typedef utils::CDynamicGrid< TRandomFieldCellBASE
 

RTTI stuff

using Ptr = std::shared_ptr< CRandomFieldGridMap2D >
 
using ConstPtr = std::shared_ptr< const CRandomFieldGridMap2D >
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
class mrpt::utils::CStream
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 

Member Typedef Documentation

◆ BASE

Definition at line 157 of file CRandomFieldGridMap2D.h.

◆ ConstPtr

Definition at line 159 of file CRandomFieldGridMap2D.h.

◆ Ptr

Definition at line 159 of file CRandomFieldGridMap2D.h.

Member Enumeration Documentation

◆ TGridInterpolationMethod

Enumerator
gimNearest 
gimBilinear 

Definition at line 427 of file CRandomFieldGridMap2D.h.

◆ TMapRepresentation

The type of map representation to be used, see CRandomFieldGridMap2D for a discussion.

Enumerator
mrKernelDM 

Gaussian kernel-based estimator (see discussion in mrpt::maps::CRandomFieldGridMap2D)

mrAchim 

Another alias for "mrKernelDM", for backwards compatibility (see discussion in mrpt::maps::CRandomFieldGridMap2D)

mrKalmanFilter 

"Brute-force" Kalman filter (see discussion in mrpt::maps::CRandomFieldGridMap2D)

mrKalmanApproximate 

(see discussion in mrpt::maps::CRandomFieldGridMap2D)

mrKernelDMV 

Double mean + variance Gaussian kernel-based estimator (see discussion in mrpt::maps::CRandomFieldGridMap2D)

mrGMRF_SD 

Gaussian Markov Random Field, squared differences prior weights between 4 neighboring cells (see discussion in mrpt::maps::CRandomFieldGridMap2D)

Definition at line 175 of file CRandomFieldGridMap2D.h.

Constructor & Destructor Documentation

◆ CRandomFieldGridMap2D()

CRandomFieldGridMap2D::CRandomFieldGridMap2D ( TMapRepresentation  mapType = mrKernelDM,
double  x_min = -2,
double  x_max = 2,
double  y_min = -2,
double  y_max = 2,
double  resolution = 0.1 
)

Constructor.

Definition at line 42 of file CRandomFieldGridMap2D.cpp.

◆ ~CRandomFieldGridMap2D()

CRandomFieldGridMap2D::~CRandomFieldGridMap2D ( )
virtual

Destructor.

Definition at line 65 of file CRandomFieldGridMap2D.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::maps::CRandomFieldGridMap2D::_GetBaseClass ( )
staticprotected

◆ auxParticleFilterCleanUp()

virtual void mrpt::maps::CMetricMap::auxParticleFilterCleanUp ( )
inlinevirtualinherited

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 in mrpt::maps::CLandmarksMap, and mrpt::maps::CMultiMetricMap.

Definition at line 289 of file CMetricMap.h.

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

◆ cell2float() [1/2]

float mrpt::maps::CRandomFieldGridMap2D::cell2float ( const TRandomFieldCell c) const
inlineoverride

Definition at line 167 of file CRandomFieldGridMap2D.h.

◆ cell2float() [2/2]

virtual float mrpt::utils::CDynamicGrid< TRandomFieldCell >::cell2float ( const TRandomFieldCell &  c) const
inlinevirtualinherited

The user must implement this in order to provide "saveToTextFile" a way to convert each cell into a numeric value.

Definition at line 322 of file CDynamicGrid.h.

References MRPT_UNUSED_PARAM.

◆ cellByIndex() [1/2]

TRandomFieldCell * mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByIndex ( unsigned int  cx,
unsigned int  cy 
)
inlineinherited

Returns a pointer to the contents of a cell given by its cell indexes, or nullptr if it is out of the map extensions.

Definition at line 234 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_size_x, and mrpt::utils::CDynamicGrid< T >::m_size_y.

Referenced by getAs3DObject(), getAsMatrix(), predictMeasurement(), saveAsMatlab3DGraph(), and saveMetricMapRepresentationToFile().

◆ cellByIndex() [2/2]

const TRandomFieldCell * mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByIndex ( unsigned int  cx,
unsigned int  cy 
) const
inlineinherited

Returns a pointer to the contents of a cell given by its cell indexes, or nullptr if it is out of the map extensions.

Definition at line 245 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_size_x, and mrpt::utils::CDynamicGrid< T >::m_size_y.

◆ cellByPos() [1/2]

TRandomFieldCell * mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByPos ( double  x,
double  y 
)
inlineinherited

Returns a pointer to the contents of a cell given by its coordinates, or nullptr if it is out of the map extensions.

Definition at line 213 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_size_x, mrpt::utils::CDynamicGrid< T >::m_size_y, mrpt::utils::CDynamicGrid< T >::x2idx(), and mrpt::utils::CDynamicGrid< T >::y2idx().

Referenced by insertObservation_GMRF(), insertObservation_KF(), and insertObservation_KF2().

◆ cellByPos() [2/2]

const TRandomFieldCell * mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByPos ( double  x,
double  y 
) const
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 222 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_size_x, mrpt::utils::CDynamicGrid< T >::m_size_y, mrpt::utils::CDynamicGrid< T >::x2idx(), and mrpt::utils::CDynamicGrid< T >::y2idx().

◆ clear()

void mrpt::maps::CRandomFieldGridMap2D::clear ( )
inline

Calls the base CMetricMap::clear Declared here to avoid ambiguity between the two clear() in both base classes.

Definition at line 165 of file CRandomFieldGridMap2D.h.

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

Here is the call graph for this function:

◆ clone()

virtual CObject* mrpt::utils::CObject::clone ( ) const
pure virtualinherited

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

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CMultiObjMotionOpt_Scalarization, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

Referenced by mrpt::utils::CObject::duplicateGetSmartPtr(), mrpt::maps::CSimpleMap::insert(), mrpt::obs::CActionCollection::insert(), and mrpt::poses::CPoseRandomSampler::setPosePDF().

Here is the caller graph for this function:

◆ compute3DMatchingRatio()

float CRandomFieldGridMap2D::compute3DMatchingRatio ( const mrpt::maps::CMetricMap otherMap,
const mrpt::poses::CPose3D otherMapPose,
const TMatchingRatioParams params 
) const
overridevirtual

See docs in base class: in this class this always returns 0.

Reimplemented from mrpt::maps::CMetricMap.

Definition at line 2733 of file CRandomFieldGridMap2D.cpp.

References MRPT_UNUSED_PARAM.

◆ computeConfidenceCellValue_DM_DMV()

double CRandomFieldGridMap2D::computeConfidenceCellValue_DM_DMV ( const TRandomFieldCell cell) const
protected

Computes the confidence of the cell concentration (alpha)

Definition at line 1991 of file CRandomFieldGridMap2D.cpp.

References mrpt::maps::TRandomFieldCell::dm_mean_w, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::dm_sigma_omega, m_insertOptions_common, and mrpt::math::square().

Referenced by saveMetricMapRepresentationToFile().

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

◆ computeMeanCellValue_DM_DMV()

double CRandomFieldGridMap2D::computeMeanCellValue_DM_DMV ( const TRandomFieldCell cell) const
protected

Computes the average cell concentration, or the overall average value if it has never been observed.

Definition at line 2004 of file CRandomFieldGridMap2D.cpp.

References mrpt::maps::TRandomFieldCell::dm_mean, mrpt::maps::TRandomFieldCell::dm_mean_w, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::dm_sigma_omega, m_average_normreadings_mean, m_insertOptions_common, and mrpt::math::square().

Referenced by getAs3DObject(), getAsMatrix(), predictMeasurement(), and saveMetricMapRepresentationToFile().

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
takenFromThe robot's pose the observation is supposed to be taken from.
obsThe 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
takenFromThe robot's pose the observation is supposed to be taken from.
sfThe 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:

◆ computeVarCellValue_DM_DMV()

double CRandomFieldGridMap2D::computeVarCellValue_DM_DMV ( const TRandomFieldCell cell) const
protected

Computes the estimated variance of the cell concentration, or the overall average variance if it has never been observed.

Definition at line 2020 of file CRandomFieldGridMap2D.cpp.

References mrpt::maps::TRandomFieldCell::dm_mean_w, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::dm_sigma_omega, mrpt::maps::TRandomFieldCell::dmv_var_mean, m_average_normreadings_var, m_insertOptions_common, and mrpt::math::square().

Referenced by getAs3DObject(), predictMeasurement(), and saveMetricMapRepresentationToFile().

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

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

◆ dyngridcommon_readFromStream()

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::dyngridcommon_readFromStream ( mrpt::utils::CStream in,
bool  cast_from_float = false 
)
inlineprotectedinherited

◆ dyngridcommon_writeToStream()

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::dyngridcommon_writeToStream ( mrpt::utils::CStream out) const
inlineprotectedinherited

◆ enableProfiler()

void mrpt::maps::CRandomFieldGridMap2D::enableProfiler ( bool  enable = true)
inline

Definition at line 481 of file CRandomFieldGridMap2D.h.

References mrpt::graphs::ScalarFactorGraph::enableProfiler(), and m_gmrf.

Here is the call graph for this function:

◆ enableVerbose()

void mrpt::maps::CRandomFieldGridMap2D::enableVerbose ( bool  enable_verbose)
inline

Definition at line 472 of file CRandomFieldGridMap2D.h.

◆ exist_relation_between2cells()

bool CRandomFieldGridMap2D::exist_relation_between2cells ( const mrpt::maps::COccupancyGridMap2D m_Ocgridmap,
size_t  cxo_min,
size_t  cxo_max,
size_t  cyo_min,
size_t  cyo_max,
const size_t  seed_cxo,
const size_t  seed_cyo,
const size_t  objective_cxo,
const size_t  objective_cyo 
)
protected

Check if two cells of the gridmap (m_map) are connected, based on the provided occupancy gridmap.

Definition at line 2619 of file CRandomFieldGridMap2D.cpp.

References mrpt::maps::COccupancyGridMap2D::getCell(), mrpt::maps::COccupancyGridMap2D::getSizeX(), mrpt::maps::COccupancyGridMap2D::getSizeY(), and min.

Here is the call graph for this function:

◆ fill()

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::fill ( const TRandomFieldCell &  value)
inlineinherited

Fills all the cells with the same value.

Definition at line 119 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map.

◆ getAs3DObject() [1/2]

void CRandomFieldGridMap2D::getAs3DObject ( mrpt::opengl::CSetOfObjects::Ptr outObj) const
overridevirtual

◆ getAs3DObject() [2/2]

void CRandomFieldGridMap2D::getAs3DObject ( mrpt::opengl::CSetOfObjects::Ptr meanObj,
mrpt::opengl::CSetOfObjects::Ptr varObj 
) const
virtual

Returns two 3D objects representing the mean and variance maps.

Reimplemented in mrpt::maps::CGasConcentrationGridMap2D, and mrpt::maps::CHeightGridMap2D_MRF.

Definition at line 1623 of file CRandomFieldGridMap2D.cpp.

References mrpt::opengl::CSetOfTriangles::TTriangle::a, ASSERT_, mrpt::opengl::CSetOfTriangles::TTriangle::b, mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByIndex(), computeMeanCellValue_DM_DMV(), computeVarCellValue_DM_DMV(), mrpt::maps::TMapGenericParams::enableSaveAs3DObject, mrpt::opengl::CSetOfTriangles::TTriangle::g, mrpt::maps::CMetricMap::genericMapParams, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::GMRF_saturate_max, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::GMRF_saturate_min, mrpt::utils::jet2rgb(), mrpt::maps::TRandomFieldCell::kf_mean, mrpt::maps::TRandomFieldCell::kf_std, m_insertOptions_common, m_mapType, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_resolution, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_x, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_y, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_x_min, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_y_min, min, mrGMRF_SD, mrKalmanApproximate, mrKalmanFilter, mrKernelDM, mrKernelDMV, mrpt::opengl::CSetOfTriangles::TTriangle::r, recoverMeanAndCov(), mrpt::mrpt::utils::saturate_val(), mrpt::math::square(), mrpt::opengl::CSetOfTriangles::TTriangle::x, mrpt::opengl::CSetOfTriangles::TTriangle::y, and mrpt::opengl::CSetOfTriangles::TTriangle::z.

Here is the call graph for this function:

◆ getAsBitmapFile()

void CRandomFieldGridMap2D::getAsBitmapFile ( mrpt::utils::CImage out_img) const
virtual

Returns an image just as described in saveAsBitmapFile.

Definition at line 870 of file CRandomFieldGridMap2D.cpp.

References getAsMatrix(), MRPT_END, MRPT_START, and mrpt::utils::CImage::setFromMatrix().

Referenced by saveAsBitmapFile().

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

◆ getAsMatlab3DGraphScript()

void mrpt::maps::CRandomFieldGridMap2D::getAsMatlab3DGraphScript ( std::string out_script) const

Return a large text block with a MATLAB script to plot the contents of this map.

See also
saveAsMatlab3DGraph This method can only be called in a KF map model

◆ getAsMatrix() [1/2]

void CRandomFieldGridMap2D::getAsMatrix ( mrpt::math::CMatrixDouble out_mat) const
virtual

◆ getAsMatrix() [2/2]

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::getAsMatrix ( MAT &  m) const
inlineinherited

Get the entire grid as a matrix.

Template Parameters
MATThe type of the matrix, typically a mrpt::math::CMatrixDouble.
Parameters
[out]mThe output matrix; will be set automatically to the correct size. Entry (cy,cx) in the matrix contains the grid cell with indices (cx,cy).
Note
This method will compile only for cell types that can be converted to the type of the matrix elements (e.g. double).

Definition at line 311 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_size_x, and mrpt::utils::CDynamicGrid< T >::m_size_y.

◆ 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

◆ getCommonInsertOptions()

virtual CRandomFieldGridMap2D::TInsertionOptionsCommon* mrpt::maps::CRandomFieldGridMap2D::getCommonInsertOptions ( )
protectedpure virtual

◆ getMapType()

CRandomFieldGridMap2D::TMapRepresentation CRandomFieldGridMap2D::getMapType ( )

Return the type of the random-field grid map, according to parameters passed on construction.

Definition at line 2471 of file CRandomFieldGridMap2D.cpp.

References m_mapType.

◆ getMeanAndCov()

void CRandomFieldGridMap2D::getMeanAndCov ( mrpt::math::CVectorDouble out_means,
mrpt::math::CMatrixDouble out_cov 
) const

Return the mean and covariance vector of the full Kalman filter estimate (works for all KF-based methods).

Definition at line 2423 of file CRandomFieldGridMap2D.cpp.

References m_cov, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map, and recoverMeanAndCov().

Here is the call graph for this function:

◆ getMeanAndSTD()

void CRandomFieldGridMap2D::getMeanAndSTD ( mrpt::math::CVectorDouble out_means,
mrpt::math::CVectorDouble out_STD 
) const

Return the mean and STD vectors of the full Kalman filter estimate (works for all KF-based methods).

Definition at line 2437 of file CRandomFieldGridMap2D.cpp.

References mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map, and m_stackedCov.

◆ getResolution()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::getResolution ( ) const
inlineinherited

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::maps::CRandomFieldGridMap2D::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::maps::CMetricMap.

Reimplemented in mrpt::maps::CHeightGridMap2D_MRF, mrpt::maps::CGasConcentrationGridMap2D, and mrpt::maps::CWirelessPowerGridMap2D.

◆ GetRuntimeClassIdStatic()

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

◆ getSizeX()

size_t mrpt::utils::CDynamicGrid< TRandomFieldCell >::getSizeX ( ) const
inlineinherited

Returns the horizontal size of grid map in cells count.

Definition at line 254 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_size_x.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::simulateAdvection().

◆ getSizeY()

size_t mrpt::utils::CDynamicGrid< TRandomFieldCell >::getSizeY ( ) const
inlineinherited

Returns the vertical size of grid map in cells count.

Definition at line 256 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_size_y.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::simulateAdvection().

◆ getXMax()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::getXMax ( ) const
inlineinherited

Returns the "x" coordinate of right side of grid map.

Definition at line 260 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_x_max.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::getWindAs3DObject().

◆ getXMin()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::getXMin ( ) const
inlineinherited

Returns the "x" coordinate of left side of grid map.

Definition at line 258 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_x_min.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::getWindAs3DObject().

◆ getYMax()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::getYMax ( ) const
inlineinherited

Returns the "y" coordinate of bottom side of grid map.

Definition at line 264 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_y_max.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::getWindAs3DObject().

◆ getYMin()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::getYMin ( ) const
inlineinherited

Returns the "y" coordinate of top side of grid map.

Definition at line 262 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_y_min.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::getWindAs3DObject().

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

◆ idx2cxcy()

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2cxcy ( const int &  idx,
int &  cx,
int &  cy 
) const
inlineinherited

Transform a global (linear) cell index value into its corresponding (x,y) cell indexes.

Definition at line 283 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_size_x.

Referenced by insertObservation_KF2(), resize(), and mrpt::maps::CGasConcentrationGridMap2D::simulateAdvection().

◆ idx2x()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2x ( int  cx) const
inlineinherited

Transform a cell index into a coordinate value of the cell central point.

Definition at line 291 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_resolution, and mrpt::utils::CDynamicGrid< T >::m_x_min.

Referenced by predictMeasurement(), and saveMetricMapRepresentationToFile().

◆ idx2y()

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2y ( int  cy) const
inlineinherited

◆ insertIndividualReading()

void CRandomFieldGridMap2D::insertIndividualReading ( const double  sensorReading,
const mrpt::math::TPoint2D point,
const bool  update_map = true,
const bool  time_invariant = true,
const double  reading_stddev = .0 
)

Direct update of the map with a reading in a given position of the map, using the appropriate method according to mapType passed in the constructor.

This is a direct way to update the map, an alternative to the generic insertObservation() method which works with mrpt::obs::CObservation objects.

Parameters
sensorReadingThe value observed in the (x,y) position
pointThe (x,y) location
update_mapRun a global map update after inserting this observatin (algorithm-dependant)
time_invariantWhether the observation "vanishes" with time (false) or not (true) [Only for GMRF methods]
reading_stddevThe uncertainty (standard deviation) of the reading. Default="0.0" means use the default settings per map-wide parameters.

Definition at line 2496 of file CRandomFieldGridMap2D.cpp.

References insertObservation_GMRF(), insertObservation_KernelDM_DMV(), insertObservation_KF(), insertObservation_KF2(), m_insertOptions_common, m_mapType, mrGMRF_SD, mrKalmanApproximate, mrKalmanFilter, mrKernelDM, mrKernelDMV, mrpt::mrpt::math::square(), and THROW_EXCEPTION.

Referenced by mrpt::maps::CWirelessPowerGridMap2D::internal_insertObservation(), and mrpt::maps::CGasConcentrationGridMap2D::internal_insertObservation().

Here is the call graph for this function:
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
obsThe observation
robotPoseThe 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:

◆ insertObservation_GMRF()

void CRandomFieldGridMap2D::insertObservation_GMRF ( double  normReading,
const mrpt::math::TPoint2D point,
const bool  update_map,
const bool  time_invariant,
const double  reading_information 
)
protected

◆ insertObservation_KernelDM_DMV()

void CRandomFieldGridMap2D::insertObservation_KernelDM_DMV ( double  normReading,
const mrpt::math::TPoint2D point,
bool  is_DMV 
)
protected

The implementation of "insertObservation" for Achim Lilienthal's map models DM & DM+V.

Parameters
normReadingIs a [0,1] normalized concentration reading.
pointIs the sensor location on the map
is_DMV= false -> map type is Kernel DM; true -> map type is DM+V
normReadingIs a [0,1] normalized concentration reading.
is_DMV= false -> map type is Kernel DM; true -> map type is DM+V

Definition at line 585 of file CRandomFieldGridMap2D.cpp.

References ASSERT_, mrpt::maps::TRandomFieldCell::dm_mean, mrpt::maps::TRandomFieldCell::dm_mean_w, mrpt::maps::TRandomFieldCell::dmv_var_mean, MRPT_END, MRPT_LOG_DEBUG, MRPT_LOG_DEBUG_FMT, MRPT_START, mrpt::utils::round(), mrpt::math::square(), mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

Referenced by insertIndividualReading().

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

◆ insertObservation_KF()

void CRandomFieldGridMap2D::insertObservation_KF ( double  normReading,
const mrpt::math::TPoint2D point 
)
protected

◆ insertObservation_KF2()

void CRandomFieldGridMap2D::insertObservation_KF2 ( double  normReading,
const mrpt::math::TPoint2D point 
)
protected

The implementation of "insertObservation" for the Efficient Kalman Filter map model.

Parameters
normReadingIs a [0,1] normalized concentration reading.
pointIs the sensor location on the map

Definition at line 2194 of file CRandomFieldGridMap2D.cpp.

References ASSERT_, mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByPos(), mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2cxcy(), mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_covSigma, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_defaultCellMeanValue, mrpt::maps::TRandomFieldCell::kf_mean, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_observationModelNoise, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_W_size, m_hasToRecoverMeanAndCov, m_insertOptions_common, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_resolution, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_x, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_y, m_stackedCov, min, MRPT_END, MRPT_LOG_DEBUG, MRPT_LOG_DEBUG_FMT, MRPT_LOG_DEBUG_STREAM, MRPT_START, resize(), mrpt::math::square(), mrpt::utils::CTicTac::Tac(), THROW_EXCEPTION_FMT, mrpt::utils::CTicTac::Tic(), mrpt::math::TPoint2D::x, mrpt::utils::CDynamicGrid< TRandomFieldCell >::x2idx(), mrpt::utils::CDynamicGrid< TRandomFieldCell >::xy2idx(), mrpt::math::TPoint2D::y, and mrpt::utils::CDynamicGrid< TRandomFieldCell >::y2idx().

Referenced by insertIndividualReading().

Here is the call graph for this function:
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 CRandomFieldGridMap2D::internal_clear ( )
overrideprotectedvirtual

Erase all the contents of the map.

Implements mrpt::maps::CMetricMap.

Reimplemented in mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CHeightGridMap2D_MRF, and mrpt::maps::CWirelessPowerGridMap2D.

Definition at line 86 of file CRandomFieldGridMap2D.cpp.

References ASSERT_, mrpt::maps::CSimpleMap::empty(), fill(), mrpt::maps::COccupancyGridMap2D::getCell(), mrpt::maps::CRandomFieldGridMap2D::ConnectivityDescriptor::getEdgeInformation(), mrpt::maps::COccupancyGridMap2D::getResolution(), mrpt::maps::COccupancyGridMap2D::getSizeX(), mrpt::maps::COccupancyGridMap2D::getSizeY(), mrpt::maps::COccupancyGridMap2D::getXMax(), mrpt::maps::COccupancyGridMap2D::getXMin(), mrpt::maps::COccupancyGridMap2D::getYMax(), mrpt::maps::COccupancyGridMap2D::getYMin(), mrpt::maps::CRandomFieldGridMap2D::TObservationGMRF::Lambda, mrpt::maps::CRandomFieldGridMap2D::TPriorFactorGMRF::Lambda, mrpt::maps::COccupancyGridMap2D::loadFromBitmapFile(), mrpt::maps::CMetricMap::loadFromSimpleMap(), mrpt::system::os::memcpy(), min, MRPT_LOG_DEBUG, MRPT_LOG_DEBUG_FMT, MRPT_LOG_DEBUG_STREAM, mrpt::graphs::ScalarFactorGraph::UnaryFactorVirtualBase::node_id, mrpt::graphs::ScalarFactorGraph::BinaryFactorVirtualBase::node_id_i, mrpt::graphs::ScalarFactorGraph::BinaryFactorVirtualBase::node_id_j, mrpt::maps::CRandomFieldGridMap2D::TObservationGMRF::obsValue, mrpt::maps::COccupancyGridMap2D::saveAsBitmapFile(), mrpt::math::square(), mrpt::utils::CTicTac::Tac(), THROW_EXCEPTION, mrpt::utils::CTicTac::Tic(), and mrpt::maps::CRandomFieldGridMap2D::TObservationGMRF::time_invariant.

Referenced by mrpt::maps::CWirelessPowerGridMap2D::internal_clear(), mrpt::maps::CHeightGridMap2D_MRF::internal_clear(), and mrpt::maps::CGasConcentrationGridMap2D::internal_clear().

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

◆ isEmpty()

bool CRandomFieldGridMap2D::isEmpty ( ) const
overridevirtual

Returns true if the map is empty/no observation has been inserted (in this class it always return false, unless redefined otherwise in base classes)

Implements mrpt::maps::CMetricMap.

Definition at line 576 of file CRandomFieldGridMap2D.cpp.

◆ isEnabledVerbose()

bool mrpt::maps::CRandomFieldGridMap2D::isEnabledVerbose ( ) const
inline

Definition at line 476 of file CRandomFieldGridMap2D.h.

◆ isProfilerEnabled()

bool mrpt::maps::CRandomFieldGridMap2D::isProfilerEnabled ( ) const
inline

Definition at line 485 of file CRandomFieldGridMap2D.h.

References mrpt::graphs::ScalarFactorGraph::isProfilerEnabled(), and m_gmrf.

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::exceptionSome 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 internal_clear().

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

◆ m_map_castaway_const()

std::vector<TRandomFieldCell >& mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map_castaway_const ( ) const
inlineprotectedinherited

Used only from logically const method that really need to modify the object.

Definition at line 47 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map.

Referenced by recoverMeanAndCov().

◆ predictMeasurement()

void CRandomFieldGridMap2D::predictMeasurement ( const double  x,
const double  y,
double &  out_predict_response,
double &  out_predict_response_variance,
bool  do_sensor_normalization,
const TGridInterpolationMethod  interp_method = gimNearest 
)
virtual

Returns the prediction of the measurement at some (x,y) coordinates, and its certainty (in the form of the expected variance).

Parameters
xQuery X coordinate
yQuery Y coordinate
out_predict_responseThe output value
out_predict_response_varianceThe output variance
do_sensor_normalizationWhether to renormalize the prediction to a predefined interval (R values in insertionOptions)
interp_methodInterpolation method

Definition at line 2043 of file CRandomFieldGridMap2D.cpp.

References mrpt::utils::CDynamicGrid< TRandomFieldCell >::cellByIndex(), computeMeanCellValue_DM_DMV(), computeVarCellValue_DM_DMV(), gimBilinear, gimNearest, mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2x(), mrpt::utils::CDynamicGrid< TRandomFieldCell >::idx2y(), mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_defaultCellMeanValue, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_initialCellStd, mrpt::maps::TRandomFieldCell::kf_mean, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::KF_observationModelNoise, mrpt::maps::TRandomFieldCell::kf_std, m_average_normreadings_mean, m_hasToRecoverMeanAndCov, m_insertOptions_common, m_mapType, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_resolution, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_x_max, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_x_min, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_y_min, mrGMRF_SD, mrKalmanApproximate, mrKalmanFilter, mrKernelDM, mrKernelDMV, MRPT_END, MRPT_START, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::R_max, mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::R_min, recoverMeanAndCov(), mrpt::math::square(), THROW_EXCEPTION, mrpt::utils::CDynamicGrid< TRandomFieldCell >::x2idx(), and mrpt::utils::CDynamicGrid< TRandomFieldCell >::y2idx().

Here is the call graph for this function:

◆ publishEvent()

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

◆ readFromStream()

virtual void mrpt::utils::CSerializable::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protectedpure virtualinherited

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
inThe input binary stream where the object data must read from.
versionThe version of the object stored in the stream: use this version number in your code to know how to read the incoming data.
Exceptions
std::exceptionOn any error, see CStream::ReadBuffer
See also
CStream

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

◆ recoverMeanAndCov()

void CRandomFieldGridMap2D::recoverMeanAndCov ( ) const
protected

◆ resize() [1/2]

virtual void mrpt::utils::CDynamicGrid< TRandomFieldCell >::resize ( double  new_x_min,
double  new_x_max,
double  new_y_min,
double  new_y_max,
const TRandomFieldCell &  defaultValueNewCells,
double  additionalMarginMeters = 2.0 
)
inlinevirtualinherited

◆ resize() [2/2]

void CRandomFieldGridMap2D::resize ( double  new_x_min,
double  new_x_max,
double  new_y_min,
double  new_y_max,
const TRandomFieldCell defaultValueNewCells,
double  additionalMarginMeters = 1.0f 
)
overridevirtual

◆ saveAsBitmapFile()

void CRandomFieldGridMap2D::saveAsBitmapFile ( const std::string filName) const
virtual

Save the current map as a graphical file (BMP,PNG,...).

The file format will be derived from the file extension (see CImage::saveToFile ) It depends on the map representation model: mrAchim: Each pixel is the ratio $ \sum{\frac{wR}{w}} $ mrKalmanFilter: Each pixel is the mean value of the Gaussian that represents each cell.

See also
getAsBitmapFile()

Definition at line 813 of file CRandomFieldGridMap2D.cpp.

References getAsBitmapFile(), MRPT_END, and MRPT_START.

Referenced by saveMetricMapRepresentationToFile().

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

◆ saveAsMatlab3DGraph()

void CRandomFieldGridMap2D::saveAsMatlab3DGraph ( const std::string filName) const
virtual

◆ saveMetricMapRepresentationToFile()

void CRandomFieldGridMap2D::saveMetricMapRepresentationToFile ( const std::string filNamePrefix) const
overridevirtual

◆ saveToTextFile()

bool mrpt::utils::CDynamicGrid< TRandomFieldCell >::saveToTextFile ( const std::string fileName) const
inlineinherited

Saves a float representation of the grid (via "cell2float()") to a text file.

Returns
false on error

Definition at line 329 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::getSizeX(), and mrpt::utils::CDynamicGrid< T >::getSizeY().

◆ setCellsConnectivity()

void CRandomFieldGridMap2D::setCellsConnectivity ( const ConnectivityDescriptor::Ptr new_connectivity_descriptor)

Sets a custom object to define the connectivity between cells.

Must call clear() or setSize() afterwards for the changes to take place.

Definition at line 77 of file CRandomFieldGridMap2D.cpp.

◆ setMeanAndSTD()

void CRandomFieldGridMap2D::setMeanAndSTD ( mrpt::math::CVectorDouble out_means,
mrpt::math::CVectorDouble out_STD 
)

Load the mean and STD vectors of the full Kalman filter estimate (works for all KF-based methods).

Definition at line 2454 of file CRandomFieldGridMap2D.cpp.

References ASSERT_, m_hasToRecoverMeanAndCov, mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map, m_stackedCov, recoverMeanAndCov(), and mrpt::math::square().

Here is the call graph for this function:

◆ setSize() [1/2]

void mrpt::utils::CDynamicGrid< TRandomFieldCell >::setSize ( const double  x_min,
const double  x_max,
const double  y_min,
const double  y_max,
const double  resolution,
const TRandomFieldCell *  fill_value = nullptr 
)
inlineinherited

Changes the size of the grid, ERASING all previous contents.

If fill_value is left as nullptr, the contents of cells may be undefined (some will remain with their old values, the new ones will have the default cell value, but the location of old values may change wrt their old places). If fill_value is not nullptr, it is assured that all cells will have a copy of that value after resizing.

See also
resize, fill

Definition at line 84 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_map, mrpt::utils::CDynamicGrid< T >::m_resolution, mrpt::utils::CDynamicGrid< T >::m_size_x, mrpt::utils::CDynamicGrid< T >::m_size_y, mrpt::utils::CDynamicGrid< T >::m_x_max, mrpt::utils::CDynamicGrid< T >::m_x_min, mrpt::utils::CDynamicGrid< T >::m_y_max, mrpt::utils::CDynamicGrid< T >::m_y_min, and mrpt::utils::round().

◆ setSize() [2/2]

void CRandomFieldGridMap2D::setSize ( const double  x_min,
const double  x_max,
const double  y_min,
const double  y_max,
const double  resolution,
const TRandomFieldCell fill_value = nullptr 
)
virtual

Changes the size of the grid, erasing previous contents.

Parameters
[in]connectivity_descriptorOptional user-supplied object that will visit all grid cells to define their connectivity with neighbors and the strength of existing edges. If present, it overrides all options in insertionOptions
See also
resize
resize

Definition at line 67 of file CRandomFieldGridMap2D.cpp.

References mrpt::maps::CMetricMap::clear(), and setSize().

Here is the call 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.

◆ updateMapEstimation()

void CRandomFieldGridMap2D::updateMapEstimation ( )

Run the method-specific procedure required to ensure that the mean & variances are up-to-date with all inserted observations.

Definition at line 2476 of file CRandomFieldGridMap2D.cpp.

References m_mapType, mrGMRF_SD, mrKalmanApproximate, mrKalmanFilter, mrKernelDM, mrKernelDMV, THROW_EXCEPTION, and updateMapEstimation_GMRF().

Here is the call graph for this function:

◆ updateMapEstimation_GMRF()

void CRandomFieldGridMap2D::updateMapEstimation_GMRF ( )
protected

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

virtual void mrpt::utils::CSerializable::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protectedpure virtualinherited

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
outThe output binary stream where object must be dumped.
getVersionIf 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::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

Referenced by mrpt::utils::CStream::WriteObject(), mrpt::maps::CColouredOctoMap::writeToStream(), and mrpt::maps::COctoMap::writeToStream().

Here is the caller graph for this function:

◆ x2idx()

int mrpt::utils::CDynamicGrid< TRandomFieldCell >::x2idx ( double  x) const
inlineinherited

Transform a coordinate values into cell indexes.

Definition at line 268 of file CDynamicGrid.h.

References mrpt::utils::CDynamicGrid< T >::m_resolution, and mrpt::utils::CDynamicGrid< T >::m_x_min.

Referenced by insertObservation_KF2(), and predictMeasurement().

◆ xy2idx()

int mrpt::utils::CDynamicGrid< TRandomFieldCell >::xy2idx ( double  x,
double  y 
) const
inlineinherited

◆ y2idx()

int mrpt::utils::CDynamicGrid< TRandomFieldCell >::y2idx ( double  y) const
inlineinherited

Friends And Related Function Documentation

◆ mrpt::utils::CStream

friend class mrpt::utils::CStream
friend

Definition at line 159 of file CRandomFieldGridMap2D.h.

Member Data Documentation

◆ genericMapParams

TMapGenericParams mrpt::maps::CMetricMap::genericMapParams
inherited

◆ m_average_normreadings_count

size_t mrpt::maps::CRandomFieldGridMap2D::m_average_normreadings_count
protected

◆ m_average_normreadings_mean

double mrpt::maps::CRandomFieldGridMap2D::m_average_normreadings_mean
protected

◆ m_average_normreadings_var

double mrpt::maps::CRandomFieldGridMap2D::m_average_normreadings_var
protected

◆ m_cov

mrpt::math::CMatrixD mrpt::maps::CRandomFieldGridMap2D::m_cov
protected

◆ m_DM_gaussWindow

std::vector<float> mrpt::maps::CRandomFieldGridMap2D::m_DM_gaussWindow
protected

Definition at line 519 of file CRandomFieldGridMap2D.h.

◆ m_DM_lastCutOff

float mrpt::maps::CRandomFieldGridMap2D::m_DM_lastCutOff
protected

Definition at line 518 of file CRandomFieldGridMap2D.h.

◆ m_gmrf

mrpt::graphs::ScalarFactorGraph mrpt::maps::CRandomFieldGridMap2D::m_gmrf
protected

◆ m_gmrf_connectivity

ConnectivityDescriptor::Ptr mrpt::maps::CRandomFieldGridMap2D::m_gmrf_connectivity
protected

Empty: default.

Definition at line 525 of file CRandomFieldGridMap2D.h.

◆ m_hasToRecoverMeanAndCov

bool mrpt::maps::CRandomFieldGridMap2D::m_hasToRecoverMeanAndCov
mutableprotected

◆ m_insertOptions_common

TInsertionOptionsCommon* mrpt::maps::CRandomFieldGridMap2D::m_insertOptions_common
protected

Common options to all random-field grid maps: pointer that is set to the derived-class instance of "insertOptions" upon construction of this class.

Definition at line 492 of file CRandomFieldGridMap2D.h.

Referenced by computeConfidenceCellValue_DM_DMV(), computeMeanCellValue_DM_DMV(), computeVarCellValue_DM_DMV(), getAs3DObject(), getAsMatrix(), insertIndividualReading(), insertObservation_KF(), insertObservation_KF2(), predictMeasurement(), resize(), saveAsMatlab3DGraph(), and updateMapEstimation_GMRF().

◆ m_map

std::vector<TRandomFieldCell > mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_map
protectedinherited

◆ m_mapType

TMapRepresentation mrpt::maps::CRandomFieldGridMap2D::m_mapType
protected

◆ m_mrf_factors_activeObs

std::vector<std::list<TObservationGMRF> > mrpt::maps::CRandomFieldGridMap2D::m_mrf_factors_activeObs
protected

Vector with the active observations and their respective Information.

Definition at line 575 of file CRandomFieldGridMap2D.h.

Referenced by insertObservation_GMRF(), and updateMapEstimation_GMRF().

◆ m_mrf_factors_priors

std::deque<TPriorFactorGMRF> mrpt::maps::CRandomFieldGridMap2D::m_mrf_factors_priors
protected

Vector with the precomputed priors for each GMRF model.

Definition at line 577 of file CRandomFieldGridMap2D.h.

◆ m_resolution

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_resolution
protectedinherited

◆ m_rfgm_run_update_upon_clear

bool mrpt::maps::CRandomFieldGridMap2D::m_rfgm_run_update_upon_clear
protected

Definition at line 487 of file CRandomFieldGridMap2D.h.

◆ m_size_x

size_t mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_x
protectedinherited

◆ m_size_y

size_t mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_size_y
protectedinherited

◆ m_stackedCov

mrpt::math::CMatrixD mrpt::maps::CRandomFieldGridMap2D::m_stackedCov
protected

◆ m_x_max

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_x_max
protectedinherited

◆ m_x_min

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_x_min
protectedinherited

◆ m_y_max

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_y_max
protectedinherited

Definition at line 52 of file CDynamicGrid.h.

Referenced by saveAsMatlab3DGraph(), and saveMetricMapRepresentationToFile().

◆ m_y_min

double mrpt::utils::CDynamicGrid< TRandomFieldCell >::m_y_min
protectedinherited

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::maps::CRandomFieldGridMap2D::runtimeClassId
staticprotected

Definition at line 159 of file CRandomFieldGridMap2D.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019