Visual Servoing Platform  version 3.0.0
vpDetectorBase.h
1 /****************************************************************************
2  *
3  * This file is part of the ViSP software.
4  * Copyright (C) 2005 - 2015 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See http://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Base class for object detection.
32  *
33  * Authors:
34  * Fabien Spindler
35  *
36  *****************************************************************************/
37 
38 #ifndef __vpDetectorBase_h__
39 #define __vpDetectorBase_h__
40 
41 #include <vector>
42 #include <utility>
43 #include <string>
44 #include <assert.h>
45 
46 #include <visp3/core/vpImage.h>
47 #include <visp3/core/vpImagePoint.h>
48 #include <visp3/core/vpRect.h>
49 
61 class VISP_EXPORT vpDetectorBase
62 {
63 protected:
64  std::vector< std::vector<vpImagePoint> > m_polygon;
65  std::vector< std::string > m_message;
66  size_t m_nb_objects;
67 
68 public:
76  virtual ~vpDetectorBase() {};
77 
83  virtual bool detect(const vpImage<unsigned char> &I) = 0;
87  std::vector< std::vector<vpImagePoint> > & getPolygon()
88  {
89  return m_polygon;
90  }
91 
95  std::vector<vpImagePoint> & getPolygon(size_t i);
96 
100  std::string & getMessage(size_t i);
101 
105  std::vector< std::string > & getMessage() { return m_message; }
106 
110  size_t getNbObjects() const {return m_nb_objects; }
111 
115  vpImagePoint getCog(size_t i) const ;
116 
120  vpRect getBBox(size_t i) const ;
121 };
122 
123 #endif
virtual ~vpDetectorBase()
size_t getNbObjects() const
size_t m_nb_objects
Number of detected objects.
std::vector< std::vector< vpImagePoint > > & getPolygon()
std::vector< std::string > & getMessage()
std::vector< std::string > m_message
Message attached to each object.
Defines a rectangle in the plane.
Definition: vpRect.h:81
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:88
std::vector< std::vector< vpImagePoint > > m_polygon
For each object, defines the polygon that contains the object.