/home/rex/ebltrunk/core/libeblearn/include/nms.h

/***************************************************************************
 *   Copyright (C) 2012 by Pierre Sermanet *
 *   pierre.sermanet@gmail.com *
 *   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.
 *     * Redistribution under a license not approved by the Open Source
 *       Initiative (http://www.opensource.org) must display the
 *       following acknowledgement in all advertising material:
 *        This product includes software developed at the Courant
 *        Institute of Mathematical Sciences (http://cims.nyu.edu).
 *     * The names of the authors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``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 AUTHORS 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 NMS_H_
#define NMS_H_

#include "bbox.h"

using namespace std;

namespace ebl {

  // nms types /////////////////////////////////////////////////////////////////

  enum t_nms { nms_none           = 0,  // no nms
               nms_overlap        = 1,  // traditional nms
               nms_voting         = 2,  // voting nms
               nms_voting_overlap = 3   // voting followed by traditional
  };

  // nms ///////////////////////////////////////////////////////////////////////

  class nms {
  public:
    nms(float threshold, float max_overlap, float max_hcenter_dist,
        float max_wcenter_dist, float pre_hfact, float pre_wfact,
        float post_hfact, float post_wfact, float woverh,
        std::ostream &out = std::cout, std::ostream &err = std::cerr);
    virtual ~nms();

    virtual void fprop(bboxes &in, bboxes &out);
    virtual string describe();

    // friends /////////////////////////////////////////////////////////////////
    friend class voting_nms;

  protected:
    // internal methods ////////////////////////////////////////////////////////

    virtual void process(bboxes &in, bboxes &out);
    virtual void traditional_nms(bboxes &in, bboxes &out);

    void prune_overlap(bboxes &raw_bboxes, bboxes &prune_bboxes,
                       float max_match,
                       bool same_class_only = false,
                       float min_hcenter_dist = 0.0,
                       float min_wcenter_dist = 0.0,
                       float threshold = 0.0,
                       float same_scale_mhd = 0.0, float same_scale_mwd = 0.0);

    // member variables ////////////////////////////////////////////////////////
  protected:
    std::ostream &mout; 
    std::ostream &merr; 
    float        threshold;     
    float        max_overlap;   
    float        max_hcenter_dist;      
    float        max_wcenter_dist;      
    float        pre_hfact; 
    float        pre_wfact; 
    float        post_hfact; 
    float        post_wfact; 
    float        woverh; 
    bool         same_class_matching_only; 
  };

  // voting nms ////////////////////////////////////////////////////////////////

  class voting_nms : public nms {
  public:
    voting_nms(float threshold, float max_overlap, float max_hcenter_dist,
               float max_wcenter_dist, float pre_hfact, float pre_wfact,
               float post_hfact, float post_wfact, float woverh,
               std::ostream &out = std::cout, std::ostream &err = std::cerr);
    voting_nms(float threshold, float max_overlap, float max_hcenter_dist,
               float max_wcenter_dist, float pre_hfact, float pre_wfact,
               float post_hfact, float post_wfact, float woverh,
               float vote_max_overlap, float vote_max_hcd, float vote_max_wcd,
               std::ostream &out = std::cout, std::ostream &err = std::cerr);
    virtual ~voting_nms();

    virtual string describe();

  protected:
    // internal methods ////////////////////////////////////////////////////////

    virtual void process(bboxes &in, bboxes &out);
    virtual void vote_nms(bboxes &in, bboxes &out);

    void dfs(bboxes &bb, vector<bool> &explored, uint i, float match,
             float max_center_dist, bboxes &comp);
    void merge_votes(bboxes &bb);
    void prune_votes(bboxes &in, bboxes &out);

    // member variables ////////////////////////////////////////////////////////
  protected:
    nms   *tnms; 
  };

} // end namespace ebl

#endif /* NMS_H_ */