Visual Servoing Platform  version 3.6.1 under development (2024-07-27)
vpMeTracker.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2019 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  * Moving edges.
32  */
33 
39 #ifndef VP_ME_TRACKER_H
40 #define VP_ME_TRACKER_H
41 
42 #include <visp3/core/vpColVector.h>
43 #include <visp3/core/vpTracker.h>
44 #include <visp3/me/vpMe.h>
45 #include <visp3/me/vpMeSite.h>
46 
47 #include <iostream>
48 #include <list>
49 #include <math.h>
50 
52 
61 class VISP_EXPORT vpMeTracker : public vpTracker
62 {
63 public:
67  vpMeTracker();
68 
72  vpMeTracker(const vpMeTracker &meTracker);
73 
77  virtual ~vpMeTracker() VP_OVERRIDE;
78 
81 
94  void display(const vpImage<unsigned char> &I);
95 
108  void display(const vpImage<vpRGBa> &I);
109 
117  void display(const vpImage<unsigned char> &I, vpColVector &w, unsigned int &index_w);
118 
128  static bool inRoiMask(const vpImage<bool> *mask, unsigned int i, unsigned int j);
129 
139  static bool inMeMaskCandidates(const vpImage<bool> *meMaskCandidates, unsigned int i, unsigned int j);
140 
146  inline unsigned int getInitRange() { return m_init_range; }
147 
153  inline vpMe *getMe() { return m_me; }
154 
160  inline std::list<vpMeSite> &getMeList() { return m_meList; }
161 
167  inline std::list<vpMeSite> getMeList() const { return m_meList; }
168 
174  inline int getNbPoints() const { return m_nGoodElement; }
175 
179  void init();
180 
188  void initTracking(const vpImage<unsigned char> &I);
189 
193  unsigned int numberOfSignal();
194 
198  vpMeTracker &operator=(vpMeTracker &meTracker);
199 
207  bool outOfImage(int i, int j, int border, int nrows, int ncols);
208 
216  bool outOfImage(const vpImagePoint &iP, int border, int nrows, int ncols);
217 
221  void reset();
222 
226  virtual void sample(const vpImage<unsigned char> &image, bool doNotTrack = false) = 0;
227 
232  void setDisplay(vpMeSite::vpMeSiteDisplayType select) { m_selectDisplay = select; }
233 
239  void setInitRange(const unsigned int &r) { m_init_range = r; }
240 
246  virtual void setMask(const vpImage<bool> &mask) { m_mask = &mask; }
247 
253  virtual void setMaskCandidates(const vpImage<bool> *maskCandidates) { m_maskCandidates = maskCandidates; }
254 
260  void setMe(vpMe *me) { m_me = me; }
261 
267  void setMeList(const std::list<vpMeSite> &meList) { m_meList = meList; }
268 
272  unsigned int totalNumberOfSignal();
273 
281  void track(const vpImage<unsigned char> &I);
283 
284 #if defined(VISP_BUILD_DEPRECATED_FUNCTIONS)
299  VP_DEPRECATED static bool inMask(const vpImage<bool> *mask, unsigned int i, unsigned int j)
300  {
301  return inRoiMask(mask, i, j);
302  }
304 #endif
305 
306 protected:
311  std::list<vpMeSite> m_meList;
315  unsigned int m_init_range;
325 
326 };
327 
328 END_VISP_NAMESPACE
329 
330 #endif
Implementation of column vector and the associated operations.
Definition: vpColVector.h:191
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82
vpMeSiteDisplayType
Definition: vpMeSite.h:74
Contains abstract elements for a Distance to Feature type feature.
Definition: vpMeTracker.h:62
const vpImage< bool > * m_mask
Mask used to disable tracking on a part of image.
Definition: vpMeTracker.h:319
std::list< vpMeSite > getMeList() const
Definition: vpMeTracker.h:167
vpMe * getMe()
Definition: vpMeTracker.h:153
vpMeSite::vpMeSiteDisplayType m_selectDisplay
Moving-edges display type.
Definition: vpMeTracker.h:323
int getNbPoints() const
Definition: vpMeTracker.h:174
virtual void sample(const vpImage< unsigned char > &image, bool doNotTrack=false)=0
virtual void setMaskCandidates(const vpImage< bool > *maskCandidates)
Definition: vpMeTracker.h:253
unsigned int m_init_range
Initial range.
Definition: vpMeTracker.h:315
vpMe * m_me
Moving edges initialisation parameters.
Definition: vpMeTracker.h:313
void setDisplay(vpMeSite::vpMeSiteDisplayType select)
Definition: vpMeTracker.h:232
void setMe(vpMe *me)
Definition: vpMeTracker.h:260
int m_nGoodElement
Number of good moving-edges that are tracked.
Definition: vpMeTracker.h:317
unsigned int getInitRange()
Definition: vpMeTracker.h:146
const vpImage< bool > * m_maskCandidates
Mask used to determine candidate points for initialization in an image.
Definition: vpMeTracker.h:321
std::list< vpMeSite > m_meList
Definition: vpMeTracker.h:311
static VP_DEPRECATED bool inMask(const vpImage< bool > *mask, unsigned int i, unsigned int j)
Definition: vpMeTracker.h:299
void setInitRange(const unsigned int &r)
Definition: vpMeTracker.h:239
std::list< vpMeSite > & getMeList()
Definition: vpMeTracker.h:160
virtual void setMask(const vpImage< bool > &mask)
Definition: vpMeTracker.h:246
void setMeList(const std::list< vpMeSite > &meList)
Definition: vpMeTracker.h:267
Definition: vpMe.h:134
Class that defines what is a feature generic tracker.
Definition: vpTracker.h:61
vpTracker & operator=(const vpTracker &tracker)
Copy operator.
Definition: vpTracker.cpp:50
void init()
Default initialization.
Definition: vpTracker.cpp:44