vpDetectorBase.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Base class for object detection.
 */
 
#ifndef VP_DETECTOR_BASE_H
#define VP_DETECTOR_BASE_H
 
#include <assert.h>
#include <string>
#include <utility>
#include <vector>
 
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/core/vpRect.h>
 
BEGIN_VISP_NAMESPACE

class VISP_EXPORT vpDetectorBase
{
public:
  vpDetectorBase();
  vpDetectorBase(const vpDetectorBase &o);
  virtual ~vpDetectorBase() { }

  virtual bool detect(const vpImage<unsigned char> &I) = 0;


  vpRect getBBox(size_t i) const;

  vpImagePoint getCog(size_t i) const;

  std::vector<std::string> &getMessage() { return m_message; }

  std::string &getMessage(size_t i);

  size_t getNbObjects() const { return m_nb_objects; }

  std::vector<std::vector<vpImagePoint> > &getPolygon() { return m_polygon; }

  std::vector<vpImagePoint> &getPolygon(size_t i);

  inline void setTimeout(unsigned long timeout_ms) { m_timeout_ms = timeout_ms; }

 
protected:
  std::vector<std::vector<vpImagePoint> > m_polygon; 
  std::vector<std::string> m_message;                
  size_t m_nb_objects;                               
  unsigned long m_timeout_ms;                        
};
 
END_VISP_NAMESPACE
 
#endif