Visual Servoing Platform version 3.5.0
vpDetectorBase.h
1/****************************************************************************
2 *
3 * ViSP, open source Visual Servoing Platform software.
4 * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5 *
6 * This software is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 * See the file LICENSE.txt at the root directory of this source
11 * distribution for additional information about the GNU GPL.
12 *
13 * For using ViSP with software that can not be combined with the GNU
14 * GPL, please contact Inria about acquiring a ViSP Professional
15 * Edition License.
16 *
17 * See http://visp.inria.fr for more information.
18 *
19 * This software was developed at:
20 * Inria Rennes - Bretagne Atlantique
21 * Campus Universitaire de Beaulieu
22 * 35042 Rennes Cedex
23 * France
24 *
25 * If you have questions regarding the use of this file, please contact
26 * Inria at visp@inria.fr
27 *
28 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30 *
31 * Description:
32 * Base class for object detection.
33 *
34 * Authors:
35 * Fabien Spindler
36 *
37 *****************************************************************************/
38
39#ifndef _vpDetectorBase_h_
40#define _vpDetectorBase_h_
41
42#include <assert.h>
43#include <string>
44#include <utility>
45#include <vector>
46
47#include <visp3/core/vpImage.h>
48#include <visp3/core/vpImagePoint.h>
49#include <visp3/core/vpRect.h>
50
64class VISP_EXPORT vpDetectorBase
65{
66protected:
67 std::vector<std::vector<vpImagePoint> > m_polygon;
68 std::vector<std::string> m_message;
69 size_t m_nb_objects;
70 unsigned long m_timeout_ms;
71
72public:
81 virtual ~vpDetectorBase() {}
82
88 virtual bool detect(const vpImage<unsigned char> &I) = 0;
89
92
96 vpRect getBBox(size_t i) const;
97
101 vpImagePoint getCog(size_t i) const;
102
106 std::vector<std::string> &getMessage() { return m_message; }
107
111 std::string &getMessage(size_t i);
112
116 size_t getNbObjects() const { return m_nb_objects; }
117
121 std::vector<std::vector<vpImagePoint> > &getPolygon() { return m_polygon; }
122
126 std::vector<vpImagePoint> &getPolygon(size_t i);
127
129 inline void setTimeout(unsigned long timeout_ms) { m_timeout_ms = timeout_ms; }
130
132};
133
134#endif
std::vector< std::string > m_message
Message attached to each object.
std::vector< std::vector< vpImagePoint > > & getPolygon()
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.
std::vector< std::string > & getMessage()
size_t getNbObjects() const
virtual ~vpDetectorBase()
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:88
Defines a rectangle in the plane.
Definition: vpRect.h:80