results.h

/****************************************************************************
 * Copyright (c) 2014, Joel Kivelä, Erkki Koskenkorva, Oskari Leppäaho,
 * Mika Lehtinen and Petri Partanen.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holders nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
****************************************************************************/
#ifndef RESULTS_H
#define RESULTS_H

#include <fstream>
#include <set>
#include <string>
#include <tuple>
#include <utility>

#include "common.h"

namespace cavapa_gui
{
class Results
{
public:
    FrameStats addFrame(FrameTime time,
                        const std::vector<cavapa::Sightings> &sightings);

    void clear() { results.clear(); }

    bool empty() const { return results.empty(); }

    bool exportToCSV(const ExportOptions& options) const;

    unsigned int getCount() const { return results.size(); }

    FrameTime getFirstFrameTime() const
        { return results.size() == 0 ? 0 : getStats(results.at(0)).time; }

    int getFrameNumber(FrameTime time) const;

    std::vector<cavapa::Sightings> getSightings(FrameTime time) const;

    std::vector<FrameStats> getStatistics(FrameTime start,
                                       FrameTime stop, int points) const;

    bool load(const std::string& path);

    bool save(const std::string& path) const;

private:
    struct SightingFixed
    {
        SightingFixed() {}

        SightingFixed(const cavapa::Sighting& s) : id(s.id), world_x(s.world.x),
            world_y(s.world.y), certainty(s.certainty), topleft_x(s.topleft.x),
            topleft_y(s.topleft.y), bottomright_x(s.bottomright.x),
            bottomright_y(s.bottomright.y) {}

        std::int32_t id;
        float world_x;
        float world_y;
        float certainty;
        std::int16_t topleft_x;
        std::int16_t topleft_y;
        std::int16_t bottomright_x;
        std::int16_t bottomright_y;

        // This check is performed in order to check the correct member size in
        // structure to maintain 32bit & 64bit file format integrity.
        static_assert(sizeof(SightingFixed::id) == 4
                      && sizeof(SightingFixed::world_x) == 4
                      && sizeof(SightingFixed::world_y) == 4
                      && sizeof(SightingFixed::certainty) == 4
                      && sizeof(SightingFixed::topleft_x) == 2
                      && sizeof(SightingFixed::topleft_y) == 2
                      && sizeof(SightingFixed::bottomright_x) == 2
                      && sizeof(SightingFixed::bottomright_y) == 2,
                     "The size of the structure members is not correct.");
    };

    static float calculateActivity(const std::vector<cavapa::Sightings>& s);

    static int calculateTotalSightings(const std::vector<cavapa::Sightings>& s);

    using FrameResults = std::tuple<FrameStats,
                std::vector<std::uint32_t>, std::vector<SightingFixed>>;

    using MarkerSet = std::set<Marker, std::function<bool (Marker, Marker)>>;

    static inline FrameStats getAverage(
                            std::vector<FrameResults>::const_iterator a,
                            std::vector<FrameResults>::const_iterator b);

    static std::string getMarkerTexts(FrameTime stop, MarkerSet& markers);

    static std::vector<SightingFixed> getSightings(const FrameResults& r)
        { return std::get<2>(r); }

    static std::vector<SightingFixed> getSightings(
            const std::vector<FrameResults>::const_iterator& it)
        { return getSightings(*it); }

    static std::vector<std::uint32_t> getSightingCounts(const FrameResults& r)
        { return std::get<1>(r); }

    inline std::vector<FrameResults>::const_iterator
            getStartPoint(FrameTime ft) const;

    static FrameStats getStats(const FrameResults& r)
        { return std::get<0>(r); }

    static FrameStats getStats(
            const std::vector<FrameResults>::const_iterator& it)
                { return getStats(*it); }

    inline std::vector<FrameResults>::const_iterator
            getStopPoint(FrameTime ft) const;

    static MarkerSet sortMarkers(FrameTime start, FrameTime stop,
                    const std::vector<Marker>& markers);

    std::vector<FrameResults> results; // Holds information about each frame.
};
} // namespace

#endif // RESULTS_H