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

Detailed Description

A map of 2D/3D points with individual colours (RGB).

For different color schemes, see CColouredPointsMap::colorScheme Colors are defined in the range [0,1].

See also
mrpt::maps::CPointsMap, mrpt::maps::CMetricMap, mrpt::utils::CSerializable

Definition at line 30 of file CColouredPointsMap.h.

#include <mrpt/maps/CColouredPointsMap.h>

Inheritance diagram for mrpt::maps::CColouredPointsMap:
Inheritance graph

Classes

struct  TColourOptions
 The definition of parameters for generating colors from laser scans. More...
 
struct  TMapDefinition
 
struct  TMapDefinitionBase
 

Public Types

enum  TColouringMethod { cmFromHeightRelativeToSensor = 0, cmFromHeightRelativeToSensorJet = 0, cmFromHeightRelativeToSensorGray = 1, cmFromIntensityImage = 2 }
 The choices for coloring schemes: More...
 
typedef KDTreeCapable< CPointsMap, float, nanoflann::L2_Simple_Adaptor< float, CPointsMap > > self_t
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
virtual ~CColouredPointsMap ()
 Destructor. More...
 
 CColouredPointsMap ()
 Default constructor. More...
 
bool save3D_and_colour_to_text_file (const std::string &file) const
 Save to a text file. More...
 
virtual void setPoint (size_t index, float x, float y, float z, float R, float G, float B) override
 Changes a given point from map. More...
 
void setPoint (size_t index, float x, float y, float z)
 
void setPoint (size_t index, mrpt::math::TPoint3Df &p)
 
void setPoint (size_t index, float x, float y)
 
virtual void insertPoint (float x, float y, float z, float R, float G, float B) override
 Adds a new point given its coordinates and color (colors range is [0,1]) More...
 
void insertPoint (const mrpt::poses::CPoint3D &p)
 
void insertPoint (const mrpt::math::TPoint3D &p)
 
void insertPoint (const mrpt::math::TPoint3Df &p)
 
void insertPoint (float x, float y, float z)
 
void setPointColor (size_t index, float R, float G, float B)
 Changes just the color of a given point from the map. More...
 
void setPointColor_fast (size_t index, float R, float G, float B)
 Like setPointColor but without checking for out-of-index erors. More...
 
virtual void getPoint (size_t index, float &x, float &y, float &z, float &R, float &G, float &B) const override
 Retrieves a point and its color (colors range is [0,1]) More...
 
unsigned long getPoint (size_t index, float &x, float &y, float &z) const
 Retrieves a point. More...
 
void getPointColor (size_t index, float &R, float &G, float &B) const
 Retrieves a point color (colors range is [0,1]) More...
 
void getPointColor_fast (size_t index, float &R, float &G, float &B) const
 Like getPointColor but without checking for out-of-index erors. More...
 
virtual bool hasColorPoints () const override
 Returns true if the point map has a color field for each point. More...
 
virtual void getAs3DObject (mrpt::opengl::CSetOfObjects::Ptr &outObj) const override
 Override of the default 3D scene builder to account for the individual points' color. More...
 
bool colourFromObservation (const mrpt::obs::CObservationImage &obs, const mrpt::poses::CPose3D &robotPose)
 Colour a set of points from a CObservationImage and the global pose of the robot. More...
 
void resetPointsMinDist (float defValue=2000.0f)
 Reset the minimum-observed-distance buffer for all the points to a predefined value. More...
 
virtual float squareDistanceToClosestCorrespondence (float x0, float y0) const override
 Returns the square distance from the 2D point (x0,y0) to the closest correspondence in the map. More...
 
float squareDistanceToClosestCorrespondenceT (const mrpt::math::TPoint2D &p0) const
 
virtual void addFrom (const CPointsMap &anotherMap)
 Adds all the points from anotherMap to this map, without fusing. More...
 
void operator+= (const CPointsMap &anotherMap)
 This operator is synonymous with addFrom. More...
 
void insertAnotherMap (const CPointsMap *otherMap, const mrpt::poses::CPose3D &otherPose)
 Insert the contents of another map into this one with some geometric transformation, without fusing close points. More...
 
size_t size () const
 Returns the number of stored points in the map. More...
 
unsigned long getPoint (size_t index, float &x, float &y) const
 
unsigned long getPoint (size_t index, double &x, double &y, double &z) const
 
unsigned long getPoint (size_t index, double &x, double &y) const
 
unsigned long getPoint (size_t index, mrpt::math::TPoint2D &p) const
 
unsigned long getPoint (size_t index, mrpt::math::TPoint3D &p) const
 
void getPointFast (size_t index, float &x, float &y, float &z) const
 Just like getPoint() but without checking out-of-bound index and without returning the point weight, just XYZ. More...
 
void setPoint (size_t index, const mrpt::math::TPoint2D &p)
 
void setPoint (size_t index, const mrpt::math::TPoint3D &p)
 
virtual void setPointWeight (size_t index, unsigned long w)
 Sets the point weight, which is ignored in all classes but those which actually store that field (Note: No checks are done for out-of-bounds index). More...
 
virtual unsigned int getPointWeight (size_t index) const
 Gets the point weight, which is ignored in all classes (defaults to 1) but in those which actually store that field (Note: No checks are done for out-of-bounds index). More...
 
void getPointsBuffer (size_t &outPointsCount, const float *&xs, const float *&ys, const float *&zs) const
 Provides a direct access to points buffer, or nullptr if there is no points in the map. More...
 
const std::vector< float > & getPointsBufferRef_x () const
 Provides a direct access to a read-only reference of the internal point buffer. More...
 
const std::vector< float > & getPointsBufferRef_y () const
 Provides a direct access to a read-only reference of the internal point buffer. More...
 
const std::vector< float > & getPointsBufferRef_z () const
 Provides a direct access to a read-only reference of the internal point buffer. More...
 
template<class VECTOR >
void getAllPoints (VECTOR &xs, VECTOR &ys, VECTOR &zs, size_t decimation=1) const
 Returns a copy of the 2D/3D points as a std::vector of float coordinates. More...
 
template<class CONTAINER >
void getAllPoints (CONTAINER &ps, size_t decimation=1) const
 Gets all points as a STL-like container. More...
 
void getAllPoints (std::vector< float > &xs, std::vector< float > &ys, size_t decimation=1) const
 Returns a copy of the 2D/3D points as a std::vector of float coordinates. More...
 
void getAllPoints (std::vector< mrpt::math::TPoint2D > &ps, size_t decimation=1) const
 
template<typename VECTOR >
void setAllPointsTemplate (const VECTOR &X, const VECTOR &Y, const VECTOR &Z=VECTOR())
 Set all the points at once from vectors with X,Y and Z coordinates (if Z is not provided, it will be set to all zeros). More...
 
void setAllPoints (const std::vector< float > &X, const std::vector< float > &Y, const std::vector< float > &Z)
 Set all the points at once from vectors with X,Y and Z coordinates. More...
 
void setAllPoints (const std::vector< float > &X, const std::vector< float > &Y)
 Set all the points at once from vectors with X and Y coordinates (Z=0). More...
 
void getPointAllFields (const size_t index, std::vector< float > &point_data) const
 Get all the data fields for one point as a vector: depending on the implementation class this can be [X Y Z] or [X Y Z R G B], etc... More...
 
void setPointAllFields (const size_t index, const std::vector< float > &point_data)
 Set all the data fields for one point as a vector: depending on the implementation class this can be [X Y Z] or [X Y Z R G B], etc... More...
 
void clipOutOfRangeInZ (float zMin, float zMax)
 Delete points out of the given "z" axis range have been removed. More...
 
void clipOutOfRange (const mrpt::math::TPoint2D &point, float maxRange)
 Delete points which are more far than "maxRange" away from the given "point". More...
 
void applyDeletionMask (const std::vector< bool > &mask)
 Remove from the map the points marked in a bool's array as "true". More...
 
virtual void determineMatching2D (const mrpt::maps::CMetricMap *otherMap, const mrpt::poses::CPose2D &otherMapPose, mrpt::utils::TMatchingPairList &correspondences, const TMatchingParams &params, TMatchingExtraResults &extraResults) const override
 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 override
 Computes the matchings between this and another 3D points map - method used in 3D-ICP. More...
 
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...
 
void compute3DDistanceToMesh (const mrpt::maps::CMetricMap *otherMap2, const mrpt::poses::CPose3D &otherMapPose, float maxDistForCorrespondence, mrpt::utils::TMatchingPairList &correspondences, float &correspondencesRatio)
 Computes the matchings between this and another 3D points map. More...
 
void loadFromVelodyneScan (const mrpt::obs::CObservationVelodyneScan &scan, const mrpt::poses::CPose3D *robotPose=nullptr)
 Like loadFromRangeScan() for Velodyne 3D scans. More...
 
void fuseWith (CPointsMap *anotherMap, float minDistForFuse=0.02f, std::vector< bool > *notFusedPoints=nullptr)
 Insert the contents of another map into this one, fusing the previous content with the new one. More...
 
void changeCoordinatesReference (const mrpt::poses::CPose2D &b)
 Replace each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator). More...
 
void changeCoordinatesReference (const mrpt::poses::CPose3D &b)
 Replace each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator). More...
 
void changeCoordinatesReference (const CPointsMap &other, const mrpt::poses::CPose3D &b)
 Copy all the points from "other" map to "this", replacing each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator). More...
 
virtual bool isEmpty () const override
 Returns true if the map is empty/no observation has been inserted. More...
 
bool empty () const
 STL-like method to check whether the map is empty: More...
 
virtual const mrpt::maps::CSimplePointsMapgetAsSimplePointsMap () const override
 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 () override
 
float getLargestDistanceFromOrigin () const
 This method returns the largest distance from the origin to any of the points, such as a sphere centered at the origin with this radius cover ALL the points in the map (the results are buffered, such as, if the map is not modified, the second call will be much faster than the first one). More...
 
float getLargestDistanceFromOriginNoRecompute (bool &output_is_valid) const
 Like getLargestDistanceFromOrigin() but returns in output_is_valid = false if the distance was not already computed, skipping its computation then, unlike getLargestDistanceFromOrigin() More...
 
void boundingBox (float &min_x, float &max_x, float &min_y, float &max_y, float &min_z, float &max_z) const
 Computes the bounding box of all the points, or (0,0 ,0,0, 0,0) if there are no points. More...
 
void boundingBox (mrpt::math::TPoint3D &pMin, mrpt::math::TPoint3D &pMax) const
 
void extractCylinder (const mrpt::math::TPoint2D &center, const double radius, const double zmin, const double zmax, CPointsMap *outMap)
 Extracts the points in the map within a cylinder in 3D defined the provided radius and zmin/zmax values. More...
 
void extractPoints (const mrpt::math::TPoint3D &corner1, const mrpt::math::TPoint3D &corner2, CPointsMap *outMap, const double &R=1, const double &G=1, const double &B=1)
 Extracts the points in the map within the area defined by two corners. More...
 
virtual double internal_computeObservationLikelihood (const mrpt::obs::CObservation *obs, const mrpt::poses::CPose3D &takenFrom) override
 Internal method called by computeObservationLikelihood() More...
 
void mark_as_modified () const
 Users normally don't need to call this. 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 auxParticleFilterCleanUp ()
 This method is called at the end of each "prediction-update-map insertion" cycle within "mrpt::slam::CMetricMapBuilderRBPF::processActionObservation". More...
 
virtual mxArraywriteToMatlab () const
 Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More...
 
const CPointsMapderived () const
 CRTP helper method. More...
 
CPointsMapderived ()
 CRTP helper method. More...
 
bool loadFromPlyFile (const std::string &filename, CStringList *file_comments=nullptr, CStringList *file_obj_info=nullptr)
 Loads from a PLY file. More...
 
std::string getLoadPLYErrorString () const
 Return a description of the error if loadFromPlyFile() returned false, or an empty string if the file was loaded without problems. More...
 
bool saveToPlyFile (const std::string &filename, bool save_in_binary=false, const CStringList &file_comments=CStringList(), const CStringList &file_obj_info=CStringList()) const
 Saves to a PLY file. More...
 
std::string getSavePLYErrorString () const
 Return a description of the error if loadFromPlyFile() returned false, or an empty string if the file was loaded without problems. More...
 
PCL library support
virtual bool savePCDFile (const std::string &filename, bool save_as_binary) const override
 Save the point cloud as a PCL PCD file, in either ASCII or binary format. More...
 
template<class POINTCLOUD >
void setFromPCLPointCloudRGB (const POINTCLOUD &cloud)
 Loads a PCL point cloud (WITH RGB information) into this MRPT class (for clouds without RGB data, see CPointsMap::setFromPCLPointCloud() ). More...
 
template<class POINTCLOUD >
void getPCLPointCloudXYZRGB (POINTCLOUD &cloud) const
 Like CPointsMap::getPCLPointCloud() but for PointCloud<PointXYZRGB> More...
 
File input/output methods
bool load2D_from_text_file (const std::string &file)
 Load from a text file. More...
 
bool load3D_from_text_file (const std::string &file)
 Load from a text file. More...
 
bool load2Dor3D_from_text_file (const std::string &file, const bool is_3D)
 2D or 3D generic implementation of load2D_from_text_file and load3D_from_text_file More...
 
bool save2D_to_text_file (const std::string &file) const
 Save to a text file. More...
 
bool save3D_to_text_file (const std::string &file) const
 Save to a text file. 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...
 
virtual bool loadPCDFile (const std::string &filename)
 Load the point cloud from a PCL PCD file (requires MRPT built against PCL) More...
 
Filter-by-height stuff
void enableFilterByHeight (bool enable=true)
 Enable/disable the filter-by-height functionality. More...
 
bool isFilterByHeightEnabled () const
 Return whether filter-by-height is enabled. More...
 
void setHeightFilterLevels (const double _z_min, const double _z_max)
 Set the min/max Z levels for points to be actually inserted in the map (only if enableFilterByHeight() was called before). More...
 
void getHeightFilterLevels (double &_z_min, double &_z_max) const
 Get the min/max Z levels for points to be actually inserted in the map. More...
 
PCL library support
template<class POINTCLOUD >
void getPCLPointCloud (POINTCLOUD &cloud) const
 Use to convert this MRPT point cloud object into a PCL point cloud object (PointCloud<PointXYZ>). More...
 
template<class POINTCLOUD >
void setFromPCLPointCloud (const POINTCLOUD &cloud)
 Loads a PCL point cloud into this MRPT class (note: this method ignores potential RGB information, see CColouredPointsMap::setFromPCLPointCloudRGB() ). More...
 
Methods that MUST be implemented by children classes of

KDTreeCapable

size_t kdtree_get_point_count () const
 Must return the number of data points. More...
 
float kdtree_get_pt (const size_t idx, int dim) const
 Returns the dim'th component of the idx'th point in the class: More...
 
float kdtree_distance (const float *p1, const size_t idx_p2, size_t size) const
 Returns the distance between the vector "p1[0:size-1]" and the data point with index "idx_p2" stored in the class: More...
 
template<typename BBOX >
bool kdtree_get_bbox (BBOX &bb) const
 
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 utility methods to query the KD-tree
size_t kdTreeClosestPoint2D (float x0, float y0, float &out_x, float &out_y, float &out_dist_sqr) const
 KD Tree-based search for the closest point (only ONE) to some given 2D coordinates. More...
 
size_t kdTreeClosestPoint2D (float x0, float y0, float &out_dist_sqr) const
 
size_t kdTreeClosestPoint2D (const TPoint2D &p0, TPoint2D &pOut, float &outDistSqr) const
 
float kdTreeClosestPoint2DsqrError (float x0, float y0) const
 Like kdTreeClosestPoint2D, but just return the square error from some point to its closest neighbor. More...
 
float kdTreeClosestPoint2DsqrError (const TPoint2D &p0) const
 
void kdTreeTwoClosestPoint2D (float x0, float y0, float &out_x1, float &out_y1, float &out_x2, float &out_y2, float &out_dist_sqr1, float &out_dist_sqr2) const
 KD Tree-based search for the TWO closest point to some given 2D coordinates. More...
 
void kdTreeTwoClosestPoint2D (const TPoint2D &p0, TPoint2D &pOut1, TPoint2D &pOut2, float &outDistSqr1, float &outDistSqr2) const
 
std::vector< size_t > kdTreeNClosestPoint2D (float x0, float y0, size_t knn, std::vector< float > &out_x, std::vector< float > &out_y, std::vector< float > &out_dist_sqr) const
 KD Tree-based search for the N closest point to some given 2D coordinates. More...
 
std::vector< size_t > kdTreeNClosestPoint2D (const TPoint2D &p0, size_t N, std::vector< TPoint2D > &pOut, std::vector< float > &outDistSqr) const
 
void kdTreeNClosestPoint2DIdx (float x0, float y0, size_t knn, std::vector< size_t > &out_idx, std::vector< float > &out_dist_sqr) const
 KD Tree-based search for the N closest point to some given 2D coordinates and returns their indexes. More...
 
void kdTreeNClosestPoint2DIdx (const TPoint2D &p0, size_t N, std::vector< size_t > &outIdx, std::vector< float > &outDistSqr) const
 
size_t kdTreeClosestPoint3D (float x0, float y0, float z0, float &out_x, float &out_y, float &out_z, float &out_dist_sqr) const
 KD Tree-based search for the closest point (only ONE) to some given 3D coordinates. More...
 
size_t kdTreeClosestPoint3D (float x0, float y0, float z0, float &out_dist_sqr) const
 
size_t kdTreeClosestPoint3D (const TPoint3D &p0, TPoint3D &pOut, float &outDistSqr) const
 
void kdTreeNClosestPoint3D (float x0, float y0, float z0, size_t knn, std::vector< float > &out_x, std::vector< float > &out_y, std::vector< float > &out_z, std::vector< float > &out_dist_sqr) const
 KD Tree-based search for the N closest points to some given 3D coordinates. More...
 
void kdTreeNClosestPoint3D (const TPoint3D &p0, size_t N, std::vector< TPoint3D > &pOut, std::vector< float > &outDistSqr) const
 
void kdTreeNClosestPoint3DWithIdx (float x0, float y0, float z0, size_t knn, std::vector< float > &out_x, std::vector< float > &out_y, std::vector< float > &out_z, std::vector< size_t > &out_idx, std::vector< float > &out_dist_sqr) const
 KD Tree-based search for the N closest points to some given 3D coordinates. More...
 
size_t kdTreeRadiusSearch3D (const float x0, const float y0, const float z0, const float maxRadiusSqr, std::vector< std::pair< size_t, float >> &out_indices_dist) const
 KD Tree-based search for all the points within a given radius of some 3D point. More...
 
size_t kdTreeRadiusSearch2D (const float x0, const float y0, const float maxRadiusSqr, std::vector< std::pair< size_t, float >> &out_indices_dist) const
 KD Tree-based search for all the points within a given radius of some 2D point. More...
 
void kdTreeNClosestPoint3DIdx (float x0, float y0, float z0, size_t knn, std::vector< size_t > &out_idx, std::vector< float > &out_dist_sqr) const
 KD Tree-based search for the N closest point to some given 3D coordinates and returns their indexes. More...
 
void kdTreeNClosestPoint3DIdx (const TPoint3D &p0, size_t N, std::vector< size_t > &outIdx, std::vector< float > &outDistSqr) const
 

Static Public Member Functions

static voidoperator new (size_t size, void *ptr)
 
static void COLOR_3DSCENE (const mrpt::utils::TColorf &value)
 The color of points in getAs3DObject() (default=blue) More...
 
static mrpt::utils::TColorf COLOR_3DSCENE ()
 

Public Attributes

TColourOptions colorScheme
 The options employed when inserting laser scans in the map. More...
 
TInsertionOptions insertionOptions
 The options used when inserting observations in the map. More...
 
TLikelihoodOptions likelihoodOptions
 
TMapGenericParams genericMapParams
 Common params to all maps. More...
 
TKDTreeSearchParams kdtree_search_params
 Parameters to tune the ANN searches. More...
 

Protected Member Functions

virtual void internal_clear () override
 Minimum distance from where the points have been seen. More...
 
bool internal_insertObservation (const mrpt::obs::CObservation *obs, const mrpt::poses::CPose3D *robotPose) override
 This is a common version of CMetricMap::insertObservation() for point maps (actually, CMetricMap::internal_insertObservation), so derived classes don't need to worry implementing that method unless something special is really necesary. More...
 
void base_copyFrom (const CPointsMap &obj)
 Helper method for ::copyFrom() 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...
 
void kdtree_mark_as_outdated () const
 To be called by child classes when KD tree data changes. 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...
 
Redefinition of PLY Import virtual methods from CPointsMap
virtual void PLY_import_set_vertex (const size_t idx, const mrpt::math::TPoint3Df &pt, const mrpt::utils::TColorf *pt_color=nullptr) override
 In a base class, will be called after PLY_import_set_vertex_count() once for each loaded point. More...
 
virtual void PLY_import_set_vertex_count (const size_t N) override
 In a base class, reserve memory to prepare subsequent calls to PLY_import_set_vertex. More...
 
Redefinition of PLY Export virtual methods from CPointsMap
void PLY_export_get_vertex (const size_t idx, mrpt::math::TPoint3Df &pt, bool &pt_has_color, mrpt::utils::TColorf &pt_color) const override
 In a base class, will be called after PLY_export_get_vertex_count() once for each exported point. More...
 
PLY Import virtual methods to implement in base classes
virtual void PLY_import_set_face_count (const size_t N) override
 In a base class, reserve memory to prepare subsequent calls to PLY_import_set_face. More...
 
PLY Export virtual methods to implement in base classes
size_t PLY_export_get_vertex_count () const override
 In a base class, return the number of vertices. More...
 
size_t PLY_export_get_face_count () const override
 In a base class, return the number of faces. More...
 

Protected Attributes

std::vector< float > m_color_R
 The color data. More...
 
std::vector< float > m_color_G
 
std::vector< float > m_color_B
 
std::vector< float > x
 The point coordinates. More...
 
std::vector< float > y
 
std::vector< float > z
 
mrpt::obs::CSinCosLookUpTableFor2DScans m_scans_sincos_cache
 Cache of sin/cos values for the latest 2D scan geometries. More...
 
float m_largestDistanceFromOrigin
 Auxiliary variables used in "getLargestDistanceFromOrigin". More...
 
bool m_largestDistanceFromOriginIsUpdated
 Auxiliary variables used in "getLargestDistanceFromOrigin". More...
 
bool m_boundingBoxIsUpdated
 
float m_bb_min_x
 
float m_bb_max_x
 
float m_bb_min_y
 
float m_bb_max_y
 
float m_bb_min_z
 
float m_bb_max_z
 
double m_heightfilter_z_min
 The minimum and maximum height for a certain laser scan to be inserted into this map. More...
 
double m_heightfilter_z_max
 
bool m_heightfilter_enabled
 Whether or not (default=not) filter the input points by height. More...
 

RTTI stuff

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

Pure virtual interfaces to be implemented by any class derived

from CPointsMap

template<class Derived >
struct detail::loadFromRangeImpl
 
template<class Derived >
struct detail::pointmap_traits
 
virtual void reserve (size_t newLength) override
 Reserves memory for a given number of points: the size of the map does not change, it only reserves the memory. More...
 
virtual void resize (size_t newLength) override
 Resizes all point buffers so they can hold the given number of points: newly created points are set to default values, and old contents are not changed. More...
 
virtual void setSize (size_t newLength) override
 Resizes all point buffers so they can hold the given number of points, erasing all previous contents and leaving all points to default values. More...
 
virtual void setPointFast (size_t index, float x, float y, float z) override
 Changes the coordinates of the given point (0-based index), without checking for out-of-bounds and without calling mark_as_modified() More...
 
virtual void insertPointFast (float x, float y, float z=0) override
 The virtual method for insertPoint() without calling mark_as_modified() More...
 
virtual void copyFrom (const CPointsMap &obj) override
 Virtual assignment operator, to be implemented in derived classes. More...
 
virtual void getPointAllFieldsFast (const size_t index, std::vector< float > &point_data) const override
 Get all the data fields for one point as a vector: [X Y Z R G B] Unlike getPointAllFields(), this method does not check for index out of bounds. More...
 
virtual void setPointAllFieldsFast (const size_t index, const std::vector< float > &point_data) override
 Set all the data fields for one point as a vector: [X Y Z R G B] Unlike setPointAllFields(), this method does not check for index out of bounds. More...
 
virtual void loadFromRangeScan (const mrpt::obs::CObservation2DRangeScan &rangeScan, const mrpt::poses::CPose3D *robotPose=nullptr) override
 See CPointsMap::loadFromRangeScan() More...
 
virtual void loadFromRangeScan (const mrpt::obs::CObservation3DRangeScan &rangeScan, const mrpt::poses::CPose3D *robotPose=nullptr) override
 See CPointsMap::loadFromRangeScan() More...
 
virtual void addFrom_classSpecific (const CPointsMap &anotherMap, const size_t nPreviousPoints) override
 Auxiliary method called from within addFrom() automatically, to finish the copying of class-specific data. More...
 

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

static const size_t m_private_map_register_id = mrpt::maps::internal::TMetricMapTypesRegistry::Instance().doRegister( "CColouredPointsMap,colourPointsMap" , & mrpt::maps::CColouredPointsMap ::MapDefinition, & mrpt::maps::CColouredPointsMap ::internal_CreateFromMapDefinition)
 ID used to initialize class registration (just ignore it) More...
 
static mrpt::maps::TMetricMapInitializerMapDefinition ()
 Returns default map definition initializer. More...
 
static CColouredPointsMapCreateFromMapDefinition (const mrpt::maps::TMetricMapInitializer &def)
 Constructor from a map definition structure: initializes the map and * its parameters accordingly. More...
 
static mrpt::maps::CMetricMapinternal_CreateFromMapDefinition (const mrpt::maps::TMetricMapInitializer &def)
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 32 of file CColouredPointsMap.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 32 of file CColouredPointsMap.h.

◆ self_t

typedef KDTreeCapable<CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > > mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::self_t
inherited

Definition at line 85 of file KDTreeCapable.h.

Member Enumeration Documentation

◆ TColouringMethod

The choices for coloring schemes:

  • cmFromHeightRelativeToSensor: The Z coordinate wrt the sensor will be used to obtain the color using the limits z_min,z_max.

cmFromIntensityImage: When inserting 3D range scans, take the color from the intensity image channel, if available.

See also
TColourOptions
Enumerator
cmFromHeightRelativeToSensor 
cmFromHeightRelativeToSensorJet 
cmFromHeightRelativeToSensorGray 
cmFromIntensityImage 

Definition at line 247 of file CColouredPointsMap.h.

Constructor & Destructor Documentation

◆ ~CColouredPointsMap()

CColouredPointsMap::~CColouredPointsMap ( )
virtual

Destructor.

Definition at line 84 of file CColouredPointsMap.cpp.

◆ CColouredPointsMap()

CColouredPointsMap::CColouredPointsMap ( )

Default constructor.

Definition at line 80 of file CColouredPointsMap.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

◆ addFrom()

void CPointsMap::addFrom ( const CPointsMap anotherMap)
virtualinherited

Adds all the points from anotherMap to this map, without fusing.

This operation can be also invoked via the "+=" operator, for example:

...
m1.addFrom( m2 ); // Add all points of m2 to m1
m1 += m2; // Exactly the same than above
Note
The method in CPointsMap is generic but derived classes may redefine this virtual method to another one more optimized.

Definition at line 1651 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::addFrom_classSpecific(), mrpt::maps::CPointsMap::mark_as_modified(), mrpt::maps::CPointsMap::resize(), mrpt::maps::CPointsMap::size(), mrpt::maps::CPointsMap::x, mrpt::maps::CPointsMap::y, and mrpt::maps::CPointsMap::z.

Referenced by mrpt::maps::CPointsMap::operator+=().

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

◆ addFrom_classSpecific()

void CColouredPointsMap::addFrom_classSpecific ( const CPointsMap anotherMap,
const size_t  nPreviousPoints 
)
overrideprotectedvirtual

Auxiliary method called from within addFrom() automatically, to finish the copying of class-specific data.

Implements mrpt::maps::CPointsMap.

Definition at line 700 of file CColouredPointsMap.cpp.

References m_color_B, m_color_G, m_color_R, and mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ applyDeletionMask()

void CPointsMap::applyDeletionMask ( const std::vector< bool > &  mask)
inherited

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

◆ base_copyFrom()

void CPointsMap::base_copyFrom ( const CPointsMap obj)
protectedinherited

◆ boundingBox() [1/2]

void CPointsMap::boundingBox ( float &  min_x,
float &  max_x,
float &  min_y,
float &  max_y,
float &  min_z,
float &  max_z 
) const
inherited

◆ boundingBox() [2/2]

void mrpt::maps::CPointsMap::boundingBox ( mrpt::math::TPoint3D pMin,
mrpt::math::TPoint3D pMax 
) const
inlineinherited

Definition at line 878 of file CPointsMap.h.

References mrpt::maps::CPointsMap::boundingBox(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

Here is the call graph for this function:

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

◆ changeCoordinatesReference() [1/3]

void CPointsMap::changeCoordinatesReference ( const mrpt::poses::CPose2D b)
inherited

Replace each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator).

Definition at line 613 of file CPointsMap.cpp.

References mrpt::poses::CPose3D::composePoint(), and mrpt::maps::CPointsMap::mark_as_modified().

Referenced by mrpt::maps::CPointsMap::changeCoordinatesReference(), mrpt::maps::CHeightGridMap2D_Base::dem_internal_insertObservation(), and TEST_F().

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

◆ changeCoordinatesReference() [2/3]

void CPointsMap::changeCoordinatesReference ( const mrpt::poses::CPose3D b)
inherited

Replace each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator).

Definition at line 631 of file CPointsMap.cpp.

References mrpt::poses::CPose3D::composePoint(), and mrpt::maps::CPointsMap::mark_as_modified().

Here is the call graph for this function:

◆ changeCoordinatesReference() [3/3]

void CPointsMap::changeCoordinatesReference ( const CPointsMap other,
const mrpt::poses::CPose3D b 
)
inherited

Copy all the points from "other" map to "this", replacing each point $ p_i $ by $ p'_i = b \oplus p_i $ (pose compounding operator).

Definition at line 647 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::changeCoordinatesReference(), and mrpt::maps::CPointsMap::copyFrom().

Here is the call graph for this function:

◆ clear()

void CMetricMap::clear ( )
inherited

◆ clipOutOfRange()

void CPointsMap::clipOutOfRange ( const mrpt::math::TPoint2D point,
float  maxRange 
)
inherited

Delete points which are more far than "maxRange" away from the given "point".

Definition at line 298 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::applyDeletionMask(), mrpt::maps::CPointsMap::mark_as_modified(), mrpt::maps::CPointsMap::size(), and mrpt::math::square().

Here is the call graph for this function:

◆ clipOutOfRangeInZ()

void CPointsMap::clipOutOfRangeInZ ( float  zMin,
float  zMax 
)
inherited

Delete points out of the given "z" axis range have been removed.

Definition at line 280 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::applyDeletionMask(), mrpt::maps::CPointsMap::mark_as_modified(), and mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ clone()

virtual mrpt::utils::CObject* mrpt::maps::CColouredPointsMap::clone ( ) const
overridevirtual

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

Implements mrpt::utils::CObject.

◆ COLOR_3DSCENE() [1/2]

void CPointsMap::COLOR_3DSCENE ( const mrpt::utils::TColorf value)
staticinherited

The color of points in getAs3DObject() (default=blue)

Definition at line 68 of file CPointsMap.cpp.

References COLOR_3DSCENE_value.

◆ COLOR_3DSCENE() [2/2]

mrpt::utils::TColorf CPointsMap::COLOR_3DSCENE ( )
staticinherited

Definition at line 69 of file CPointsMap.cpp.

References COLOR_3DSCENE_value.

◆ colourFromObservation()

bool CColouredPointsMap::colourFromObservation ( const mrpt::obs::CObservationImage obs,
const mrpt::poses::CPose3D robotPose 
)

◆ compute3DDistanceToMesh()

void CPointsMap::compute3DDistanceToMesh ( const mrpt::maps::CMetricMap otherMap2,
const mrpt::poses::CPose3D otherMapPose,
float  maxDistForCorrespondence,
mrpt::utils::TMatchingPairList correspondences,
float &  correspondencesRatio 
)
inherited

Computes the matchings between this and another 3D points map.

This method matches each point in the other map with the centroid of the 3 closest points in 3D from this map (if the distance is below a defined threshold).

Parameters
otherMap[IN] The other map to compute the matching with.
otherMapPose[IN] The pose of the other map as seen from "this".
maxDistForCorrespondence[IN] Maximum 2D linear distance between two points to be matched.
correspondences[OUT] The detected matchings pairs.
correspondencesRatio[OUT] The ratio [0,1] of points in otherMap with at least one correspondence.
See also
determineMatching3D

Definition at line 1303 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::boundingBox(), mrpt::math::distance(), mrpt::math::KDTreeCapable< CPointsMap >::kdTreeNClosestPoint3DWithIdx(), MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, mrpt::maps::CPointsMap::size(), mrpt::maps::CPointsMap::x, mrpt::maps::CPointsMap::y, and mrpt::maps::CPointsMap::z.

Here is the call graph for this function:

◆ compute3DMatchingRatio()

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

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 818 of file CPointsMap.cpp.

References mrpt::maps::TMatchingExtraResults::correspondencesRatio, mrpt::maps::CPointsMap::determineMatching3D(), mrpt::maps::CMetricMap::getAsSimplePointsMap(), and mrpt::maps::TMatchingRatioParams::maxDistForCorr.

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

◆ copyFrom()

void CColouredPointsMap::copyFrom ( const CPointsMap obj)
overridevirtual

Virtual assignment operator, to be implemented in derived classes.

Implements mrpt::maps::CPointsMap.

Definition at line 135 of file CColouredPointsMap.cpp.

References m_color_B, m_color_G, and m_color_R.

◆ Create()

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

Definition at line 32 of file CColouredPointsMap.h.

◆ CreateFromMapDefinition()

mrpt::maps::CColouredPointsMap * mrpt::maps::CColouredPointsMap::CreateFromMapDefinition ( const mrpt::maps::TMetricMapInitializer def)
static

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

Definition at line 33 of file CColouredPointsMap.cpp.

◆ CreateObject()

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

◆ derived() [1/2]

const CPointsMap & mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::derived ( ) const
inlineinherited

CRTP helper method.

Definition at line 91 of file KDTreeCapable.h.

◆ derived() [2/2]

CPointsMap & mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::derived ( )
inlineinherited

CRTP helper method.

Definition at line 96 of file KDTreeCapable.h.

◆ determineMatching2D()

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

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 from mrpt::maps::CMetricMap.

Definition at line 317 of file CPointsMap.cpp.

References ASSERT_, ASSERT_ABOVE_, ASSERT_BELOW_, ASSERTMSG_, mrpt::maps::CPointsMap::boundingBox(), CLASS_ID, mrpt::utils::TRuntimeClassId::derivedFrom(), mrpt::utils::TMatchingPairList::filterUniqueRobustPairs(), mrpt::maps::CMetricMap::GetRuntimeClass(), mrpt::math::KDTreeCapable< CPointsMap >::kdTreeClosestPoint2D(), min, MRPT_END, MRPT_START, mrpt::poses::CPose2D::phi(), mrpt::maps::CPointsMap::reserve(), mrpt::math::TPose2D::size(), mrpt::maps::CPointsMap::size(), mrpt::math::square(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

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

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

◆ determineMatching3D()

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

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 from mrpt::maps::CMetricMap.

Definition at line 1089 of file CPointsMap.cpp.

References ASSERT_, ASSERT_ABOVE_, ASSERT_BELOW_, ASSERTMSG_, mrpt::maps::CPointsMap::boundingBox(), CLASS_ID, mrpt::poses::CPose3D::composePoint(), mrpt::utils::TRuntimeClassId::derivedFrom(), mrpt::utils::TMatchingPairList::filterUniqueRobustPairs(), mrpt::maps::CMetricMap::GetRuntimeClass(), mrpt::math::KDTreeCapable< CPointsMap >::kdTreeClosestPoint3D(), min, MRPT_END, MRPT_START, mrpt::maps::CPointsMap::size(), and mrpt::math::square().

Referenced by mrpt::maps::CPointsMap::compute3DMatchingRatio(), and mrpt::slam::observationsOverlap().

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

◆ empty()

bool mrpt::maps::CPointsMap::empty ( ) const
inlineinherited

STL-like method to check whether the map is empty:

Definition at line 831 of file CPointsMap.h.

References mrpt::maps::CPointsMap::isEmpty().

Referenced by mrpt::maps::CHeightGridMap2D_Base::dem_internal_insertObservation().

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

◆ enableFilterByHeight()

void mrpt::maps::CPointsMap::enableFilterByHeight ( bool  enable = true)
inlineinherited

Enable/disable the filter-by-height functionality.

See also
setHeightFilterLevels
Note
Default upon construction is disabled.

Definition at line 911 of file CPointsMap.h.

References mrpt::maps::CPointsMap::m_heightfilter_enabled.

◆ extractCylinder()

void CPointsMap::extractCylinder ( const mrpt::math::TPoint2D center,
const double  radius,
const double  zmin,
const double  zmax,
CPointsMap outMap 
)
inherited

Extracts the points in the map within a cylinder in 3D defined the provided radius and zmin/zmax values.

Definition at line 1264 of file CPointsMap.cpp.

References mrpt::maps::CMetricMap::clear(), mrpt::maps::CPointsMap::insertPoint(), mrpt::math::square(), mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

Here is the call graph for this function:

◆ extractPoints()

void CPointsMap::extractPoints ( const mrpt::math::TPoint3D corner1,
const mrpt::math::TPoint3D corner2,
CPointsMap outMap,
const double &  R = 1,
const double &  G = 1,
const double &  B = 1 
)
inherited

Extracts the points in the map within the area defined by two corners.

The points are coloured according the R,G,B input data.

Definition at line 1280 of file CPointsMap.cpp.

References mrpt::maps::CMetricMap::clear(), mrpt::maps::CPointsMap::insertPoint(), min, R, mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

Here is the call graph for this function:

◆ fuseWith()

void CPointsMap::fuseWith ( CPointsMap anotherMap,
float  minDistForFuse = 0.02f,
std::vector< bool > *  notFusedPoints = nullptr 
)
inherited

Insert the contents of another map into this one, fusing the previous content with the new one.

This means that points very close to existing ones will be "fused", rather than "added". This prevents the unbounded increase in size of these class of maps. NOTICE that "otherMap" is neither translated nor rotated here, so if this is desired it must done before calling this method.

Parameters
otherMapThe other map whose points are to be inserted into this one.
minDistForFuseMinimum distance (in meters) between two points, each one in a map, to be considered the same one and be fused rather than added.
notFusedPointsIf a pointer is supplied, this list will contain at output a list with a "bool" value per point in "this" map. This will be false/true according to that point having been fused or not.
See also
loadFromRangeScan, addFrom

Definition at line 2064 of file CPointsMap.cpp.

References ASSERT_, mrpt::maps::CPointsMap::determineMatching2D(), mrpt::maps::CPointsMap::getPoint(), mrpt::maps::CPointsMap::insertPointFast(), mrpt::maps::CPointsMap::mark_as_modified(), mrpt::maps::CPointsMap::reserve(), mrpt::maps::CPointsMap::setPointWeight(), mrpt::maps::CPointsMap::size(), mrpt::math::square(), and mrpt::math::TPoint3D::x.

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

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

◆ getAllPoints() [1/4]

template<class VECTOR >
void mrpt::maps::CPointsMap::getAllPoints ( VECTOR &  xs,
VECTOR &  ys,
VECTOR &  zs,
size_t  decimation = 1 
) const
inlineinherited

Returns a copy of the 2D/3D points as a std::vector of float coordinates.

If decimation is greater than 1, only 1 point out of that number will be saved in the output, effectively performing a subsampling of the points.

See also
getPointsBufferRef_x, getPointsBufferRef_y, getPointsBufferRef_z
Template Parameters
VECTORcan be std::vector<float or double> or any row/column Eigen::Array or Eigen::Matrix (this includes mrpt::math::CVectorFloat and mrpt::math::CVectorDouble).

Definition at line 513 of file CPointsMap.h.

References ASSERT_, MRPT_END, and MRPT_START.

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

Here is the caller graph for this function:

◆ getAllPoints() [2/4]

template<class CONTAINER >
void mrpt::maps::CPointsMap::getAllPoints ( CONTAINER &  ps,
size_t  decimation = 1 
) const
inlineinherited

Gets all points as a STL-like container.

Template Parameters
CONTAINERAny STL-like container of mrpt::math::TPoint3D, mrpt::math::TPoint3Df or anything having members x,y,z. Note that this method is not efficient for large point clouds. Fastest methods are getPointsBuffer() or getPointsBufferRef_x(), getPointsBufferRef_y(), getPointsBufferRef_z()

Definition at line 541 of file CPointsMap.h.

References mrpt::maps::CPointsMap::getAllPoints().

Here is the call graph for this function:

◆ getAllPoints() [3/4]

void CPointsMap::getAllPoints ( std::vector< float > &  xs,
std::vector< float > &  ys,
size_t  decimation = 1 
) const
inherited

Returns a copy of the 2D/3D points as a std::vector of float coordinates.

If decimation is greater than 1, only 1 point out of that number will be saved in the output, effectively performing a subsampling of the points.

See also
setAllPoints

Definition at line 863 of file CPointsMap.cpp.

References ASSERT_, MRPT_END, MRPT_START, mrpt::maps::CPointsMap::x, and mrpt::maps::CPointsMap::y.

◆ getAllPoints() [4/4]

void mrpt::maps::CPointsMap::getAllPoints ( std::vector< mrpt::math::TPoint2D > &  ps,
size_t  decimation = 1 
) const
inlineinherited

Definition at line 564 of file CPointsMap.h.

References mrpt::maps::CPointsMap::getAllPoints().

Here is the call graph for this function:

◆ getAs3DObject()

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

Override of the default 3D scene builder to account for the individual points' color.

See also
mrpt::global_settings::POINTSMAPS_3DOBJECT_POINTSIZE

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 413 of file CColouredPointsMap.cpp.

References ASSERT_, and mrpt::global_settings::POINTSMAPS_3DOBJECT_POINTSIZE().

Here is the call graph for this function:

◆ getAsSimplePointsMap() [1/2]

virtual const mrpt::maps::CSimplePointsMap* mrpt::maps::CPointsMap::getAsSimplePointsMap ( ) const
inlineoverridevirtualinherited

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 from mrpt::maps::CMetricMap.

Reimplemented in mrpt::maps::CSimplePointsMap.

Definition at line 843 of file CPointsMap.h.

◆ getAsSimplePointsMap() [2/2]

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

Reimplemented from mrpt::maps::CMetricMap.

Reimplemented in mrpt::maps::CSimplePointsMap.

Definition at line 848 of file CPointsMap.h.

◆ getHeightFilterLevels()

void mrpt::maps::CPointsMap::getHeightFilterLevels ( double &  _z_min,
double &  _z_max 
) const
inlineinherited

Get the min/max Z levels for points to be actually inserted in the map.

See also
enableFilterByHeight, setHeightFilterLevels

Definition at line 930 of file CPointsMap.h.

References mrpt::maps::CPointsMap::m_heightfilter_z_max, and mrpt::maps::CPointsMap::m_heightfilter_z_min.

◆ getLargestDistanceFromOrigin()

float CPointsMap::getLargestDistanceFromOrigin ( ) const
inherited

This method returns the largest distance from the origin to any of the points, such as a sphere centered at the origin with this radius cover ALL the points in the map (the results are buffered, such as, if the map is not modified, the second call will be much faster than the first one).

Definition at line 839 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::m_largestDistanceFromOrigin, mrpt::maps::CPointsMap::m_largestDistanceFromOriginIsUpdated, and mrpt::math::square().

Here is the call graph for this function:

◆ getLargestDistanceFromOriginNoRecompute()

float mrpt::maps::CPointsMap::getLargestDistanceFromOriginNoRecompute ( bool &  output_is_valid) const
inlineinherited

Like getLargestDistanceFromOrigin() but returns in output_is_valid = false if the distance was not already computed, skipping its computation then, unlike getLargestDistanceFromOrigin()

Definition at line 863 of file CPointsMap.h.

References mrpt::maps::CPointsMap::m_largestDistanceFromOrigin, and mrpt::maps::CPointsMap::m_largestDistanceFromOriginIsUpdated.

◆ getLoadPLYErrorString()

std::string mrpt::utils::PLY_Importer::getLoadPLYErrorString ( ) const
inlineinherited

Return a description of the error if loadFromPlyFile() returned false, or an empty string if the file was loaded without problems.

Definition at line 46 of file PLY_import_export.h.

References mrpt::utils::PLY_Importer::m_ply_import_last_error.

◆ getPCLPointCloud()

template<class POINTCLOUD >
void mrpt::maps::CPointsMap::getPCLPointCloud ( POINTCLOUD &  cloud) const
inlineinherited

Use to convert this MRPT point cloud object into a PCL point cloud object (PointCloud<PointXYZ>).

Usage example:

mrpt::maps::CPointsCloud pc;
pcl::PointCloud<pcl::PointXYZ> cloud;
pc.getPCLPointCloud(cloud);
See also
setFromPCLPointCloud, CColouredPointsMap::getPCLPointCloudXYZRGB (for color data)

Definition at line 963 of file CPointsMap.h.

References mrpt::maps::CPointsMap::size().

Referenced by mrpt::maps::CPointsMap::loadPCDFile(), and mrpt::maps::CPointsMap::savePCDFile().

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

◆ getPCLPointCloudXYZRGB()

template<class POINTCLOUD >
void mrpt::maps::CColouredPointsMap::getPCLPointCloudXYZRGB ( POINTCLOUD &  cloud) const
inline

Like CPointsMap::getPCLPointCloud() but for PointCloud<PointXYZRGB>

Definition at line 315 of file CColouredPointsMap.h.

◆ getPoint() [1/7]

void CColouredPointsMap::getPoint ( size_t  index,
float &  x,
float &  y,
float &  z,
float &  R,
float &  G,
float &  B 
) const
overridevirtual

Retrieves a point and its color (colors range is [0,1])

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 479 of file CColouredPointsMap.cpp.

References m_color_B, m_color_G, m_color_R, R, and THROW_EXCEPTION.

Referenced by mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::getPointXYZ_RGBf(), and mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::getPointXYZ_RGBu8().

Here is the caller graph for this function:

◆ getPoint() [2/7]

unsigned long CColouredPointsMap::getPoint ( size_t  index,
float &  x,
float &  y,
float &  z 
) const

Retrieves a point.

Definition at line 464 of file CColouredPointsMap.cpp.

References THROW_EXCEPTION.

◆ getPoint() [3/7]

unsigned long CPointsMap::getPoint ( size_t  index,
float &  x,
float &  y 
) 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 213 of file CPointsMap.cpp.

References ASSERT_BELOW_, and mrpt::maps::CPointsMap::getPointWeight().

Here is the call graph for this function:

◆ getPoint() [4/7]

unsigned long CPointsMap::getPoint ( size_t  index,
double &  x,
double &  y,
double &  z 
) 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 243 of file CPointsMap.cpp.

References ASSERT_BELOW_, and mrpt::maps::CPointsMap::getPointWeight().

Here is the call graph for this function:

◆ getPoint() [5/7]

unsigned long CPointsMap::getPoint ( size_t  index,
double &  x,
double &  y 
) 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 233 of file CPointsMap.cpp.

References ASSERT_BELOW_, and mrpt::maps::CPointsMap::getPointWeight().

Here is the call graph for this function:

◆ getPoint() [6/7]

unsigned long mrpt::maps::CPointsMap::getPoint ( size_t  index,
mrpt::math::TPoint2D p 
) 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 400 of file CPointsMap.h.

References mrpt::maps::CPointsMap::getPoint().

Here is the call graph for this function:

◆ getPoint() [7/7]

unsigned long mrpt::maps::CPointsMap::getPoint ( size_t  index,
mrpt::math::TPoint3D p 
) 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 405 of file CPointsMap.h.

References mrpt::maps::CPointsMap::getPoint().

Here is the call graph for this function:

◆ getPointAllFields()

void mrpt::maps::CPointsMap::getPointAllFields ( const size_t  index,
std::vector< float > &  point_data 
) const
inlineinherited

Get all the data fields for one point as a vector: depending on the implementation class this can be [X Y Z] or [X Y Z R G B], etc...

See also
getPointAllFieldsFast, setPointAllFields, setPointAllFieldsFast

Definition at line 649 of file CPointsMap.h.

References ASSERT_BELOW_, mrpt::maps::CPointsMap::getPointAllFieldsFast(), and mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ getPointAllFieldsFast()

virtual void mrpt::maps::CColouredPointsMap::getPointAllFieldsFast ( const size_t  index,
std::vector< float > &  point_data 
) const
inlineoverridevirtual

Get all the data fields for one point as a vector: [X Y Z R G B] Unlike getPointAllFields(), this method does not check for index out of bounds.

See also
getPointAllFields, setPointAllFields, setPointAllFieldsFast

Implements mrpt::maps::CPointsMap.

Definition at line 74 of file CColouredPointsMap.h.

◆ getPointColor()

void CColouredPointsMap::getPointColor ( size_t  index,
float &  R,
float &  G,
float &  B 
) const

Retrieves a point color (colors range is [0,1])

Definition at line 496 of file CColouredPointsMap.cpp.

References m_color_B, m_color_G, m_color_R, R, and THROW_EXCEPTION.

◆ getPointColor_fast()

void mrpt::maps::CColouredPointsMap::getPointColor_fast ( size_t  index,
float &  R,
float &  G,
float &  B 
) const
inline

Like getPointColor but without checking for out-of-index erors.

Definition at line 215 of file CColouredPointsMap.h.

References m_color_G, m_color_R, and R.

◆ getPointFast()

void mrpt::maps::CPointsMap::getPointFast ( size_t  index,
float &  x,
float &  y,
float &  z 
) const
inlineinherited

◆ getPointsBuffer()

void CPointsMap::getPointsBuffer ( size_t &  outPointsCount,
const float *&  xs,
const float *&  ys,
const float *&  zs 
) const
inherited

◆ getPointsBufferRef_x()

const std::vector<float>& mrpt::maps::CPointsMap::getPointsBufferRef_x ( ) const
inlineinherited

Provides a direct access to a read-only reference of the internal point buffer.

See also
getAllPoints

Definition at line 496 of file CPointsMap.h.

References mrpt::maps::CPointsMap::x.

◆ getPointsBufferRef_y()

const std::vector<float>& mrpt::maps::CPointsMap::getPointsBufferRef_y ( ) const
inlineinherited

Provides a direct access to a read-only reference of the internal point buffer.

See also
getAllPoints

Definition at line 499 of file CPointsMap.h.

References mrpt::maps::CPointsMap::y.

◆ getPointsBufferRef_z()

const std::vector<float>& mrpt::maps::CPointsMap::getPointsBufferRef_z ( ) const
inlineinherited

Provides a direct access to a read-only reference of the internal point buffer.

See also
getAllPoints

Definition at line 502 of file CPointsMap.h.

References mrpt::maps::CPointsMap::z.

◆ getPointWeight()

virtual unsigned int mrpt::maps::CPointsMap::getPointWeight ( size_t  index) const
inlinevirtualinherited

Gets the point weight, which is ignored in all classes (defaults to 1) but in those which actually store that field (Note: No checks are done for out-of-bounds index).

See also
setPointWeight

Reimplemented in mrpt::maps::CWeightedPointsMap.

Definition at line 481 of file CPointsMap.h.

References MRPT_UNUSED_PARAM.

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

Here is the caller graph for this function:

◆ GetRuntimeClass()

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

Returns information about the class of an object in runtime.

Reimplemented from mrpt::maps::CPointsMap.

◆ GetRuntimeClassIdStatic()

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

◆ getSavePLYErrorString()

std::string mrpt::utils::PLY_Exporter::getSavePLYErrorString ( ) const
inlineinherited

Return a description of the error if loadFromPlyFile() returned false, or an empty string if the file was loaded without problems.

Definition at line 104 of file PLY_import_export.h.

References mrpt::utils::PLY_Exporter::m_ply_export_last_error.

◆ hasColorPoints()

virtual bool mrpt::maps::CColouredPointsMap::hasColorPoints ( ) const
inlineoverridevirtual

Returns true if the point map has a color field for each point.

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 224 of file CColouredPointsMap.h.

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

◆ insertAnotherMap()

void CPointsMap::insertAnotherMap ( const CPointsMap otherMap,
const mrpt::poses::CPose3D otherPose 
)
inherited

Insert the contents of another map into this one with some geometric transformation, without fusing close points.

Parameters
otherMapThe other map whose points are to be inserted into this one.
otherPoseThe pose of the other map in the coordinates of THIS map
See also
fuseWith, addFrom

Definition at line 1738 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::addFrom_classSpecific(), mrpt::poses::CPose3D::composePoint(), mrpt::maps::CPointsMap::getPointFast(), mrpt::maps::CPointsMap::mark_as_modified(), mrpt::maps::CPointsMap::resize(), mrpt::maps::CPointsMap::setPointFast(), mrpt::maps::CPointsMap::size(), mrpt::math::TPoint3Df::x, mrpt::math::TPoint3Df::y, and mrpt::math::TPoint3Df::z.

Referenced by mrpt::nav::CReactiveNavigationSystem3D::loggingGetWSObstaclesAndShape().

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:

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

◆ insertPoint() [1/5]

void CColouredPointsMap::insertPoint ( float  x,
float  y,
float  z,
float  R,
float  G,
float  B 
)
overridevirtual

Adds a new point given its coordinates and color (colors range is [0,1])

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 397 of file CColouredPointsMap.cpp.

References R.

Referenced by mrpt::mrpt::utils::fix(), and mrpt::mrpt::utils::getAs().

Here is the caller graph for this function:

◆ insertPoint() [2/5]

void mrpt::maps::CColouredPointsMap::insertPoint ( const mrpt::poses::CPoint3D p)
inline

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 168 of file CColouredPointsMap.h.

◆ insertPoint() [3/5]

void mrpt::maps::CColouredPointsMap::insertPoint ( const mrpt::math::TPoint3D p)
inline

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 173 of file CColouredPointsMap.h.

◆ insertPoint() [4/5]

void mrpt::maps::CColouredPointsMap::insertPoint ( const mrpt::math::TPoint3Df p)
inline

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 178 of file CColouredPointsMap.h.

◆ insertPoint() [5/5]

void mrpt::maps::CColouredPointsMap::insertPoint ( float  x,
float  y,
float  z 
)
inline

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 183 of file CColouredPointsMap.h.

References insertPointFast().

Here is the call graph for this function:

◆ insertPointFast()

void CColouredPointsMap::insertPointFast ( float  x,
float  y,
float  z = 0 
)
overridevirtual

The virtual method for insertPoint() without calling mark_as_modified()

Implements mrpt::maps::CPointsMap.

Definition at line 385 of file CColouredPointsMap.cpp.

Referenced by insertPoint().

Here is the caller graph for this function:

◆ internal_clear()

void CColouredPointsMap::internal_clear ( )
overrideprotectedvirtual

Minimum distance from where the points have been seen.

Clear the map, erasing all the points

Implements mrpt::maps::CMetricMap.

Definition at line 343 of file CColouredPointsMap.cpp.

References mrpt::utils::vector_strong_clear().

Here is the call graph for this function:

◆ internal_computeObservationLikelihood()

double CPointsMap::internal_computeObservationLikelihood ( const mrpt::obs::CObservation obs,
const mrpt::poses::CPose3D takenFrom 
)
overridevirtualinherited

◆ internal_CreateFromMapDefinition()

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

◆ internal_insertObservation()

bool CPointsMap::internal_insertObservation ( const mrpt::obs::CObservation obs,
const mrpt::poses::CPose3D robotPose 
)
overrideprotectedvirtualinherited

This is a common version of CMetricMap::insertObservation() for point maps (actually, CMetricMap::internal_insertObservation), so derived classes don't need to worry implementing that method unless something special is really necesary.

See mrpt::maps::CPointsMap for the enumeration of types of observations which are accepted.

Implements mrpt::maps::CMetricMap.

Definition at line 1796 of file CPointsMap.cpp.

References mrpt::obs::gnss::a1, mrpt::obs::gnss::a2, mrpt::maps::CPointsMap::TInsertionOptions::addToExistingPointsMap, mrpt::maps::CPointsMap::applyDeletionMask(), mrpt::obs::CObservationRange::begin(), mrpt::poses::CPose3D::composePoint(), mrpt::maps::CPointsMap::TInsertionOptions::disableDeletion, mrpt::obs::CObservationRange::end(), mrpt::maps::CPointsMap::fuseWith(), mrpt::maps::CPointsMap::TInsertionOptions::fuseWithExisting, mrpt::maps::CPointsMap::getPoint(), mrpt::maps::CPointsMap::getPointsBuffer(), mrpt::maps::CPointsMap::TInsertionOptions::horizontalTolerance, mrpt::maps::CPointsMap::insertionOptions, mrpt::maps::CPointsMap::insertPointFast(), IS_CLASS, mrpt::maps::CPointsMap::TInsertionOptions::isPlanarMap, mrpt::obs::CObservation2DRangeScan::isPlanarScan(), mrpt::maps::CSimplePointsMap::loadFromRangeScan(), mrpt::maps::CPointsMap::loadFromRangeScan(), mrpt::maps::CPointsMap::loadFromVelodyneScan(), mrpt::maps::CPointsMap::mark_as_modified(), mrpt::obs::CObservationRange::maxSensorDistance, mrpt::maps::CPointsMap::TInsertionOptions::minDistBetweenLaserPoints, MRPT_END, MRPT_START, mrpt::math::CPolygon::PointIntoPolygon(), mrpt::maps::CPointsMap::reserve(), mrpt::utils::round(), mrpt::obs::CObservationRange::sensedData, mrpt::obs::CObservationRange::sensorConeApperture, mrpt::math::CPolygon::setAllVertices(), mrpt::maps::CPointsMap::size(), mrpt::math::TPoint3D::x, mrpt::maps::CPointsMap::x, mrpt::math::TPoint3D::y, mrpt::maps::CPointsMap::y, and mrpt::math::TPoint3D::z.

Here is the call graph for this function:

◆ isEmpty()

bool CPointsMap::isEmpty ( ) const
overridevirtualinherited

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

Implements mrpt::maps::CMetricMap.

Definition at line 657 of file CPointsMap.cpp.

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

Here is the caller graph for this function:

◆ isFilterByHeightEnabled()

bool mrpt::maps::CPointsMap::isFilterByHeightEnabled ( ) const
inlineinherited

Return whether filter-by-height is enabled.

See also
enableFilterByHeight

Definition at line 916 of file CPointsMap.h.

References mrpt::maps::CPointsMap::m_heightfilter_enabled.

◆ kdtree_distance()

float mrpt::maps::CPointsMap::kdtree_distance ( const float *  p1,
const size_t  idx_p2,
size_t  size 
) const
inlineinherited

Returns the distance between the vector "p1[0:size-1]" and the data point with index "idx_p2" stored in the class:

Definition at line 1025 of file CPointsMap.h.

◆ kdtree_get_bbox()

template<typename BBOX >
bool mrpt::maps::CPointsMap::kdtree_get_bbox ( BBOX &  bb) const
inlineinherited

Definition at line 1050 of file CPointsMap.h.

References mrpt::maps::CPointsMap::boundingBox().

Here is the call graph for this function:

◆ kdtree_get_point_count()

size_t mrpt::maps::CPointsMap::kdtree_get_point_count ( ) const
inlineinherited

Must return the number of data points.

Definition at line 1009 of file CPointsMap.h.

References mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ kdtree_get_pt()

float mrpt::maps::CPointsMap::kdtree_get_pt ( const size_t  idx,
int  dim 
) const
inlineinherited

Returns the dim'th component of the idx'th point in the class:

Definition at line 1011 of file CPointsMap.h.

◆ kdtree_mark_as_outdated()

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdtree_mark_as_outdated ( ) const
inlineprotectedinherited

To be called by child classes when KD tree data changes.

Definition at line 734 of file KDTreeCapable.h.

Referenced by mrpt::maps::CPointsMap::base_copyFrom(), and mrpt::maps::CPointsMap::mark_as_modified().

◆ kdTreeClosestPoint2D() [1/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint2D ( float  x0,
float  y0,
float &  out_x,
float &  out_y,
float &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the closest point (only ONE) to some given 2D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 3D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
out_xThe X coordinate of the found closest correspondence.
out_yThe Y coordinate of the found closest correspondence.
out_dist_sqrThe square distance between the query and the returned point.
Returns
The index of the closest point in the map array.
See also
kdTreeClosestPoint3D, kdTreeTwoClosestPoint2D

Definition at line 127 of file KDTreeCapable.h.

Referenced by mrpt::maps::CPointsMap::determineMatching2D(), and mrpt::maps::CPointsMap::internal_computeObservationLikelihood().

◆ kdTreeClosestPoint2D() [2/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint2D ( float  x0,
float  y0,
float &  out_dist_sqr 
) 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 156 of file KDTreeCapable.h.

◆ kdTreeClosestPoint2D() [3/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint2D ( const TPoint2D p0,
TPoint2D pOut,
float &  outDistSqr 
) 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 180 of file KDTreeCapable.h.

◆ kdTreeClosestPoint2DsqrError() [1/2]

float mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint2DsqrError ( float  x0,
float  y0 
) const
inlineinherited

Like kdTreeClosestPoint2D, but just return the square error from some point to its closest neighbor.

Definition at line 195 of file KDTreeCapable.h.

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

◆ kdTreeClosestPoint2DsqrError() [2/2]

float mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint2DsqrError ( const TPoint2D p0) const
inlineinherited

Definition at line 202 of file KDTreeCapable.h.

◆ kdTreeClosestPoint3D() [1/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint3D ( float  x0,
float  y0,
float  z0,
float &  out_x,
float &  out_y,
float &  out_z,
float &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the closest point (only ONE) to some given 3D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 2D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
z0The Z coordinate of the query.
out_xThe X coordinate of the found closest correspondence.
out_yThe Y coordinate of the found closest correspondence.
out_zThe Z coordinate of the found closest correspondence.
out_dist_sqrThe square distance between the query and the returned point.
Returns
The index of the closest point in the map array.
See also
kdTreeClosestPoint2D

Definition at line 410 of file KDTreeCapable.h.

Referenced by mrpt::maps::CPointsMap::determineMatching3D(), and mrpt::maps::CPointsMap::internal_computeObservationLikelihood().

◆ kdTreeClosestPoint3D() [2/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint3D ( float  x0,
float  y0,
float  z0,
float &  out_dist_sqr 
) 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 441 of file KDTreeCapable.h.

◆ kdTreeClosestPoint3D() [3/3]

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeClosestPoint3D ( const TPoint3D p0,
TPoint3D pOut,
float &  outDistSqr 
) 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 466 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint2D() [1/2]

std::vector<size_t> mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint2D ( float  x0,
float  y0,
size_t  knn,
std::vector< float > &  out_x,
std::vector< float > &  out_y,
std::vector< float > &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the N closest point to some given 2D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 3D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
NThe number of closest points to search.
out_xThe vector containing the X coordinates of the correspondences.
out_yThe vector containing the Y coordinates of the correspondences.
out_dist_sqrThe vector containing the square distance between the query and the returned points.
Returns
The list of indices
See also
kdTreeClosestPoint2D
kdTreeTwoClosestPoint2D

Definition at line 295 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint2D() [2/2]

std::vector<size_t> mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint2D ( const TPoint2D p0,
size_t  N,
std::vector< TPoint2D > &  pOut,
std::vector< float > &  outDistSqr 
) const
inlineinherited

Definition at line 327 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint2DIdx() [1/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint2DIdx ( float  x0,
float  y0,
size_t  knn,
std::vector< size_t > &  out_idx,
std::vector< float > &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the N closest point to some given 2D coordinates and returns their indexes.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 3D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
NThe number of closest points to search.
out_idxThe indexes of the found closest correspondence.
out_dist_sqrThe square distance between the query and the returned point.
See also
kdTreeClosestPoint2D

Definition at line 360 of file KDTreeCapable.h.

Referenced by colourFromObservation().

◆ kdTreeNClosestPoint2DIdx() [2/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint2DIdx ( const TPoint2D p0,
size_t  N,
std::vector< size_t > &  outIdx,
std::vector< float > &  outDistSqr 
) const
inlineinherited

Definition at line 382 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint3D() [1/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint3D ( float  x0,
float  y0,
float  z0,
size_t  knn,
std::vector< float > &  out_x,
std::vector< float > &  out_y,
std::vector< float > &  out_z,
std::vector< float > &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the N closest points to some given 3D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 2D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
z0The Z coordinate of the query.
NThe number of closest points to search.
out_xThe vector containing the X coordinates of the correspondences.
out_yThe vector containing the Y coordinates of the correspondences.
out_zThe vector containing the Z coordinates of the correspondences.
out_dist_sqrThe vector containing the square distance between the query and the returned points.
See also
kdTreeNClosestPoint2D

Definition at line 501 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint3D() [2/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint3D ( const TPoint3D p0,
size_t  N,
std::vector< TPoint3D > &  pOut,
std::vector< float > &  outDistSqr 
) const
inlineinherited

Definition at line 594 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint3DIdx() [1/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint3DIdx ( float  x0,
float  y0,
float  z0,
size_t  knn,
std::vector< size_t > &  out_idx,
std::vector< float > &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the N closest point to some given 3D coordinates and returns their indexes.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 2D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
z0The Z coordinate of the query.
NThe number of closest points to search.
out_idxThe indexes of the found closest correspondence.
out_dist_sqrThe square distance between the query and the returned point.
See also
kdTreeClosestPoint2D, kdTreeRadiusSearch3D

Definition at line 698 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint3DIdx() [2/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint3DIdx ( const TPoint3D p0,
size_t  N,
std::vector< size_t > &  outIdx,
std::vector< float > &  outDistSqr 
) const
inlineinherited

Definition at line 721 of file KDTreeCapable.h.

◆ kdTreeNClosestPoint3DWithIdx()

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeNClosestPoint3DWithIdx ( float  x0,
float  y0,
float  z0,
size_t  knn,
std::vector< float > &  out_x,
std::vector< float > &  out_y,
std::vector< float > &  out_z,
std::vector< size_t > &  out_idx,
std::vector< float > &  out_dist_sqr 
) const
inlineinherited

KD Tree-based search for the N closest points to some given 3D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 2D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
z0The Z coordinate of the query.
NThe number of closest points to search.
out_xThe vector containing the X coordinates of the correspondences.
out_yThe vector containing the Y coordinates of the correspondences.
out_zThe vector containing the Z coordinates of the correspondences.
out_idxThe vector containing the indexes of the correspondences.
out_dist_sqrThe vector containing the square distance between the query and the returned points.
See also
kdTreeNClosestPoint2D

Definition at line 559 of file KDTreeCapable.h.

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

◆ kdTreeRadiusSearch2D()

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeRadiusSearch2D ( const float  x0,
const float  y0,
const float  maxRadiusSqr,
std::vector< std::pair< size_t, float >> &  out_indices_dist 
) const
inlineinherited

KD Tree-based search for all the points within a given radius of some 2D point.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 3D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
maxRadiusSqrThe square of the desired search radius.
out_indices_distThe output list, with pairs of indeces/squared distances for the found correspondences.
Returns
Number of found points.
See also
kdTreeRadiusSearch3D, kdTreeNClosestPoint2DIdx

Definition at line 663 of file KDTreeCapable.h.

◆ kdTreeRadiusSearch3D()

size_t mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeRadiusSearch3D ( const float  x0,
const float  y0,
const float  z0,
const float  maxRadiusSqr,
std::vector< std::pair< size_t, float >> &  out_indices_dist 
) const
inlineinherited

KD Tree-based search for all the points within a given radius of some 3D point.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 2D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
z0The Z coordinate of the query.
maxRadiusSqrThe square of the desired search radius.
out_indices_distThe output list, with pairs of indeces/squared distances for the found correspondences.
Returns
Number of found points.
See also
kdTreeRadiusSearch2D, kdTreeNClosestPoint3DIdx

Definition at line 628 of file KDTreeCapable.h.

◆ kdTreeTwoClosestPoint2D() [1/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeTwoClosestPoint2D ( float  x0,
float  y0,
float &  out_x1,
float &  out_y1,
float &  out_x2,
float &  out_y2,
float &  out_dist_sqr1,
float &  out_dist_sqr2 
) const
inlineinherited

KD Tree-based search for the TWO closest point to some given 2D coordinates.

This method automatically build the "m_kdtree_data" structure when:

  • It is called for the first time
  • The map has changed
  • The KD-tree was build for 3D.
Parameters
x0The X coordinate of the query.
y0The Y coordinate of the query.
out_x1The X coordinate of the first correspondence.
out_y1The Y coordinate of the first correspondence.
out_x2The X coordinate of the second correspondence.
out_y2The Y coordinate of the second correspondence.
out_dist_sqr1The square distance between the query and the first returned point.
out_dist_sqr2The square distance between the query and the second returned point.
See also
kdTreeClosestPoint2D

Definition at line 228 of file KDTreeCapable.h.

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

◆ kdTreeTwoClosestPoint2D() [2/2]

void mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdTreeTwoClosestPoint2D ( const TPoint2D p0,
TPoint2D pOut1,
TPoint2D pOut2,
float &  outDistSqr1,
float &  outDistSqr2 
) const
inlineinherited

Definition at line 261 of file KDTreeCapable.h.

◆ load2D_from_text_file()

bool mrpt::maps::CPointsMap::load2D_from_text_file ( const std::string file)
inlineinherited

Load from a text file.

Each line should contain an "X Y" coordinate pair, separated by whitespaces. Returns false if any error occured, true elsewere.

Definition at line 332 of file CPointsMap.h.

References mrpt::maps::CPointsMap::load2Dor3D_from_text_file().

Here is the call graph for this function:

◆ load2Dor3D_from_text_file()

bool CPointsMap::load2Dor3D_from_text_file ( const std::string file,
const bool  is_3D 
)
inherited

2D or 3D generic implementation of load2D_from_text_file and load3D_from_text_file

Definition at line 131 of file CPointsMap.cpp.

References mrpt::maps::CMetricMap::clear(), mrpt::system::os::fclose(), mrpt::system::os::fopen(), mrpt::maps::CPointsMap::insertPoint(), mrpt::maps::CPointsMap::mark_as_modified(), MRPT_END, and MRPT_START.

Referenced by mrpt::maps::CPointsMap::load2D_from_text_file(), and mrpt::maps::CPointsMap::load3D_from_text_file().

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

◆ load3D_from_text_file()

bool mrpt::maps::CPointsMap::load3D_from_text_file ( const std::string file)
inlineinherited

Load from a text file.

Each line should contain an "X Y Z" coordinate tuple, separated by whitespaces. Returns false if any error occured, true elsewere.

Definition at line 341 of file CPointsMap.h.

References mrpt::maps::CPointsMap::load2Dor3D_from_text_file().

Here is the call graph for this function:

◆ loadFromPlyFile()

bool PLY_Importer::loadFromPlyFile ( const std::string filename,
CStringList file_comments = nullptr,
CStringList file_obj_info = nullptr 
)
inherited

Loads from a PLY file.

Parameters
[in]filenameThe filename to open. It can be either in binary or text format.
[out]file_commentsIf provided (!=nullptr) the list of comment strings stored in the file will be returned.
[out]file_obj_infoIf provided (!=nullptr) the list of "object info" strings stored in the file will be returned.
Returns
false on any error in the file format or reading it. To obtain more details on the error you can call getLoadPLYErrorString()

Definition at line 1855 of file PLY_import_export.cpp.

References TVertex::b, TVertex::g, TVertex::intensity, ply_close(), ply_get_comments(), ply_get_element(), ply_get_element_description(), ply_get_obj_info(), ply_get_property(), ply_open_for_reading(), TVertex::r, VAL_NOT_SET, vert_props, TVertex::x, TVertex::y, and TVertex::z.

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:

◆ loadFromRangeScan() [1/2]

void CColouredPointsMap::loadFromRangeScan ( const mrpt::obs::CObservation2DRangeScan rangeScan,
const mrpt::poses::CPose3D robotPose = nullptr 
)
overridevirtual

See CPointsMap::loadFromRangeScan()

Implements mrpt::maps::CPointsMap.

Definition at line 1110 of file CColouredPointsMap.cpp.

References mrpt::maps::detail::loadFromRangeImpl< Derived >::templ_loadFromRangeScan().

Here is the call graph for this function:

◆ loadFromRangeScan() [2/2]

void CColouredPointsMap::loadFromRangeScan ( const mrpt::obs::CObservation3DRangeScan rangeScan,
const mrpt::poses::CPose3D robotPose = nullptr 
)
overridevirtual

See CPointsMap::loadFromRangeScan()

Implements mrpt::maps::CPointsMap.

Definition at line 1118 of file CColouredPointsMap.cpp.

References mrpt::maps::detail::loadFromRangeImpl< Derived >::templ_loadFromRangeScan().

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

◆ loadFromVelodyneScan()

void CPointsMap::loadFromVelodyneScan ( const mrpt::obs::CObservationVelodyneScan scan,
const mrpt::poses::CPose3D robotPose = nullptr 
)
inherited

Like loadFromRangeScan() for Velodyne 3D scans.

Points are translated and rotated according to the sensorPose field in the observation and, if provided, to the robotPose parameter.

Parameters
scanThe Raw LIDAR data to be inserted into this map. It MUST contain point cloud data, generated by calling to mrpt::obs::CObservationVelodyneScan::generatePointCloud() prior to insertion in this map.
robotPoseDefault to (0,0,0|0deg,0deg,0deg). Changes the frame of reference for the point cloud (i.e. the vehicle/robot pose in world coordinates).
See also
loadFromRangeScan

Definition at line 2154 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::TInsertionOptions::addToExistingPointsMap, ASSERT_EQUAL_, mrpt::poses::CPose3D::getHomogeneousMatrix(), mrpt::maps::CPointsMap::insertionOptions, mrpt::obs::CObservationVelodyneScan::TPointCloud::intensity, mrpt::maps::CPointsMap::mark_as_modified(), mrpt::obs::CObservationVelodyneScan::point_cloud, mrpt::maps::CPointsMap::resize(), mrpt::obs::CObservationVelodyneScan::sensorPose, mrpt::maps::CPointsMap::setPoint(), mrpt::obs::CObservationVelodyneScan::TPointCloud::size(), mrpt::maps::CPointsMap::size(), mrpt::obs::CObservationVelodyneScan::TPointCloud::x, mrpt::obs::CObservationVelodyneScan::TPointCloud::y, and mrpt::obs::CObservationVelodyneScan::TPointCloud::z.

Referenced by mrpt::maps::CHeightGridMap2D_Base::dem_internal_insertObservation(), and mrpt::maps::CPointsMap::internal_insertObservation().

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

◆ loadPCDFile()

bool CPointsMap::loadPCDFile ( const std::string filename)
virtualinherited

Load the point cloud from a PCL PCD file (requires MRPT built against PCL)

Returns
false on any error

Definition at line 1693 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::getPCLPointCloud(), MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ MapDefinition()

mrpt::maps::TMetricMapInitializer * mrpt::maps::CColouredPointsMap::MapDefinition ( )
static

Returns default map definition initializer.

See * mrpt::maps::TMetricMapInitializer

Definition at line 33 of file CColouredPointsMap.cpp.

◆ mark_as_modified()

void mrpt::maps::CPointsMap::mark_as_modified ( ) const
inlineinherited

◆ operator delete() [1/3]

void mrpt::maps::CColouredPointsMap::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 32 of file CColouredPointsMap.h.

◆ operator delete() [2/3]

void mrpt::maps::CColouredPointsMap::operator delete ( void ptr)
inlinenoexcept

Definition at line 32 of file CColouredPointsMap.h.

◆ operator delete() [3/3]

void mrpt::maps::CColouredPointsMap::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 32 of file CColouredPointsMap.h.

◆ operator delete[]()

void mrpt::maps::CColouredPointsMap::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 32 of file CColouredPointsMap.h.

◆ operator new() [1/3]

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

Definition at line 32 of file CColouredPointsMap.h.

◆ operator new() [2/3]

void* mrpt::maps::CColouredPointsMap::operator new ( size_t  size)
inline

Definition at line 32 of file CColouredPointsMap.h.

◆ operator new() [3/3]

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

Definition at line 32 of file CColouredPointsMap.h.

◆ operator new[]()

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

Definition at line 32 of file CColouredPointsMap.h.

◆ operator+=()

void mrpt::maps::CPointsMap::operator+= ( const CPointsMap anotherMap)
inlineinherited

This operator is synonymous with addFrom.

See also
addFrom

Definition at line 309 of file CPointsMap.h.

References mrpt::maps::CPointsMap::addFrom().

Here is the call graph for this function:

◆ PLY_export_get_face_count()

size_t mrpt::maps::CPointsMap::PLY_export_get_face_count ( ) const
inlineoverrideprotectedvirtualinherited

In a base class, return the number of faces.

Implements mrpt::utils::PLY_Exporter.

Definition at line 1130 of file CPointsMap.h.

◆ PLY_export_get_vertex()

void CColouredPointsMap::PLY_export_get_vertex ( const size_t  idx,
mrpt::math::TPoint3Df pt,
bool &  pt_has_color,
mrpt::utils::TColorf pt_color 
) const
overrideprotectedvirtual

In a base class, will be called after PLY_export_get_vertex_count() once for each exported point.

Parameters
pt_colorWill be nullptr if the loaded file does not provide color info.

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 682 of file CColouredPointsMap.cpp.

References mrpt::utils::TColorf::B, mrpt::utils::TColorf::G, m_color_B, m_color_G, m_color_R, mrpt::utils::TColorf::R, mrpt::math::TPoint3Df::x, mrpt::math::TPoint3Df::y, and mrpt::math::TPoint3Df::z.

◆ PLY_export_get_vertex_count()

size_t CPointsMap::PLY_export_get_vertex_count ( ) const
overrideprotectedvirtualinherited

In a base class, return the number of vertices.

Implements mrpt::utils::PLY_Exporter.

Definition at line 1631 of file CPointsMap.cpp.

References mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ PLY_import_set_face_count()

virtual void mrpt::maps::CPointsMap::PLY_import_set_face_count ( const size_t  N)
inlineoverrideprotectedvirtualinherited

In a base class, reserve memory to prepare subsequent calls to PLY_import_set_face.

Implements mrpt::utils::PLY_Importer.

Definition at line 1112 of file CPointsMap.h.

References MRPT_UNUSED_PARAM.

◆ PLY_import_set_vertex()

void CColouredPointsMap::PLY_import_set_vertex ( const size_t  idx,
const mrpt::math::TPoint3Df pt,
const mrpt::utils::TColorf pt_color = nullptr 
)
overrideprotectedvirtual

In a base class, will be called after PLY_import_set_vertex_count() once for each loaded point.

Parameters
pt_colorWill be nullptr if the loaded file does not provide color info.

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 666 of file CColouredPointsMap.cpp.

References mrpt::utils::TColorf::B, mrpt::utils::TColorf::G, mrpt::utils::TColorf::R, setPoint(), mrpt::math::TPoint3Df::x, mrpt::math::TPoint3Df::y, and mrpt::math::TPoint3Df::z.

Here is the call graph for this function:

◆ PLY_import_set_vertex_count()

void CColouredPointsMap::PLY_import_set_vertex_count ( const size_t  N)
overrideprotectedvirtual

In a base class, reserve memory to prepare subsequent calls to PLY_import_set_vertex.

Implements mrpt::utils::PLY_Importer.

Definition at line 656 of file CColouredPointsMap.cpp.

References setSize().

Here is the call graph for this function:

◆ publishEvent()

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

◆ readFromStream()

void CColouredPointsMap::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
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

Implements mrpt::utils::CSerializable.

Definition at line 188 of file CColouredPointsMap.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ reserve()

void CColouredPointsMap::reserve ( size_t  newLength)
overridevirtual

Reserves memory for a given number of points: the size of the map does not change, it only reserves the memory.

This is useful for situations where it is approximately known the final size of the map. This method is more efficient than constantly increasing the size of the buffers. Refer to the STL C++ library's "reserve" methods.

Implements mrpt::maps::CPointsMap.

Definition at line 88 of file CColouredPointsMap.cpp.

References mrpt::utils::length2length4N().

Referenced by setFromPCLPointCloudRGB().

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

◆ resetPointsMinDist()

void CColouredPointsMap::resetPointsMinDist ( float  defValue = 2000.0f)

Reset the minimum-observed-distance buffer for all the points to a predefined value.

Definition at line 627 of file CColouredPointsMap.cpp.

References MRPT_UNUSED_PARAM.

◆ resize()

void CColouredPointsMap::resize ( size_t  newLength)
overridevirtual

Resizes all point buffers so they can hold the given number of points: newly created points are set to default values, and old contents are not changed.

See also
reserve, setPoint, setPointFast, setSize

Implements mrpt::maps::CPointsMap.

Definition at line 103 of file CColouredPointsMap.cpp.

Referenced by mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::resize().

Here is the caller graph for this function:

◆ save2D_to_text_file()

bool CPointsMap::save2D_to_text_file ( const std::string file) const
inherited

Save to a text file.

Each line will contain "X Y" point coordinates. Returns false if any error occured, true elsewere.

Definition at line 97 of file CPointsMap.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), and mrpt::system::os::fprintf().

Here is the call graph for this function:

◆ save3D_and_colour_to_text_file()

bool CColouredPointsMap::save3D_and_colour_to_text_file ( const std::string file) const

Save to a text file.

In each line contains X Y Z (meters) R G B (range [0,1]) for each point in the map. Returns false if any error occured, true elsewere.

Definition at line 633 of file CColouredPointsMap.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), mrpt::system::os::fprintf(), m_color_B, m_color_G, and m_color_R.

Here is the call graph for this function:

◆ save3D_to_text_file()

bool CPointsMap::save3D_to_text_file ( const std::string file) const
inherited

Save to a text file.

Each line will contain "X Y Z" point coordinates. Returns false if any error occured, true elsewere.

Definition at line 114 of file CPointsMap.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), and mrpt::system::os::fprintf().

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

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

◆ saveMetricMapRepresentationToFile()

void mrpt::maps::CPointsMap::saveMetricMapRepresentationToFile ( const std::string filNamePrefix) const
inlineoverridevirtualinherited

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)

Implements mrpt::maps::CMetricMap.

Definition at line 364 of file CPointsMap.h.

References mrpt::maps::CPointsMap::save3D_to_text_file().

Here is the call graph for this function:

◆ savePCDFile()

bool CColouredPointsMap::savePCDFile ( const std::string filename,
bool  save_as_binary 
) const
overridevirtual

Save the point cloud as a PCL PCD file, in either ASCII or binary format.

Returns
false on any error

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 722 of file CColouredPointsMap.cpp.

References m_color_B, m_color_G, m_color_R, MRPT_UNUSED_PARAM, mrpt::maps::CPointsMap::size(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ saveToPlyFile()

bool PLY_Exporter::saveToPlyFile ( const std::string filename,
bool  save_in_binary = false,
const CStringList file_comments = CStringList(),
const CStringList file_obj_info = CStringList() 
) const
inherited

Saves to a PLY file.

Parameters
[in]filenameThe filename to be saved.
[in]file_commentsIf provided (!=nullptr) the list of comment strings stored in the file will be returned.
[in]file_obj_infoIf provided (!=nullptr) the list of "object info" strings stored in the file will be returned.
Returns
false on any error writing the file. To obtain more details on the error you can call getSavePLYErrorString()

Definition at line 1958 of file PLY_import_export.cpp.

References mrpt::utils::TColorf::B, face_props, mrpt::utils::TColorf::G, TVertex::intensity, PLY_ASCII, PLY_BINARY_BE, PLY_BINARY_LE, ply_close(), ply_describe_property(), ply_element_count(), ply_header_complete(), ply_open_for_writing(), ply_put_comment(), ply_put_element(), ply_put_element_setup(), ply_put_obj_info(), mrpt::utils::TColorf::R, mrpt::utils::CStringList::size(), vert_props, mrpt::math::TPoint3Df::x, TVertex::x, mrpt::math::TPoint3Df::y, TVertex::y, mrpt::math::TPoint3Df::z, and TVertex::z.

Here is the call graph for this function:

◆ setAllPoints() [1/2]

void mrpt::maps::CPointsMap::setAllPoints ( const std::vector< float > &  X,
const std::vector< float > &  Y,
const std::vector< float > &  Z 
)
inlineinherited

Set all the points at once from vectors with X,Y and Z coordinates.

See also
getAllPoints

Definition at line 630 of file CPointsMap.h.

References mrpt::maps::CPointsMap::setAllPointsTemplate().

Referenced by mrpt::detectors::CFaceDetection::experimental_viewFacePointsAndEigenVects(), mrpt::detectors::CFaceDetection::experimental_viewFacePointsScanned(), and mrpt::detectors::CFaceDetection::experimental_viewRegions().

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

◆ setAllPoints() [2/2]

void mrpt::maps::CPointsMap::setAllPoints ( const std::vector< float > &  X,
const std::vector< float > &  Y 
)
inlineinherited

Set all the points at once from vectors with X and Y coordinates (Z=0).

See also
getAllPoints

Definition at line 639 of file CPointsMap.h.

References mrpt::maps::CPointsMap::setAllPointsTemplate().

Here is the call graph for this function:

◆ setAllPointsTemplate()

template<typename VECTOR >
void mrpt::maps::CPointsMap::setAllPointsTemplate ( const VECTOR &  X,
const VECTOR &  Y,
const VECTOR &  Z = VECTOR() 
)
inlineinherited

Set all the points at once from vectors with X,Y and Z coordinates (if Z is not provided, it will be set to all zeros).

Template Parameters
VECTORcan be mrpt::math::CVectorFloat or std::vector<float> or any other column or row Eigen::Matrix.

Definition at line 607 of file CPointsMap.h.

References ASSERT_, ASSERT_EQUAL_, mrpt::maps::CPointsMap::mark_as_modified(), mrpt::maps::CPointsMap::setPointFast(), and mrpt::maps::CPointsMap::setSize().

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

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

◆ setFromPCLPointCloud()

template<class POINTCLOUD >
void mrpt::maps::CPointsMap::setFromPCLPointCloud ( const POINTCLOUD &  cloud)
inlineinherited

Loads a PCL point cloud into this MRPT class (note: this method ignores potential RGB information, see CColouredPointsMap::setFromPCLPointCloudRGB() ).

Usage example:

pcl::PointCloud<pcl::PointXYZ> cloud;
mrpt::maps::CPointsCloud pc;
pc.setFromPCLPointCloud(cloud);
See also
getPCLPointCloud, CColouredPointsMap::setFromPCLPointCloudRGB()

Definition at line 992 of file CPointsMap.h.

References mrpt::maps::CMetricMap::clear(), mrpt::maps::CPointsMap::insertPointFast(), and mrpt::maps::CPointsMap::reserve().

Here is the call graph for this function:

◆ setFromPCLPointCloudRGB()

template<class POINTCLOUD >
void mrpt::maps::CColouredPointsMap::setFromPCLPointCloudRGB ( const POINTCLOUD &  cloud)
inline

Loads a PCL point cloud (WITH RGB information) into this MRPT class (for clouds without RGB data, see CPointsMap::setFromPCLPointCloud() ).

Usage example:

pcl::PointCloud<pcl::PointXYZRGB> cloud;
See also
CPointsMap::setFromPCLPointCloud()

Definition at line 300 of file CColouredPointsMap.h.

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

Here is the call graph for this function:

◆ setHeightFilterLevels()

void mrpt::maps::CPointsMap::setHeightFilterLevels ( const double  _z_min,
const double  _z_max 
)
inlineinherited

Set the min/max Z levels for points to be actually inserted in the map (only if enableFilterByHeight() was called before).

Definition at line 923 of file CPointsMap.h.

References mrpt::maps::CPointsMap::m_heightfilter_z_max, and mrpt::maps::CPointsMap::m_heightfilter_z_min.

◆ setPoint() [1/6]

void CColouredPointsMap::setPoint ( size_t  index,
float  x,
float  y,
float  z,
float  R,
float  G,
float  B 
)
overridevirtual

Changes a given point from map.

First index is 0.

Exceptions
Throwsstd::exception on index out of bound.

Reimplemented from mrpt::maps::CPointsMap.

Definition at line 360 of file CColouredPointsMap.cpp.

References R, and THROW_EXCEPTION.

Referenced by mrpt::mrpt::utils::min3(), PLY_import_set_vertex(), setPoint(), and mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::setPointXYZ_RGBu8().

Here is the caller graph for this function:

◆ setPoint() [2/6]

void mrpt::maps::CColouredPointsMap::setPoint ( size_t  index,
float  x,
float  y,
float  z 
)
inline

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 144 of file CColouredPointsMap.h.

References ASSERT_BELOW_, and mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ setPoint() [3/6]

void mrpt::maps::CColouredPointsMap::setPoint ( size_t  index,
mrpt::math::TPoint3Df p 
)
inline

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 151 of file CColouredPointsMap.h.

References setPoint().

Here is the call graph for this function:

◆ setPoint() [4/6]

void mrpt::maps::CColouredPointsMap::setPoint ( size_t  index,
float  x,
float  y 
)
inline

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 156 of file CColouredPointsMap.h.

◆ setPoint() [5/6]

void mrpt::maps::CPointsMap::setPoint ( size_t  index,
const mrpt::math::TPoint2D p 
)
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 446 of file CPointsMap.h.

References mrpt::maps::CPointsMap::setPoint().

Here is the call graph for this function:

◆ setPoint() [6/6]

void mrpt::maps::CPointsMap::setPoint ( size_t  index,
const mrpt::math::TPoint3D p 
)
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 451 of file CPointsMap.h.

References mrpt::maps::CPointsMap::setPoint().

Here is the call graph for this function:

◆ setPointAllFields()

void mrpt::maps::CPointsMap::setPointAllFields ( const size_t  index,
const std::vector< float > &  point_data 
)
inlineinherited

Set all the data fields for one point as a vector: depending on the implementation class this can be [X Y Z] or [X Y Z R G B], etc...

Unlike setPointAllFields(), this method does not check for index out of bounds

See also
setPointAllFields, getPointAllFields, getPointAllFieldsFast

Definition at line 662 of file CPointsMap.h.

References ASSERT_BELOW_, mrpt::maps::CPointsMap::setPointAllFieldsFast(), and mrpt::maps::CPointsMap::size().

Here is the call graph for this function:

◆ setPointAllFieldsFast()

virtual void mrpt::maps::CColouredPointsMap::setPointAllFieldsFast ( const size_t  index,
const std::vector< float > &  point_data 
)
inlineoverridevirtual

Set all the data fields for one point as a vector: [X Y Z R G B] Unlike setPointAllFields(), this method does not check for index out of bounds.

See also
setPointAllFields, getPointAllFields, getPointAllFieldsFast

Implements mrpt::maps::CPointsMap.

Definition at line 91 of file CColouredPointsMap.h.

◆ setPointColor()

void CColouredPointsMap::setPointColor ( size_t  index,
float  R,
float  G,
float  B 
)

Changes just the color of a given point from the map.

First index is 0.

Exceptions
Throwsstd::exception on index out of bound.

Definition at line 376 of file CColouredPointsMap.cpp.

References R, and THROW_EXCEPTION.

Referenced by mrpt::detectors::CFaceDetection::experimental_viewRegions().

Here is the caller graph for this function:

◆ setPointColor_fast()

void mrpt::maps::CColouredPointsMap::setPointColor_fast ( size_t  index,
float  R,
float  G,
float  B 
)
inline

Like setPointColor but without checking for out-of-index erors.

Definition at line 195 of file CColouredPointsMap.h.

References m_color_B, m_color_G, m_color_R, and R.

Referenced by mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::setPointRGBu8().

Here is the caller graph for this function:

◆ setPointFast()

virtual void mrpt::maps::CColouredPointsMap::setPointFast ( size_t  index,
float  x,
float  y,
float  z 
)
inlineoverridevirtual

Changes the coordinates of the given point (0-based index), without checking for out-of-bounds and without calling mark_as_modified()

See also
setPoint

Implements mrpt::maps::CPointsMap.

Definition at line 55 of file CColouredPointsMap.h.

Referenced by mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::setPointXYZ().

Here is the caller graph for this function:

◆ setPointWeight()

virtual void mrpt::maps::CPointsMap::setPointWeight ( size_t  index,
unsigned long  w 
)
inlinevirtualinherited

Sets the point weight, which is ignored in all classes but those which actually store that field (Note: No checks are done for out-of-bounds index).

See also
getPointWeight

Reimplemented in mrpt::maps::CWeightedPointsMap.

Definition at line 473 of file CPointsMap.h.

References MRPT_UNUSED_PARAM.

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

Here is the caller graph for this function:

◆ setSize()

void CColouredPointsMap::setSize ( size_t  newLength)
overridevirtual

Resizes all point buffers so they can hold the given number of points, erasing all previous contents and leaving all points to default values.

See also
reserve, setPoint, setPointFast, setSize

Implements mrpt::maps::CPointsMap.

Definition at line 119 of file CColouredPointsMap.cpp.

Referenced by PLY_import_set_vertex_count().

Here is the caller graph for this function:

◆ size()

size_t mrpt::maps::CPointsMap::size ( ) const
inlineinherited

Returns the number of stored points in the map.

Definition at line 385 of file CPointsMap.h.

Referenced by mrpt::maps::CPointsMap::addFrom(), mrpt::maps::CWeightedPointsMap::addFrom_classSpecific(), addFrom_classSpecific(), mrpt::maps::CPointsMap::applyDeletionMask(), mrpt::maps::CPointsMap::clipOutOfRange(), mrpt::maps::CPointsMap::clipOutOfRangeInZ(), mrpt::maps::CPointsMap::compute3DDistanceToMesh(), mrpt::maps::COccupancyGridMap2D::computeLikelihoodField_II(), mrpt::maps::COccupancyGridMap2D::computeLikelihoodField_Thrun(), mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_Consensus(), mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_ConsensusOWA(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::decimatePointsMap(), mrpt::maps::CHeightGridMap2D_Base::dem_internal_insertObservation(), mrpt::maps::CPointsMap::determineMatching2D(), mrpt::maps::CPointsMap::determineMatching3D(), mrpt::maps::CPointCloudFilterByDistance::filter(), mrpt::maps::CPointsMap::fuseWith(), mrpt::maps::CPointsMap::getPCLPointCloud(), mrpt::maps::CPointsMap::getPointAllFields(), mrpt::maps::CPointsMap::getPointsBuffer(), mrpt::maps::CPointsMap::insertAnotherMap(), mrpt::maps::COctoMapBase< octomap::OcTree, octomap::OcTreeNode >::internal_build_PointCloud_for_observation(), mrpt::maps::CPointsMap::internal_computeObservationLikelihood(), mrpt::maps::CColouredOctoMap::internal_insertObservation(), mrpt::maps::CPointsMap::internal_insertObservation(), mrpt::maps::CPointsMap::kdtree_get_point_count(), mrpt::maps::CPointsMap::loadFromVelodyneScan(), mrpt::maps::CPointsMap::PLY_export_get_vertex_count(), ransac_data_assoc_run(), run_pc_filter_test(), savePCDFile(), setPoint(), mrpt::maps::CPointsMap::setPoint(), mrpt::maps::CPointsMap::setPointAllFields(), mrpt::utils::PointCloudAdapter< mrpt::maps::CSimplePointsMap >::size(), mrpt::utils::PointCloudAdapter< mrpt::maps::CWeightedPointsMap >::size(), mrpt::utils::PointCloudAdapter< mrpt::maps::CColouredPointsMap >::size(), and mrpt::utils::PointCloudAdapter< mrpt::maps::CPointsMap >::size().

Here is the caller graph for this function:

◆ squareDistanceToClosestCorrespondence()

float CPointsMap::squareDistanceToClosestCorrespondence ( float  x0,
float  y0 
) const
overridevirtualinherited

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

Reimplemented from mrpt::maps::CMetricMap.

Definition at line 896 of file CPointsMap.cpp.

References ASSERT_, mrpt::math::closestFromPointToLine(), mrpt::math::KDTreeCapable< CPointsMap >::kdTreeClosestPoint2DsqrError(), mrpt::math::KDTreeCapable< CPointsMap >::kdTreeTwoClosestPoint2D(), and mrpt::math::square().

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

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

◆ squareDistanceToClosestCorrespondenceT()

float mrpt::maps::CPointsMap::squareDistanceToClosestCorrespondenceT ( const mrpt::math::TPoint2D p0) const
inlineinherited

Definition at line 193 of file CPointsMap.h.

References mrpt::maps::CPointsMap::squareDistanceToClosestCorrespondence(), mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

Here is the call graph for this function:

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

Implements mrpt::utils::CSerializable.

Definition at line 156 of file CColouredPointsMap.cpp.

References mrpt::utils::CStream::WriteBufferFixEndianness().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ detail::loadFromRangeImpl

template<class Derived >
friend struct detail::loadFromRangeImpl
friend

Definition at line 120 of file CColouredPointsMap.h.

◆ detail::pointmap_traits

template<class Derived >
friend struct detail::pointmap_traits
friend

Definition at line 122 of file CColouredPointsMap.h.

Member Data Documentation

◆ _init_CColouredPointsMap

mrpt::utils::CLASSINIT mrpt::maps::CColouredPointsMap::_init_CColouredPointsMap
staticprotected

Definition at line 32 of file CColouredPointsMap.h.

◆ className

constexpr const char* mrpt::maps::CColouredPointsMap::className = "CColouredPointsMap"
static

Definition at line 32 of file CColouredPointsMap.h.

◆ colorScheme

TColourOptions mrpt::maps::CColouredPointsMap::colorScheme

◆ genericMapParams

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

◆ insertionOptions

TInsertionOptions mrpt::maps::CPointsMap::insertionOptions
inherited

◆ kdtree_search_params

TKDTreeSearchParams mrpt::math::KDTreeCapable< CPointsMap , float , nanoflann::L2_Simple_Adaptor<float , CPointsMap > >::kdtree_search_params
inherited

Parameters to tune the ANN searches.

Definition at line 105 of file KDTreeCapable.h.

◆ likelihoodOptions

TLikelihoodOptions mrpt::maps::CPointsMap::likelihoodOptions
inherited

◆ m_bb_max_x

float mrpt::maps::CPointsMap::m_bb_max_x
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_bb_max_y

float mrpt::maps::CPointsMap::m_bb_max_y
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_bb_max_z

float mrpt::maps::CPointsMap::m_bb_max_z
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_bb_min_x

float mrpt::maps::CPointsMap::m_bb_min_x
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_bb_min_y

float mrpt::maps::CPointsMap::m_bb_min_y
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_bb_min_z

float mrpt::maps::CPointsMap::m_bb_min_z
mutableprotectedinherited

Definition at line 1092 of file CPointsMap.h.

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

◆ m_boundingBoxIsUpdated

bool mrpt::maps::CPointsMap::m_boundingBoxIsUpdated
mutableprotectedinherited

◆ m_color_B

std::vector<float> mrpt::maps::CColouredPointsMap::m_color_B
protected

◆ m_color_G

std::vector<float> mrpt::maps::CColouredPointsMap::m_color_G
protected

◆ m_color_R

std::vector<float> mrpt::maps::CColouredPointsMap::m_color_R
protected

◆ m_heightfilter_enabled

bool mrpt::maps::CPointsMap::m_heightfilter_enabled
protectedinherited

Whether or not (default=not) filter the input points by height.

See also
m_heightfilter_z_min, m_heightfilter_z_max

Definition at line 1143 of file CPointsMap.h.

Referenced by mrpt::maps::CPointsMap::enableFilterByHeight(), and mrpt::maps::CPointsMap::isFilterByHeightEnabled().

◆ m_heightfilter_z_max

double mrpt::maps::CPointsMap::m_heightfilter_z_max
protectedinherited

◆ m_heightfilter_z_min

double mrpt::maps::CPointsMap::m_heightfilter_z_min
protectedinherited

The minimum and maximum height for a certain laser scan to be inserted into this map.

See also
m_heightfilter_enabled

Definition at line 1139 of file CPointsMap.h.

Referenced by mrpt::maps::CPointsMap::getHeightFilterLevels(), and mrpt::maps::CPointsMap::setHeightFilterLevels().

◆ m_largestDistanceFromOrigin

float mrpt::maps::CPointsMap::m_largestDistanceFromOrigin
mutableprotectedinherited

◆ m_largestDistanceFromOriginIsUpdated

bool mrpt::maps::CPointsMap::m_largestDistanceFromOriginIsUpdated
mutableprotectedinherited

◆ m_private_map_register_id

const size_t mrpt::maps::CColouredPointsMap::m_private_map_register_id = mrpt::maps::internal::TMetricMapTypesRegistry::Instance().doRegister( "CColouredPointsMap,colourPointsMap" , & mrpt::maps::CColouredPointsMap ::MapDefinition, & mrpt::maps::CColouredPointsMap ::internal_CreateFromMapDefinition)
static

ID used to initialize class registration (just ignore it)

Definition at line 368 of file CColouredPointsMap.h.

◆ m_scans_sincos_cache

mrpt::obs::CSinCosLookUpTableFor2DScans mrpt::maps::CPointsMap::m_scans_sincos_cache
protectedinherited

Cache of sin/cos values for the latest 2D scan geometries.

Definition at line 1079 of file CPointsMap.h.

◆ runtimeClassId

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

Definition at line 32 of file CColouredPointsMap.h.

◆ x

std::vector<float> mrpt::maps::CPointsMap::x
protectedinherited

◆ y

std::vector<float> mrpt::maps::CPointsMap::y
protectedinherited

◆ z

std::vector<float> mrpt::maps::CPointsMap::z
protectedinherited



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