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

Detailed Description

A "CObservation"-derived class that represents a 2D range scan measurement (typically from a laser scanner).

The data structures are generic enough to hold a wide variety of 2D scanners and "3D" planar rotating 2D lasers.

These are the most important data fields:

See also
CObservation, CPointsMap, T2DScanProperties

Definition at line 55 of file CObservation2DRangeScan.h.

#include <mrpt/obs/CObservation2DRangeScan.h>

Inheritance diagram for mrpt::obs::CObservation2DRangeScan:
Inheritance graph

Public Types

typedef std::vector< mrpt::math::CPolygonTListExclusionAreas
 Used in filterByExclusionAreas. More...
 
typedef std::vector< std::pair< mrpt::math::CPolygon, std::pair< double, double > > > TListExclusionAreasWithRanges
 Used in filterByExclusionAreas. More...
 

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
 
 CObservation2DRangeScan ()
 Default constructor. More...
 
 CObservation2DRangeScan (const CObservation2DRangeScan &o)
 copy ctor More...
 
virtual ~CObservation2DRangeScan ()
 Destructor. More...
 
void loadFromVectors (size_t nRays, const float *scanRanges, const char *scanValidity)
 
bool isPlanarScan (const double tolerance=0) const
 Return true if the laser scanner is "horizontal", so it has an absolute value of "pitch" and "roll" less or equal to the given tolerance (in rads, default=0) (with the normal vector either upwards or downwards). More...
 
bool hasIntensity () const
 Return true if scan has intensity. More...
 
void setScanHasIntensity (bool setHasIntensityFlag)
 Marks this scan as having or not intensity data. More...
 
void getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const override
 A general method to retrieve the sensor pose on the robot. More...
 
void setSensorPose (const mrpt::poses::CPose3D &newSensorPose) override
 A general method to change the sensor pose on the robot. More...
 
void getDescriptionAsText (std::ostream &o) const override
 Build a detailed, multi-line textual description of the observation contents and dump it to the output stream. More...
 
void truncateByDistanceAndAngle (float min_distance, float max_angle, float min_height=0, float max_height=0, float h=0)
 A general method to truncate the scan by defining a minimum valid distance and a maximum valid angle as well as minimun and maximum heights (NOTE: the laser z-coordinate must be provided). More...
 
void filterByExclusionAreas (const TListExclusionAreas &areas)
 Mark as invalid sensed points that fall within any of a set of "exclusion areas", given in coordinates relative to the vehicle (taking into account "sensorPose"). More...
 
void filterByExclusionAreas (const TListExclusionAreasWithRanges &areas)
 Mark as invalid sensed points that fall within any of a set of "exclusion areas", given in coordinates relative to the vehicle (taking into account "sensorPose"), AND such as the Z coordinate of the point falls in the range [min,max] associated to each exclusion polygon. More...
 
void filterByExclusionAngles (const std::vector< std::pair< double, double >> &angles)
 Mark as invalid the ranges in any of a given set of "forbiden angle ranges", given as pairs<min_angle,max_angle>. More...
 
template<class METRICMAP >
bool insertObservationInto (METRICMAP *theMap, const mrpt::poses::CPose3D *robotPose=nullptr) const
 This method is equivalent to: More...
 
void getSensorPose (mrpt::math::TPose3D &out_sensorPose) const
 A general method to retrieve the sensor pose on the robot. More...
 
void setSensorPose (const mrpt::math::TPose3D &newSensorPose)
 A general method to change the sensor pose on the robot. 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...
 
Delayed-load manual control methods.
virtual void load () const
 Makes sure all images and other fields which may be externally stored are loaded in memory. More...
 
virtual void unload ()
 Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect). More...
 
RTTI classes and functions
mrpt::utils::CObject::Ptr duplicateGetSmartPtr () const
 Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...
 

Static Public Member Functions

static voidoperator new (size_t size, void *ptr)
 

Protected Member Functions

void swap (CObservation &o)
 Swap with another observation, ONLY the data defined here in the base class CObservation. More...
 
CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
void readFromStream (mrpt::utils::CStream &in, int version) override
 Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...
 

Private Attributes

std::vector< float > m_scan
 The range values of the scan, in meters. More...
 
std::vector< int32_tm_intensity
 The intensity values of the scan. More...
 
std::vector< char > m_validRange
 It's false (=0) on no reflected rays, referenced to elements in scan. More...
 
bool m_has_intensity
 Whether the intensity values are present or not. More...
 

Data common to any observation

mrpt::system::TTimeStamp timestamp
 The associated UTC time-stamp. More...
 
std::string sensorLabel
 An arbitrary label that can be used to identify the sensor. More...
 
mrpt::system::TTimeStamp getTimeStamp () const
 Returns CObservation::timestamp for all kind of observations. More...
 
virtual mrpt::system::TTimeStamp getOriginalReceivedTimeStamp () const
 By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp. More...
 

RTTI stuff

using Ptr = std::shared_ptr< CObservation2DRangeScan >
 
using ConstPtr = std::shared_ptr< const CObservation2DRangeScan >
 
static mrpt::utils::CLASSINIT _init_CObservation2DRangeScan
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CObservation2DRangeScan"
 
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...
 

Scan data

mrpt::utils::ContainerReadOnlyProxyAccessor< std::vector< float > > scan
 The range values of the scan, in meters. More...
 
mrpt::utils::ContainerReadOnlyProxyAccessor< std::vector< int32_t > > intensity
 The intensity values of the scan. More...
 
mrpt::utils::ContainerReadOnlyProxyAccessor< std::vector< char > > validRange
 It's false (=0) on no reflected rays, referenced to elements in scan. More...
 
float aperture
 The "aperture" or field-of-view of the range finder, in radians (typically M_PI = 180 degrees). More...
 
bool rightToLeft
 The scanning direction: true=counterclockwise; false=clockwise. More...
 
float maxRange
 The maximum range allowed by the device, in meters (e.g. More...
 
mrpt::poses::CPose3D sensorPose
 The 6D pose of the sensor on the robot at the moment of starting the scan. More...
 
float stdError
 The "sigma" error of the device in meters, used while inserting the scan in an occupancy grid. More...
 
float beamAperture
 The aperture of each beam, in radians, used to insert "thick" rays in the occupancy grid. More...
 
double deltaPitch
 If the laser gathers data by sweeping in the pitch/elevation angle, this holds the increment in "pitch" (=-"elevation") between the beginning and the end of the scan (the sensorPose member stands for the pose at the beginning of the scan). More...
 
void resizeScan (const size_t len)
 Resizes all data vectors to allocate a given number of scan rays. More...
 
void resizeScanAndAssign (const size_t len, const float rangeVal, const bool rangeValidity, const int32_t rangeIntensity=0)
 Resizes all data vectors to allocate a given number of scan rays and assign default values. More...
 
size_t getScanSize () const
 Get number of scan rays. More...
 
float getScanRange (const size_t i) const
 
void setScanRange (const size_t i, const float val)
 
int32_t getScanIntensity (const size_t i) const
 
void setScanIntensity (const size_t i, const int val)
 
bool getScanRangeValidity (const size_t i) const
 
void setScanRangeValidity (const size_t i, const bool val)
 
void getScanProperties (T2DScanProperties &p) const
 Fill out a T2DScanProperties structure with the parameters of this scan. More...
 

Cached points map

mrpt::maps::CMetricMap::Ptr m_cachedMap
 A points map, build only under demand by the methods getAuxPointsMap() and buildAuxPointsMap(). More...
 
template<class POINTSMAP >
const POINTSMAP * getAuxPointsMap () const
 Returns the cached points map representation of the scan, if already build with buildAuxPointsMap(), or nullptr otherwise. More...
 
template<class POINTSMAP >
const POINTSMAP * buildAuxPointsMap (const void *options=nullptr) const
 Returns a cached points map representing this laser scan, building it upon the first call. More...
 
void internal_buildAuxPointsMap (const void *options=nullptr) const
 Internal method, used from buildAuxPointsMap() More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 57 of file CObservation2DRangeScan.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 57 of file CObservation2DRangeScan.h.

◆ TListExclusionAreas

Used in filterByExclusionAreas.

Definition at line 76 of file CObservation2DRangeScan.h.

◆ TListExclusionAreasWithRanges

typedef std::vector< std::pair<mrpt::math::CPolygon, std::pair<double, double> > > mrpt::obs::CObservation2DRangeScan::TListExclusionAreasWithRanges

Used in filterByExclusionAreas.

Definition at line 80 of file CObservation2DRangeScan.h.

Constructor & Destructor Documentation

◆ CObservation2DRangeScan() [1/2]

CObservation2DRangeScan::CObservation2DRangeScan ( )

Default constructor.

Definition at line 33 of file CObservation2DRangeScan.cpp.

◆ CObservation2DRangeScan() [2/2]

CObservation2DRangeScan::CObservation2DRangeScan ( const CObservation2DRangeScan o)

copy ctor

Definition at line 52 of file CObservation2DRangeScan.cpp.

◆ ~CObservation2DRangeScan()

CObservation2DRangeScan::~CObservation2DRangeScan ( )
virtual

Destructor.

Definition at line 65 of file CObservation2DRangeScan.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservation2DRangeScan::_GetBaseClass ( )
staticprotected

◆ buildAuxPointsMap()

template<class POINTSMAP >
const POINTSMAP* mrpt::obs::CObservation2DRangeScan::buildAuxPointsMap ( const void options = nullptr) const
inline

◆ clone()

virtual mrpt::utils::CObject* mrpt::obs::CObservation2DRangeScan::clone ( ) const
overridevirtual

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

Implements mrpt::utils::CObject.

◆ Create()

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

Definition at line 57 of file CObservation2DRangeScan.h.

◆ CreateObject()

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

◆ filterByExclusionAngles()

void CObservation2DRangeScan::filterByExclusionAngles ( const std::vector< std::pair< double, double >> &  angles)

Mark as invalid the ranges in any of a given set of "forbiden angle ranges", given as pairs<min_angle,max_angle>.

See also
C2DRangeFinderAbstract::loadExclusionAreas

Definition at line 390 of file CObservation2DRangeScan.cpp.

References aperture, ASSERT_, m_validRange, MRPT_END, MRPT_START, rightToLeft, scan, mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size(), validRange, and mrpt::math::wrapTo2Pi().

Referenced by mrpt::hwdrivers::C2DRangeFinderAbstract::filterByExclusionAngles().

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

◆ filterByExclusionAreas() [1/2]

void CObservation2DRangeScan::filterByExclusionAreas ( const TListExclusionAreas areas)

Mark as invalid sensed points that fall within any of a set of "exclusion areas", given in coordinates relative to the vehicle (taking into account "sensorPose").

See also
C2DRangeFinderAbstract::loadExclusionAreas

Definition at line 369 of file CObservation2DRangeScan.cpp.

Referenced by mrpt::hwdrivers::C2DRangeFinderAbstract::filterByExclusionAreas().

Here is the caller graph for this function:

◆ filterByExclusionAreas() [2/2]

void CObservation2DRangeScan::filterByExclusionAreas ( const TListExclusionAreasWithRanges areas)

Mark as invalid sensed points that fall within any of a set of "exclusion areas", given in coordinates relative to the vehicle (taking into account "sensorPose"), AND such as the Z coordinate of the point falls in the range [min,max] associated to each exclusion polygon.

See also
C2DRangeFinderAbstract::loadExclusionAreas

Definition at line 304 of file CObservation2DRangeScan.cpp.

References aperture, ASSERT_, mrpt::poses::CPose3D::composePoint(), m_scan, m_validRange, MRPT_END, MRPT_START, rightToLeft, scan, sensorPose, mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size(), and validRange.

Here is the call graph for this function:

◆ getAuxPointsMap()

template<class POINTSMAP >
const POINTSMAP* mrpt::obs::CObservation2DRangeScan::getAuxPointsMap ( ) const
inline

Returns the cached points map representation of the scan, if already build with buildAuxPointsMap(), or nullptr otherwise.

Usage:

obs->getAuxPointsMap<mrpt::maps::CPointsMap>();
See also
buildAuxPointsMap

Definition at line 173 of file CObservation2DRangeScan.h.

References m_cachedMap.

◆ getDescriptionAsText()

void CObservation2DRangeScan::getDescriptionAsText ( std::ostream &  o) const
overridevirtual

Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.

Note
If overried by derived classes, call base CObservation::getDescriptionAsText() first to show common information.
This is the text that appears in RawLogViewer when selecting an object in the dataset

Reimplemented from mrpt::obs::CObservation.

Definition at line 499 of file CObservation2DRangeScan.cpp.

References aperture, deltaPitch, mrpt::format(), mrpt::obs::CObservation::getDescriptionAsText(), mrpt::poses::CPose3D::getHomogeneousMatrixVal(), hasIntensity(), m_intensity, maxRange, RAD2DEG, rightToLeft, scan, sensorPose, mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size(), stdError, and validRange.

Here is the call graph for this function:

◆ getOriginalReceivedTimeStamp()

virtual mrpt::system::TTimeStamp mrpt::obs::CObservation::getOriginalReceivedTimeStamp ( ) const
inlinevirtualinherited

By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp.

See also
getTimeStamp()

Reimplemented in mrpt::obs::CObservationGPS, and mrpt::obs::CObservationVelodyneScan.

Definition at line 69 of file CObservation.h.

References mrpt::obs::CObservation::timestamp.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservation2DRangeScan::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::obs::CObservation.

◆ GetRuntimeClassIdStatic()

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

◆ getScanIntensity()

int CObservation2DRangeScan::getScanIntensity ( const size_t  i) const

Definition at line 553 of file CObservation2DRangeScan.cpp.

References ASSERT_BELOW_, and m_intensity.

◆ getScanProperties()

void CObservation2DRangeScan::getScanProperties ( T2DScanProperties p) const

Fill out a T2DScanProperties structure with the parameters of this scan.

Definition at line 483 of file CObservation2DRangeScan.cpp.

References mrpt::obs::T2DScanProperties::aperture, aperture, mrpt::obs::T2DScanProperties::rightToLeft, rightToLeft, scan, and mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size().

Referenced by mrpt::obs::CSinCosLookUpTableFor2DScans::getSinCosForScan().

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

◆ getScanRange()

float CObservation2DRangeScan::getScanRange ( const size_t  i) const

Definition at line 541 of file CObservation2DRangeScan.cpp.

References ASSERT_BELOW_, and m_scan.

Referenced by mrpt::hwdrivers::CLMS100Eth::decodeScan().

Here is the caller graph for this function:

◆ getScanRangeValidity()

bool CObservation2DRangeScan::getScanRangeValidity ( const size_t  i) const

Definition at line 564 of file CObservation2DRangeScan.cpp.

References ASSERT_BELOW_, and m_validRange.

◆ getScanSize()

size_t CObservation2DRangeScan::getScanSize ( ) const

Get number of scan rays.

Definition at line 602 of file CObservation2DRangeScan.cpp.

References m_scan.

◆ getSensorPose() [1/2]

void CObservation::getSensorPose ( mrpt::math::TPose3D out_sensorPose) const
inherited

A general method to retrieve the sensor pose on the robot.

Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.

See also
setSensorPose

Definition at line 31 of file CObservation.cpp.

◆ getSensorPose() [2/2]

void mrpt::obs::CObservation2DRangeScan::getSensorPose ( mrpt::poses::CPose3D out_sensorPose) const
inlineoverridevirtual

A general method to retrieve the sensor pose on the robot.

Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.

See also
setSensorPose

Implements mrpt::obs::CObservation.

Definition at line 212 of file CObservation2DRangeScan.h.

References sensorPose.

◆ getTimeStamp()

mrpt::system::TTimeStamp mrpt::obs::CObservation::getTimeStamp ( ) const
inlineinherited

Returns CObservation::timestamp for all kind of observations.

See also
getOriginalReceivedTimeStamp()

Definition at line 64 of file CObservation.h.

References mrpt::obs::CObservation::timestamp.

◆ hasIntensity()

bool CObservation2DRangeScan::hasIntensity ( ) const

Return true if scan has intensity.

Definition at line 295 of file CObservation2DRangeScan.cpp.

References m_has_intensity.

Referenced by getDescriptionAsText(), readFromStream(), and writeToStream().

Here is the caller graph for this function:

◆ insertObservationInto()

template<class METRICMAP >
bool mrpt::obs::CObservation::insertObservationInto ( METRICMAP *  theMap,
const mrpt::poses::CPose3D robotPose = nullptr 
) const
inlineinherited

This method is equivalent to:

map->insertObservation(this, robotPose)
Parameters
theMapThe map where this observation is to be inserted: the map will be updated.
robotPoseThe pose of the robot base for this observation, relative to the target metric map. Set to nullptr (default) to use (0,0,0deg)
Returns
Returns true if the map has been updated, or false if this observations has nothing to do with a metric map (for example, a sound observation).

See: Maps and observations compatibility matrix

See also
CMetricMap, CMetricMap::insertObservation

Definition at line 96 of file CObservation.h.

Referenced by mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_CellsDifference().

Here is the caller graph for this function:

◆ internal_buildAuxPointsMap()

void CObservation2DRangeScan::internal_buildAuxPointsMap ( const void options = nullptr) const
protected

Internal method, used from buildAuxPointsMap()

Definition at line 471 of file CObservation2DRangeScan.cpp.

References m_cachedMap, and mrpt::obs::ptr_internal_build_points_map_from_scan2D.

Referenced by buildAuxPointsMap().

Here is the caller graph for this function:

◆ isPlanarScan()

bool CObservation2DRangeScan::isPlanarScan ( const double  tolerance = 0) const

◆ load()

virtual void mrpt::obs::CObservation::load ( ) const
inlinevirtualinherited

Makes sure all images and other fields which may be externally stored are loaded in memory.

Note that for all CImages, calling load() is not required since the images will be automatically loaded upon first access, so load() shouldn't be needed to be called in normal cases by the user. If all the data were alredy loaded or this object has no externally stored data fields, calling this method has no effects.

See also
unload

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 151 of file CObservation.h.

◆ loadFromVectors()

void CObservation2DRangeScan::loadFromVectors ( size_t  nRays,
const float *  scanRanges,
const char *  scanValidity 
)

Definition at line 603 of file CObservation2DRangeScan.cpp.

References ASSERT_, m_scan, m_validRange, and resizeScan().

Referenced by ICPTests::align2scans(), mrpt::graphslam::CGraphSlamEngine< GRAPH_T >::decimateLaserScan(), and TEST().

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

◆ operator delete() [1/3]

void mrpt::obs::CObservation2DRangeScan::operator delete ( void ptr)
inlinenoexcept

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator delete() [2/3]

void mrpt::obs::CObservation2DRangeScan::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator delete() [3/3]

void mrpt::obs::CObservation2DRangeScan::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator delete[]()

void mrpt::obs::CObservation2DRangeScan::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator new() [1/3]

void* mrpt::obs::CObservation2DRangeScan::operator new ( size_t  size)
inline

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator new() [2/3]

static void* mrpt::obs::CObservation2DRangeScan::operator new ( size_t  size,
void ptr 
)
inlinestatic

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator new() [3/3]

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

Definition at line 57 of file CObservation2DRangeScan.h.

◆ operator new[]()

void* mrpt::obs::CObservation2DRangeScan::operator new[] ( size_t  size)
inline

Definition at line 57 of file CObservation2DRangeScan.h.

◆ readFromStream()

void CObservation2DRangeScan::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 135 of file CObservation2DRangeScan.cpp.

References aperture, beamAperture, DEG2RAD, deltaPitch, hasIntensity(), m_cachedMap, m_intensity, m_scan, m_validRange, maxRange, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, resizeScan(), rightToLeft, scan, mrpt::obs::CObservation::sensorLabel, sensorPose, setScanHasIntensity(), stdError, and mrpt::obs::CObservation::timestamp.

Here is the call graph for this function:

◆ resizeScan()

void CObservation2DRangeScan::resizeScan ( const size_t  len)

◆ resizeScanAndAssign()

void CObservation2DRangeScan::resizeScanAndAssign ( const size_t  len,
const float  rangeVal,
const bool  rangeValidity,
const int32_t  rangeIntensity = 0 
)

Resizes all data vectors to allocate a given number of scan rays and assign default values.

Definition at line 588 of file CObservation2DRangeScan.cpp.

References mrpt::mrpt::utils::length2length4N(), m_intensity, m_scan, and m_validRange.

Referenced by mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), and mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple().

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

◆ setScanHasIntensity()

void CObservation2DRangeScan::setScanHasIntensity ( bool  setHasIntensityFlag)

Marks this scan as having or not intensity data.

Definition at line 296 of file CObservation2DRangeScan.cpp.

References m_has_intensity.

Referenced by mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), and readFromStream().

Here is the caller graph for this function:

◆ setScanIntensity()

void CObservation2DRangeScan::setScanIntensity ( const size_t  i,
const int  val 
)

Definition at line 558 of file CObservation2DRangeScan.cpp.

References ASSERT_BELOW_, m_intensity, and val.

Referenced by mrpt::hwdrivers::CHokuyoURG::doProcessSimple().

Here is the caller graph for this function:

◆ setScanRange()

void CObservation2DRangeScan::setScanRange ( const size_t  i,
const float  val 
)

◆ setScanRangeValidity()

void CObservation2DRangeScan::setScanRangeValidity ( const size_t  i,
const bool  val 
)

◆ setSensorPose() [1/2]

void CObservation::setSensorPose ( const mrpt::math::TPose3D newSensorPose)
inherited

A general method to change the sensor pose on the robot.

Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.

See also
getSensorPose

Definition at line 38 of file CObservation.cpp.

◆ setSensorPose() [2/2]

void mrpt::obs::CObservation2DRangeScan::setSensorPose ( const mrpt::poses::CPose3D newSensorPose)
inlineoverridevirtual

A general method to change the sensor pose on the robot.

Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.

See also
getSensorPose

Implements mrpt::obs::CObservation.

Definition at line 216 of file CObservation2DRangeScan.h.

References sensorPose.

◆ swap()

void CObservation::swap ( CObservation o)
protectedinherited

Swap with another observation, ONLY the data defined here in the base class CObservation.

It's protected since it'll be only called from child classes that should know what else to swap appart from these common data.

Definition at line 43 of file CObservation.cpp.

References mrpt::obs::CObservation::sensorLabel, and mrpt::obs::CObservation::timestamp.

Referenced by mrpt::obs::CObservationStereoImages::swap(), and mrpt::obs::CObservation3DRangeScan::swap().

Here is the caller graph for this function:

◆ truncateByDistanceAndAngle()

void CObservation2DRangeScan::truncateByDistanceAndAngle ( float  min_distance,
float  max_angle,
float  min_height = 0,
float  max_height = 0,
float  h = 0 
)

A general method to truncate the scan by defining a minimum valid distance and a maximum valid angle as well as minimun and maximum heights (NOTE: the laser z-coordinate must be provided).

Definition at line 103 of file CObservation2DRangeScan.cpp.

References aperture, ASSERT_, m_scan, m_validRange, scan, and mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size().

Here is the call graph for this function:

◆ unload()

virtual void mrpt::obs::CObservation::unload ( )
inlinevirtualinherited

Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).

See also
load

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 156 of file CObservation.h.

◆ 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 CObservation2DRangeScan::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 69 of file CObservation2DRangeScan.cpp.

References aperture, ASSERT_, beamAperture, deltaPitch, hasIntensity(), m_intensity, m_scan, m_validRange, maxRange, rightToLeft, scan, mrpt::obs::CObservation::sensorLabel, sensorPose, mrpt::utils::ContainerReadOnlyProxyAccessor< STLCONTAINER >::size(), stdError, mrpt::obs::CObservation::timestamp, validRange, mrpt::utils::CStream::WriteBuffer(), and mrpt::utils::CStream::WriteBufferFixEndianness().

Here is the call graph for this function:

Member Data Documentation

◆ _init_CObservation2DRangeScan

mrpt::utils::CLASSINIT mrpt::obs::CObservation2DRangeScan::_init_CObservation2DRangeScan
staticprotected

Definition at line 57 of file CObservation2DRangeScan.h.

◆ aperture

float mrpt::obs::CObservation2DRangeScan::aperture

◆ beamAperture

float mrpt::obs::CObservation2DRangeScan::beamAperture

The aperture of each beam, in radians, used to insert "thick" rays in the occupancy grid.

Definition at line 135 of file CObservation2DRangeScan.h.

Referenced by mrpt::hwdrivers::CLMS100Eth::decodeScan(), readFromStream(), and writeToStream().

◆ className

constexpr const char* mrpt::obs::CObservation2DRangeScan::className = "CObservation2DRangeScan"
static

Definition at line 57 of file CObservation2DRangeScan.h.

◆ deltaPitch

double mrpt::obs::CObservation2DRangeScan::deltaPitch

If the laser gathers data by sweeping in the pitch/elevation angle, this holds the increment in "pitch" (=-"elevation") between the beginning and the end of the scan (the sensorPose member stands for the pose at the beginning of the scan).

Definition at line 140 of file CObservation2DRangeScan.h.

Referenced by getDescriptionAsText(), FAddUntracedLines::operator()(), mrpt::opengl::CAngularObservationMesh::FTrace2D< T >::operator()(), readFromStream(), mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays(), and writeToStream().

◆ intensity

mrpt::utils::ContainerReadOnlyProxyAccessor<std::vector<int32_t> > mrpt::obs::CObservation2DRangeScan::intensity

The intensity values of the scan.

If available, must have same length than validRange

Definition at line 109 of file CObservation2DRangeScan.h.

◆ m_cachedMap

mrpt::maps::CMetricMap::Ptr mrpt::obs::CObservation2DRangeScan::m_cachedMap
mutableprotected

A points map, build only under demand by the methods getAuxPointsMap() and buildAuxPointsMap().

It's a generic smart pointer to avoid depending here in the library mrpt-obs on classes on other libraries.

Definition at line 158 of file CObservation2DRangeScan.h.

Referenced by buildAuxPointsMap(), getAuxPointsMap(), internal_buildAuxPointsMap(), and readFromStream().

◆ m_has_intensity

bool mrpt::obs::CObservation2DRangeScan::m_has_intensity
private

Whether the intensity values are present or not.

If not, space is saved during serialization.

Definition at line 72 of file CObservation2DRangeScan.h.

Referenced by hasIntensity(), and setScanHasIntensity().

◆ m_intensity

std::vector<int32_t> mrpt::obs::CObservation2DRangeScan::m_intensity
private

The intensity values of the scan.

If available, must have same length than validRange

Definition at line 66 of file CObservation2DRangeScan.h.

Referenced by getDescriptionAsText(), getScanIntensity(), readFromStream(), resizeScan(), resizeScanAndAssign(), setScanIntensity(), and writeToStream().

◆ m_scan

std::vector<float> mrpt::obs::CObservation2DRangeScan::m_scan
private

The range values of the scan, in meters.

Must have same length than validRange

Definition at line 63 of file CObservation2DRangeScan.h.

Referenced by filterByExclusionAreas(), getScanRange(), getScanSize(), loadFromVectors(), readFromStream(), resizeScan(), resizeScanAndAssign(), setScanRange(), truncateByDistanceAndAngle(), and writeToStream().

◆ m_validRange

std::vector<char> mrpt::obs::CObservation2DRangeScan::m_validRange
private

◆ maxRange

float mrpt::obs::CObservation2DRangeScan::maxRange

◆ rightToLeft

bool mrpt::obs::CObservation2DRangeScan::rightToLeft

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::obs::CObservation2DRangeScan::runtimeClassId
staticprotected

Definition at line 57 of file CObservation2DRangeScan.h.

◆ scan

mrpt::utils::ContainerReadOnlyProxyAccessor<std::vector<float> > mrpt::obs::CObservation2DRangeScan::scan

◆ sensorLabel

std::string mrpt::obs::CObservation::sensorLabel
inherited

An arbitrary label that can be used to identify the sensor.

Definition at line 60 of file CObservation.h.

Referenced by mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::hwdrivers::CLMS100Eth::decodeScan(), mrpt::hwdrivers::CRaePID::doProcess(), mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CCANBusReader::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::hwdrivers::CRaePID::getFullInfo(), mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::hwdrivers::COpenNI2Sensor::getNextObservation(), mrpt::hwdrivers::CKinect::getNextObservation(), mrpt::hwdrivers::CBoardSonars::getObservation(), mrpt::hwdrivers::CWirelessPower::getObservation(), mrpt::hwdrivers::CImpinjRFID::getObservation(), mrpt::hwdrivers::CEnoseModular::getObservation(), mrpt::hwdrivers::CBoardENoses::getObservation(), mrpt::hwdrivers::CPhidgetInterfaceKitProximitySensors::getObservation(), mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), mrpt::maps::CGasConcentrationGridMap2D::internal_insertObservation(), mrpt::obs::CObservation6DFeatures::readFromStream(), mrpt::obs::CObservationStereoImagesFeatures::readFromStream(), mrpt::obs::CObservationStereoImages::readFromStream(), readFromStream(), mrpt::obs::CObservationVelodyneScan::readFromStream(), mrpt::obs::CObservation3DRangeScan::readFromStream(), mrpt::obs::CObservation::swap(), mrpt::obs::CObservationGPS::swap(), mrpt::obs::CObservation6DFeatures::writeToStream(), mrpt::obs::CObservationStereoImagesFeatures::writeToStream(), mrpt::obs::CObservationStereoImages::writeToStream(), writeToStream(), mrpt::obs::CObservationVelodyneScan::writeToStream(), and mrpt::obs::CObservation3DRangeScan::writeToStream().

◆ sensorPose

mrpt::poses::CPose3D mrpt::obs::CObservation2DRangeScan::sensorPose

The 6D pose of the sensor on the robot at the moment of starting the scan.

Definition at line 129 of file CObservation2DRangeScan.h.

Referenced by mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_rayTracing(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::hwdrivers::CLMS100Eth::decodeScan(), mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), filterByExclusionAreas(), getDescriptionAsText(), getSensorPose(), mrpt::maps::COctoMapBase< octomap::OcTree, octomap::OcTreeNode >::internal_build_PointCloud_for_observation(), mrpt::maps::COccupancyGridMap2D::internal_canComputeObservationLikelihood(), mrpt::maps::CLandmarksMap::internal_computeObservationLikelihood(), mrpt::maps::COccupancyGridMap2D::internal_computeObservationLikelihood(), mrpt::maps::CColouredOctoMap::internal_insertObservation(), mrpt::maps::COccupancyGridMap2D::internal_insertObservation(), isPlanarScan(), mrpt::maps::COccupancyGridMap2D::laserScanSimulator(), mrpt::maps::COccupancyGridMap2D::laserScanSimulatorWithUncertainty(), mrpt::maps::CLandmarksMap::loadOccupancyFeaturesFrom2DRangeScan(), FAddUntracedLines::operator()(), mrpt::opengl::CAngularObservationMesh::FTrace2D< T >::operator()(), readFromStream(), mrpt::opengl::CPlanarLaserScan::render_dl(), run_rnav_test(), setSensorPose(), mrpt::maps::detail::loadFromRangeImpl< Derived >::templ_loadFromRangeScan(), mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays(), and writeToStream().

◆ stdError

float mrpt::obs::CObservation2DRangeScan::stdError

◆ timestamp

mrpt::system::TTimeStamp mrpt::obs::CObservation::timestamp
inherited

The associated UTC time-stamp.

Where available, this should contain the accurate satellite-based timestamp of the sensor reading.

See also
getOriginalReceivedTimeStamp(), getTimeStamp()

Definition at line 58 of file CObservation.h.

Referenced by mrpt::obs::CObservationVelodyneScan::TPointCloud::clear_deep(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::hwdrivers::CLMS100Eth::decodeScan(), mrpt::detectors::CObjectDetection::detectObjects(), mrpt::hwdrivers::CRaePID::doProcess(), mrpt::hwdrivers::CGPSInterface::doProcess(), mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CCANBusReader::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), mrpt::obs::CRawlog::findObservationsByClassInRange(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::obs::CObservationGasSensors::CMOSmodel::get_GasDistribution_estimation(), mrpt::hwdrivers::CRaePID::getFullInfo(), mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::hwdrivers::COpenNI2_RGBD360::getNextObservation(), mrpt::hwdrivers::CKinect::getNextObservation(), mrpt::hwdrivers::CBoardSonars::getObservation(), mrpt::hwdrivers::CWirelessPower::getObservation(), mrpt::hwdrivers::CEnoseModular::getObservation(), mrpt::hwdrivers::CImageGrabber_OpenCV::getObservation(), mrpt::hwdrivers::CBoardENoses::getObservation(), mrpt::hwdrivers::CPhidgetInterfaceKitProximitySensors::getObservation(), mrpt::hwdrivers::CImageGrabber_dc1394::getObservation(), mrpt::hwdrivers::CImageGrabber_FlyCapture2::getObservation(), mrpt::hwdrivers::CDUO3DCamera::getObservations(), mrpt::obs::CObservation::getOriginalReceivedTimeStamp(), mrpt::obs::CObservation::getTimeStamp(), mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), mrpt::obs::CObservationGasSensors::CMOSmodel::inverse_MOSmodeling(), mrpt::maps::CLandmarksMap::loadOccupancyFeaturesFrom2DRangeScan(), mrpt::maps::CLandmarksMap::loadSiftFeaturesFromImageObservation(), mrpt::maps::CLandmarksMap::loadSiftFeaturesFromStereoImageObservation(), mrpt::obs::CObservationGasSensors::CMOSmodel::noise_filtering(), mrpt::hwdrivers::CGPSInterface::parse_NMEA(), mrpt::obs::CObservation6DFeatures::readFromStream(), mrpt::obs::CObservationStereoImagesFeatures::readFromStream(), mrpt::obs::CObservationStereoImages::readFromStream(), readFromStream(), mrpt::obs::CObservationVelodyneScan::readFromStream(), mrpt::obs::CObservation3DRangeScan::readFromStream(), mrpt::obs::CObservationGasSensors::CMOSmodel::save_log_map(), mrpt::maps::CLandmarksMap::simulateBeaconReadings(), mrpt::maps::CLandmarksMap::simulateRangeBearingReadings(), mrpt::obs::CObservation::swap(), mrpt::obs::CObservationGPS::swap(), velodyne_scan_to_pointcloud(), mrpt::obs::CObservation6DFeatures::writeToStream(), mrpt::obs::CObservationStereoImagesFeatures::writeToStream(), mrpt::obs::CObservationStereoImages::writeToStream(), writeToStream(), mrpt::obs::CObservationVelodyneScan::writeToStream(), and mrpt::obs::CObservation3DRangeScan::writeToStream().

◆ validRange

mrpt::utils::ContainerReadOnlyProxyAccessor<std::vector<char> > mrpt::obs::CObservation2DRangeScan::validRange



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