Visual Servoing Platform  version 3.6.1 under development (2024-07-17)
vpDetectorBase.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
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 https://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 
34 #ifndef VP_DETECTOR_BASE_H
35 #define VP_DETECTOR_BASE_H
36 
37 #include <assert.h>
38 #include <string>
39 #include <utility>
40 #include <vector>
41 
42 #include <visp3/core/vpImage.h>
43 #include <visp3/core/vpImagePoint.h>
44 #include <visp3/core/vpRect.h>
45 
47 
62 class VISP_EXPORT vpDetectorBase
63 {
64 public:
73  virtual ~vpDetectorBase() { }
74 
80  virtual bool detect(const vpImage<unsigned char> &I) = 0;
81 
84 
88  vpRect getBBox(size_t i) const;
89 
93  vpImagePoint getCog(size_t i) const;
94 
98  std::vector<std::string> &getMessage() { return m_message; }
99 
103  std::string &getMessage(size_t i);
104 
108  size_t getNbObjects() const { return m_nb_objects; }
109 
113  std::vector<std::vector<vpImagePoint> > &getPolygon() { return m_polygon; }
114 
118  std::vector<vpImagePoint> &getPolygon(size_t i);
119 
123  inline void setTimeout(unsigned long timeout_ms) { m_timeout_ms = timeout_ms; }
124 
126 
127 protected:
128  std::vector<std::vector<vpImagePoint> > m_polygon;
129  std::vector<std::string> m_message;
130  size_t m_nb_objects;
131  unsigned long m_timeout_ms;
132 };
133 
134 END_VISP_NAMESPACE
135 
136 #endif
std::vector< std::vector< vpImagePoint > > & getPolygon()
std::vector< std::string > m_message
Message attached to each object.
std::vector< std::vector< vpImagePoint > > m_polygon
For each object, defines the polygon that contains the object.
void setTimeout(unsigned long timeout_ms)
size_t m_nb_objects
Number of detected objects.
unsigned long m_timeout_ms
Detection timeout.
size_t getNbObjects() const
virtual ~vpDetectorBase()
std::vector< std::string > & getMessage()
virtual bool detect(const vpImage< unsigned char > &I)=0
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82
Defines a rectangle in the plane.
Definition: vpRect.h:79