class mrpt::obs::CObservationRange

Overview

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

See also:

CObservation

#include <mrpt/obs/CObservationRange.h>

class CObservationRange: public mrpt::obs::CObservation
{
public:
    // typedefs

    typedef std::deque<TMeasurement> TMeasurementList;
    typedef std::deque<TMeasurement>::const_iterator const_iterator;
    typedef std::deque<TMeasurement>::iterator iterator;

    // structs

    struct TMeasurement;

    // fields

    float minSensorDistance {0};
    float maxSensorDistance {5};
    float sensorConeAperture = mrpt::d2f(20.0_deg);
    TMeasurementList sensedData;

    // construction

    CObservationRange();

    // methods

    iterator begin();
    iterator end();
    const_iterator begin() const;
    const_iterator end() const;
    virtual void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const;
    virtual void setSensorPose(const mrpt::poses::CPose3D& newSensorPose);
    virtual void getDescriptionAsText(std::ostream& o) const;
};

Inherited Members

public:
    // fields

    mrpt::system::TTimeStamp timestamp {mrpt::system::now()};
    std::string sensorLabel;

    // methods

    mrpt::system::TTimeStamp getTimeStamp() const;
    virtual mrpt::system::TTimeStamp getOriginalReceivedTimeStamp() const;
    void load() const;
    virtual void unload() const;
    virtual bool exportTxtSupported() const;
    virtual std::string exportTxtHeader() const;
    virtual std::string exportTxtDataRow() const;

    template <class METRICMAP>
    bool insertObservationInto(
        METRICMAP& theMap,
        const std::optional<const mrpt::poses::CPose3D>& robotPose = std::nullopt
        ) const;

    virtual void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const = 0;
    void getSensorPose(mrpt::math::TPose3D& out_sensorPose) const;
    mrpt::math::TPose3D sensorPose() const;
    virtual void setSensorPose(const mrpt::poses::CPose3D& newSensorPose) = 0;
    void setSensorPose(const mrpt::math::TPose3D& newSensorPose);
    virtual void getDescriptionAsText(std::ostream& o) const;
    virtual std::string asString() const;

Fields

float minSensorDistance {0}

The data members.

float sensorConeAperture = mrpt::d2f(20.0_deg)

Cone aperture of each ultrasonic beam, in radians.

TMeasurementList sensedData

All the measurements.

Methods

virtual void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const

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

virtual void setSensorPose(const mrpt::poses::CPose3D& newSensorPose)

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

virtual void getDescriptionAsText(std::ostream& o) const

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

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