MRPT
1.9.9
|
Declares a class derived from "CObservation" that encapsules a single range measurement, and associated parameters.
This can be used for example to store measurements from infrared proximity sensors (IR) or ultrasonic sensors (sonars).
Definition at line 27 of file CObservationRange.h.
#include <mrpt/obs/CObservationRange.h>
Classes | |
struct | TMeasurement |
Public Types | |
using | TMeasurementList = std::deque< TMeasurement > |
using | const_iterator = std::deque< TMeasurement >::const_iterator |
using | iterator = std::deque< TMeasurement >::iterator |
Public Member Functions | |
CObservationRange ()=default | |
iterator | begin () |
iterator | end () |
const_iterator | begin () const |
const_iterator | end () const |
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... | |
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... | |
std::string | getDescriptionAsTextValue () const |
Return by value version of getDescriptionAsText(std::ostream&) More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
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 for polymorphic hierarchies | |
mrpt::rtti::CObject::Ptr | duplicateGetSmartPtr () const |
Makes a deep copy of the object and returns a smart pointer to it. More... | |
Public Attributes | |
float | minSensorDistance {0} |
The data members. More... | |
float | maxSensorDistance {5} |
float | sensorConeApperture = mrpt::d2f(20.0_deg) |
Cone aperture of each ultrasonic beam, in radians. More... | |
TMeasurementList | sensedData |
All the measurements. More... | |
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 | |
uint8_t | serializeGetVersion () const override |
Must return the current versioning number of the object. More... | |
void | serializeTo (mrpt::serialization::CArchive &out) const override |
Pure virtual method for writing (serializing) to an abstract archive. More... | |
void | serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override |
Pure virtual method for reading (deserializing) from an abstract archive. More... | |
CSerializable virtual methods | |
virtual void | serializeTo (CSchemeArchiveBase &out) const |
Virtual method for writing (serializing) to an abstract schema based archive. More... | |
virtual void | serializeFrom (CSchemeArchiveBase &in) |
Virtual method for reading (deserializing) from an abstract schema based archive. More... | |
Data common to any observation | |
mrpt::system::TTimeStamp | timestamp {mrpt::system::now()} |
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< mrpt::obs ::CObservationRange > |
using | ConstPtr = std::shared_ptr< const mrpt::obs ::CObservationRange > |
using | UniquePtr = std::unique_ptr< mrpt::obs ::CObservationRange > |
using | ConstUniquePtr = std::unique_ptr< const mrpt::obs ::CObservationRange > |
static const mrpt::rtti::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "mrpt::obs" "::" "CObservationRange" |
static const mrpt::rtti::TRuntimeClassId * | _GetBaseClass () |
static constexpr auto | getClassName () |
static const mrpt::rtti::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static std::shared_ptr< CObject > | CreateObject () |
template<typename... Args> | |
static Ptr | Create (Args &&... args) |
template<typename Alloc , typename... Args> | |
static Ptr | CreateAlloc (const Alloc &alloc, Args &&... args) |
template<typename... Args> | |
static UniquePtr | CreateUnique (Args &&... args) |
virtual const mrpt::rtti::TRuntimeClassId * | GetRuntimeClass () const override |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::rtti::CObject * | clone () const override |
Returns a deep copy (clone) of the object, indepently of its class. More... | |
using mrpt::obs::CObservationRange::const_iterator = std::deque<TMeasurement>::const_iterator |
Definition at line 61 of file CObservationRange.h.
using mrpt::obs::CObservationRange::ConstPtr = std::shared_ptr<const mrpt::obs :: CObservationRange > |
Definition at line 29 of file CObservationRange.h.
using mrpt::obs::CObservationRange::ConstUniquePtr = std::unique_ptr<const mrpt::obs :: CObservationRange > |
Definition at line 29 of file CObservationRange.h.
using mrpt::obs::CObservationRange::iterator = std::deque<TMeasurement>::iterator |
Definition at line 62 of file CObservationRange.h.
using mrpt::obs::CObservationRange::Ptr = std::shared_ptr< mrpt::obs :: CObservationRange > |
A type for the associated smart pointer
Definition at line 29 of file CObservationRange.h.
using mrpt::obs::CObservationRange::TMeasurementList = std::deque<TMeasurement> |
Definition at line 60 of file CObservationRange.h.
using mrpt::obs::CObservationRange::UniquePtr = std::unique_ptr< mrpt::obs :: CObservationRange > |
Definition at line 29 of file CObservationRange.h.
|
default |
|
staticprotected |
|
inline |
Definition at line 67 of file CObservationRange.h.
References sensedData.
Referenced by mrpt::maps::COccupancyGridMap2D::sonarSimulator().
|
inline |
Definition at line 69 of file CObservationRange.h.
References sensedData.
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::rtti::CObject.
|
inlinestatic |
Definition at line 29 of file CObservationRange.h.
Referenced by mrpt::hwdrivers::CBoardSonars::doProcess().
|
inlinestatic |
Definition at line 29 of file CObservationRange.h.
|
static |
|
inlinestatic |
Definition at line 29 of file CObservationRange.h.
|
inlineinherited |
Makes a deep copy of the object and returns a smart pointer to it.
Definition at line 204 of file CObject.h.
References mrpt::rtti::CObject::clone().
Referenced by mrpt::obs::CRawlog::insert().
|
inline |
Definition at line 68 of file CObservationRange.h.
References sensedData.
Referenced by mrpt::maps::COccupancyGridMap2D::sonarSimulator().
|
inline |
Definition at line 70 of file CObservationRange.h.
References sensedData.
|
inlinestatic |
Definition at line 29 of file CObservationRange.h.
|
overridevirtual |
Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.
Reimplemented from mrpt::obs::CObservation.
Definition at line 98 of file CObservationRange.cpp.
References mrpt::format(), mrpt::obs::CObservation::getDescriptionAsText(), and mrpt::RAD2DEG().
|
inherited |
Return by value version of getDescriptionAsText(std::ostream&)
Definition at line 59 of file CObservation.cpp.
|
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.
Reimplemented in mrpt::obs::CObservationVelodyneScan, mrpt::obs::CObservationGPS, and mrpt::obs::CObservationRotatingScan.
Definition at line 71 of file CObservation.h.
References mrpt::obs::CObservation::timestamp.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::obs::CObservation.
|
static |
|
overridevirtual |
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.
Implements mrpt::obs::CObservation.
Definition at line 82 of file CObservationRange.cpp.
|
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.
Definition at line 24 of file CObservation.cpp.
References mrpt::poses::CPose3D::asTPose().
|
inlineinherited |
Returns CObservation::timestamp for all kind of observations.
Definition at line 66 of file CObservation.h.
References mrpt::obs::CObservation::timestamp.
|
inlineinherited |
This method is equivalent to:
theMap | The map where this observation is to be inserted: the map will be updated. |
robotPose | The pose of the robot base for this observation, relative to the target metric map. Set to nullptr (default) to use (0,0,0deg) |
See: Maps and observations compatibility matrix
Definition at line 99 of file CObservation.h.
|
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.
Reimplemented in mrpt::obs::CObservation3DRangeScan, mrpt::obs::CObservationStereoImages, mrpt::obs::CObservationImage, and mrpt::obs::CObservationPointCloud.
Definition at line 157 of file CObservation.h.
Referenced by mrpt::maps::COctoMapBase< octomap::OcTree, octomap::OcTreeNode >::internal_build_PointCloud_for_observation().
|
overrideprotectedvirtual |
Pure virtual method for reading (deserializing) from an abstract archive.
Users don't call this method directly. Instead, use stream >> object;
.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 34 of file CObservationRange.cpp.
References mrpt::poses::CPose3D::asTPose(), INVALID_TIMESTAMP, and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
|
inlineprotectedvirtualinherited |
Virtual method for reading (deserializing) from an abstract schema based archive.
Definition at line 74 of file CSerializable.h.
References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.
|
overrideprotectedvirtual |
Must return the current versioning number of the object.
Start in zero for new classes, and increments each time there is a change in the stored format.
Implements mrpt::serialization::CSerializable.
Definition at line 21 of file CObservationRange.cpp.
|
overrideprotectedvirtual |
Pure virtual method for writing (serializing) to an abstract archive.
Users don't call this method directly. Instead, use stream << object;
.
std::exception | On any I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 22 of file CObservationRange.cpp.
References out.
|
inlineprotectedvirtualinherited |
Virtual method for writing (serializing) to an abstract schema based archive.
Definition at line 64 of file CSerializable.h.
References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.
|
overridevirtual |
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.
Implements mrpt::obs::CObservation.
Definition at line 93 of file CObservationRange.cpp.
References mrpt::poses::CPose3D::asTPose().
|
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.
Definition at line 31 of file CObservation.cpp.
|
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 36 of file CObservation.cpp.
References mrpt::obs::CObservation::sensorLabel, and mrpt::obs::CObservation::timestamp.
Referenced by mrpt::obs::CObservationStereoImages::swap().
|
inlinevirtualinherited |
Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).
Reimplemented in mrpt::obs::CObservation3DRangeScan, and mrpt::obs::CObservationPointCloud.
Definition at line 164 of file CObservation.h.
|
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.
mxArray
(caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB. Definition at line 90 of file CSerializable.h.
|
static |
Definition at line 29 of file CObservationRange.h.
float mrpt::obs::CObservationRange::maxSensorDistance {5} |
Definition at line 37 of file CObservationRange.h.
Referenced by mrpt::ros1bridge::fromROS(), mrpt::hwdrivers::CBoardSonars::getObservation(), mrpt::maps::COccupancyGridMap2D::sonarSimulator(), and mrpt::ros1bridge::toROS().
float mrpt::obs::CObservationRange::minSensorDistance {0} |
The data members.
Definition at line 36 of file CObservationRange.h.
Referenced by mrpt::ros1bridge::fromROS(), mrpt::hwdrivers::CBoardSonars::getObservation(), and mrpt::ros1bridge::toROS().
|
staticprotected |
Definition at line 29 of file CObservationRange.h.
TMeasurementList mrpt::obs::CObservationRange::sensedData |
All the measurements.
Definition at line 65 of file CObservationRange.h.
Referenced by begin(), end(), mrpt::ros1bridge::fromROS(), mrpt::hwdrivers::CBoardSonars::getObservation(), and mrpt::ros1bridge::toROS().
float mrpt::obs::CObservationRange::sensorConeApperture = mrpt::d2f(20.0_deg) |
Cone aperture of each ultrasonic beam, in radians.
Definition at line 40 of file CObservationRange.h.
Referenced by mrpt::ros1bridge::fromROS(), mrpt::hwdrivers::CBoardSonars::getObservation(), mrpt::maps::CPointsMap::internal_insertObservation(), mrpt::maps::COccupancyGridMap2D::sonarSimulator(), and mrpt::ros1bridge::toROS().
|
inherited |
An arbitrary label that can be used to identify the sensor.
Definition at line 62 of file CObservation.h.
Referenced by mrpt::ros1bridge::convert(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::hwdrivers::CSICKTim561Eth::decodeScan(), mrpt::hwdrivers::CLMS100Eth::decodeScan(), mrpt::hwdrivers::CRaePID::doProcess(), mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CCANBusReader::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::apps::RawlogGrabberApp::dump_GPS_mode_info(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::obs::CObservationRotatingScan::fromScan2D(), mrpt::obs::CObservationRotatingScan::fromVelodyne(), mrpt::hwdrivers::CRaePID::getFullInfo(), mrpt::hwdrivers::CSwissRanger3DCamera::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::CNationalInstrumentsDAQ::grabbing_thread(), mrpt::obs::CObservation6DFeatures::serializeFrom(), mrpt::obs::CObservationPointCloud::serializeFrom(), mrpt::obs::CObservation6DFeatures::serializeTo(), mrpt::obs::CObservationPointCloud::serializeTo(), mrpt::obs::CObservation::swap(), and mrpt::ros1bridge::toROS().
|
inherited |
The associated UTC time-stamp.
Where available, this should contain the accurate satellite-based timestamp of the sensor reading.
Definition at line 60 of file CObservation.h.
Referenced by mrpt::ros1bridge::convert(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::hwdrivers::CSICKTim561Eth::decodeScan(), 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::CSickLaserSerial::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::ros1bridge::fromROS(), mrpt::obs::CObservationRotatingScan::fromScan2D(), mrpt::obs::CObservationRotatingScan::fromVelodyne(), 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::CImageGrabber_OpenCV::getObservation(), mrpt::hwdrivers::CEnoseModular::getObservation(), mrpt::hwdrivers::CBoardENoses::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::maps::CLandmarksMap::loadOccupancyFeaturesFrom2DRangeScan(), mrpt::maps::CLandmarksMap::loadSiftFeaturesFromImageObservation(), mrpt::maps::CLandmarksMap::loadSiftFeaturesFromStereoImageObservation(), mrpt::hwdrivers::CGPSInterface::parse_NMEA(), mrpt::apps::KFSLAMApp::Run_KF_SLAM(), mrpt::obs::CObservation6DFeatures::serializeFrom(), mrpt::obs::CObservationPointCloud::serializeFrom(), mrpt::obs::CObservation6DFeatures::serializeTo(), mrpt::obs::CObservationPointCloud::serializeTo(), mrpt::maps::CLandmarksMap::simulateBeaconReadings(), mrpt::maps::CLandmarksMap::simulateRangeBearingReadings(), mrpt::obs::CObservation::swap(), mrpt::ros1bridge::toROS(), and velodyne_scan_to_pointcloud().
Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: c7a3bec24 Sun Mar 29 18:33:13 2020 +0200 at dom mar 29 18:50:38 CEST 2020 |