class mrpt::obs::CObservationImage

Overview

Declares a class derived from “CObservation” that encapsules an image from a camera, whose relative pose to robot is also stored.

The next figure illustrate the coordinates reference systems involved in this class:

See also:

CObservation, CObservationStereoImages

#include <mrpt/obs/CObservationImage.h>

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

    typedef std::shared_ptr<mrpt::obs ::CObservationImage> Ptr;
    typedef std::shared_ptr<const mrpt::obs ::CObservationImage> ConstPtr;
    typedef std::unique_ptr<mrpt::obs ::CObservationImage> UniquePtr;
    typedef std::unique_ptr<const mrpt::obs ::CObservationImage> ConstUniquePtr;

    // fields

    static constexpr const char* className = "mrpt::obs" "::" "CObservationImage";
    mrpt::poses::CPose3D cameraPose;
    mrpt::img::TCamera cameraParams;
    mrpt::img::CImage image;

    // construction

    CObservationImage();

    // methods

    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;
    virtual mrpt::rtti::CObject* clone() const;
    virtual void load_impl() const;
    virtual void unload() const;
    void getUndistortedImage(mrpt::img::CImage& out_img) const;
    virtual mrpt::poses::CPose3D getSensorPose() const;
    virtual void setSensorPose(const mrpt::poses::CPose3D& newSensorPose);
    virtual void getDescriptionAsText(std::ostream& o) const;
};

Inherited Members

public:
    // typedefs

    typedef std::shared_ptr<CObject> Ptr;
    typedef std::shared_ptr<const CObject> ConstPtr;
    typedef std::shared_ptr<CSerializable> Ptr;
    typedef std::shared_ptr<const CSerializable> ConstPtr;
    typedef std::shared_ptr<CObservation> Ptr;
    typedef std::shared_ptr<const CObservation> ConstPtr;

    // fields

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

    // methods

    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    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 mrpt::poses::CPose3D getSensorPose() const = 0;
    void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const;
    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;

Typedefs

typedef std::shared_ptr<mrpt::obs ::CObservationImage> Ptr

A type for the associated smart pointer.

Fields

mrpt::poses::CPose3D cameraPose

The pose of the camera on the robot.

mrpt::img::TCamera cameraParams

Intrinsic and distortion parameters of the camera.

See the tutorial for a discussion of these parameters.

mrpt::img::CImage image

The image captured by the camera, that is, the main piece of information of this observation.

Construction

CObservationImage()

Constructor.

Parameters:

iplImage

An OpenCV “IplImage*” object with the image to be loaded in the member “image”, or nullptr (default) for an empty image.

Methods

virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const

Returns information about the class of an object in runtime.

virtual mrpt::rtti::CObject* clone() const

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

virtual void load_impl() const

Makes sure the image, which may be externally stored, are loaded in memory.

See also:

unload

virtual void unload() const

Unload image, for the case of it being stored in lazy-load mode (otherwise, the method has no effect).

See also:

load

void getUndistortedImage(mrpt::img::CImage& out_img) const

Computes the un-distorted image, using the embedded camera intrinsic & distortion parameters.

virtual mrpt::poses::CPose3D getSensorPose() 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 A general method to retrieve the sensor pose on the robot, returning it by value.

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