CObservationGasSensors.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */
#pragma once

#include <mrpt/obs/CObservation.h>
#include <mrpt/poses/CPose2D.h>
#include <mrpt/poses/CPose3D.h>
#include <mrpt/serialization/CSerializable.h>

namespace mrpt::obs
{
/** Declares a class derived from "CObservation" that represents a set of
 * readings from gas sensors.
 *
 * \sa CObservation
 * \ingroup mrpt_obs_grp
 */
class CObservationGasSensors : public CObservation
{
    DEFINE_SERIALIZABLE(CObservationGasSensors, mrpt::obs)

   public:
    /** Constructor.
     */
    CObservationGasSensors();

    /** The structure for each e-nose
     */
    struct TObservationENose
    {
        TObservationENose()
            : eNosePoseOnTheRobot(), readingsVoltage(), sensorTypes()
        {
        }

        /** The pose of the sensors on the robot */
        math::TPose3D eNosePoseOnTheRobot;
        /** The set of readings (in volts) from the array of sensors (size of
         * "sensorTypes" is the same that the size of "readingsVoltage") */
        std::vector<float> readingsVoltage;

        /** The kind of sensors in the array (size of "sensorTypes" is the same
         *that the size of "readingsVoltage")
         *  The meaning of values for types of sensors is as follows:
         *   0x0000 : No sensor installed in this slot
         *  0x2600 : Figaro TGS 2600
         *  0x2602 : Figaro TGS 2602
         *  0x2620 : Figaro TGS 2620
         *  0x4161 : Figaro TGS 4161
         */
        std::vector<int> sensorTypes;
        /** Must be true for "temperature" to contain a valid measurement */
        bool hasTemperature{false};
        /** Sensed temperature in Celcius (valid if hasTemperature=true only) */
        float temperature{0};
        /** True if the input to this chamber/enose is poluted air, False if
         * clean air */
        bool isActive;
    };

    /** One entry per e-nose on the robot */
    std::vector<TObservationENose> m_readings;

    // See base class docs
    void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const override;
    void setSensorPose(const mrpt::poses::CPose3D& newSensorPose) override;
    void getDescriptionAsText(std::ostream& o) const override;

    /** Declares a class within "CObservationGasSensors" that represents a set
     * of gas concentration readings from the modelation of a MOS gas sensor
     * readings.
     * This class provides the parameters and functions to simulate the inverse
     * model of a MOS gas sensor.
     *
     * \sa CObservationGasSensors
     */
    class CMOSmodel
    {
       public:
        /** @name MOS-model parameters
         *  @{  */
        /** The size of the mobile average window used to reduce noise on sensor
         * reagings. */
        size_t winNoise_size{30};
        /** [useMOSmodel] The decimate frecuency applied after noise filtering
         */
        int decimate_value{6};

        /** tau = a*AMPLITUDE +b (linear relationship) */
        float a_rise{0};
        /** tau = a*AMPLITUDE +b (linear relationship) */
        float b_rise{0};
        /** tau = a*AMPLITUDE +b (linear relationship) */
        float a_decay{0};
        /** tau = a*AMPLITUDE +b (linear relationship) */
        float b_decay{0};

        /** If true save generated gas map as a log file */
        bool save_maplog{false};

        /** @} */

        /** Obtain an estimation of the gas distribution based on raw sensor
         * readings  */
        bool get_GasDistribution_estimation(
            float& reading, mrpt::system::TTimeStamp& timestamp);

       protected:
        /** The content of each m_lastObservations in the estimation when using
         * the option : MOS_MODEl (useMOSmodel =1)
         */
        struct TdataMap
        {
            /** Sensore reading */
            float reading;
            /** Timestamp of the observation */
            mrpt::system::TTimeStamp timestamp;
            /** tau value applied                                */
            float tau;
            /** The value estimated according to the MOXmodel */
            float estimation;
            /** Reading after smooth (noise averaging) */
            float reading_filtered;
        };

        /** The content of each m_lastObservations in the estimation when using
         * the option : MOS_MODEl (useMOSmodel =1) */
        TdataMap last_Obs, temporal_Obs;
        /** Vector to temporally store and averge readings to reduce noise */
        std::vector<TdataMap> m_antiNoise_window;
        /** Ofstream to save to file option "save_maplog" */
        std::ofstream* m_debug_dump{nullptr};
        /** Decimate value for oversampled enose readings */
        uint16_t decimate_count{1};
        /** To force e-nose samples to have fixed time increments */
        double fixed_incT{0};
        /** To force e-nose samples to have fixed time increments */
        bool first_incT{true};
        /** Minimum reading value till the moment, used as approximation to
         * baeline level */
        float min_reading{10};
        /** To avoid the model estimation on first iteration */
        bool first_iteration{true};

        /** Estimates the gas concentration based on readings and sensor model
         */
        void inverse_MOSmodeling(
            float reading, const mrpt::system::TTimeStamp& timestamp);

        /** Reduce noise by averaging with a mobile window of specific size
         * (winNoise_size)
         */
        void noise_filtering(
            float reading, const mrpt::system::TTimeStamp& timestamp);

        /** Save the gas distribution estiamtion into a log file for offline
         * representation
         */
        void save_log_map(
            const mrpt::system::TTimeStamp& timestamp, float reading,
            float estimation, float tau);

    };  // End of CMOSmodel class def.

};  // End of class def.

}  // namespace mrpt::obs