tracking_entity.h

Go to the documentation of this file.

/* =========================================================================== *
   |
   |  Copyright (c) 1994-2011 by Kobus Barnard (author)
   |
   |  Personal and educational use of this code is granted, provided that this
   |  header is kept intact, and that the authorship is not misrepresented, that
   |  its use is acknowledged in publications, and relevant papers are cited.
   |
   |  For other use contact the author (kobus AT cs DOT arizona DOT edu).
   |
   |  Please note that the code in this file has not necessarily been adequately
   |  tested. Naturally, there is no guarantee of performance, support, or fitness
   |  for any particular task. Nonetheless, I am interested in hearing about
   |  problems that you encounter.
   |
   |  Author:  Kyle Simek, Ernesto Brau, Jinyan Guan
 * =========================================================================== */

/* $Id: tracking_entity.h 18005 2014-10-30 20:45:03Z ksimek $ */

#ifndef TRACKING_ENTITY_H
#define TRACKING_ENTITY_H

#include <string>
#include <vector>
#include <istream>
#include <ostream>
#include <cassert>

namespace kjb {
namespace tracking {

// To add a new type, add entries to Entity_type, and Entity_type_map;
enum Entity_type { PERSON_ENTITY, BICYCLE_ENTITY, BOTTLE_ENTITY,
                   CAR_ENTITY, CHAIR_ENTITY, DOG_ENTITY, FRAMES_ENTITY,
                   MOTORBIKE_ENTITY, OBJECT_ENTITY, BOX_ENTITY, 
                   BAG_ENTITY, NUM_ENTITY_TYPES };

std::vector<std::string> get_all_entity_type_names();

const std::string& get_entity_type_name(Entity_type type);

Entity_type get_entity_type(const std::string& name);

double get_entity_type_average_height(Entity_type type);

double get_entity_type_stddev_height(Entity_type type);

double get_entity_type_average_width(Entity_type type);

double get_entity_type_stddev_width(Entity_type type);

double get_entity_type_average_girth(Entity_type type);

double get_entity_type_stddev_girth(Entity_type type);

std::ostream& operator<<(std::ostream& ost, Entity_type type);

std::istream& operator>>(std::istream& ist, Entity_type& type);

struct Entity_id
{
    Entity_type type;
    int index;

    Entity_id() :
        type(NUM_ENTITY_TYPES),
        index(-1)
    {}

    Entity_id(Entity_type type_, int index_) :
        type(type_),
        index(index_)
    {}
    
    bool operator!=(const Entity_id& other) const
    {
        return !operator==(other);
    }

    bool operator==(const Entity_id& other) const
    {
        if(type != other.type) return false;
        if(index != other.index) return false;
        return true;
    }

    bool operator<(const Entity_id& other) const
    {
        // lexicographical ordering
        return type < other.type || (type == other.type && index < other.index);
    }

    bool operator!() const
    {
        // for consistency, either both values are "null" or neither are.
        assert((type == NUM_ENTITY_TYPES && index == -1) || 
               (type != NUM_ENTITY_TYPES && index != -1));

        return (type == NUM_ENTITY_TYPES);
    }
};

std::istream& operator>>(std::istream& ist, Entity_id& id);

std::ostream& operator<<(std::ostream& ost, const Entity_id& id);

}} //namespace kjb::tracking

#endif /* TRACKING_ENTITY_H */