FullnessMetric.hpp

Go to the documentation of this file.

 
#ifndef FULLNESS_HPP
#define FULLNESS_HPP
 
#include "Distance.hpp"
#include <array>
#include <cstddef>
#include <cstdint>
 
namespace Fullness
{
    class FullnessMetric
    {
    public:
        FullnessMetric(uint32_t binHeight, Distance &distanceSensor);

        float getFullness();

        bool isValidDistance(uint32_t distance);
 
    private:
        static constexpr size_t mDistanceBufferSize = 8;
 
        float IQM(std::array<int32_t, mDistanceBufferSize> &distanceBuffer); // interquartile mean, a statistical "average" across multiple values. i assume iqm uses shell sort to sort the values, then creates the iqm using standard formulas, then passes that into (is called by) getFullness to calculate a final percentage value. otherwise the iqm could be of fullness values but that would likely be slower requiring multiple calls to getFullness
 
        void shellSort(std::array<int32_t, mDistanceBufferSize> &arr);

        uint32_t mBinHeight;

        Distance &mDistanceSensor;
    };
}
#endif