Visual Servoing Platform  version 3.6.1 under development (2025-02-18)
tutorial-mb-tracker.cpp
1 #include <visp3/core/vpConfig.h>
3 #include <visp3/core/vpIoTools.h>
4 #include <visp3/gui/vpDisplayFactory.h>
5 #include <visp3/io/vpImageIo.h>
7 #include <visp3/mbt/vpMbEdgeKltTracker.h>
8 #include <visp3/mbt/vpMbEdgeTracker.h>
10 #include <visp3/io/vpVideoReader.h>
11 
12 int main(int argc, char **argv)
13 {
14 #if defined(VISP_HAVE_OPENCV) && defined(VISP_HAVE_DISPLAY)
15 #ifdef ENABLE_VISP_NAMESPACE
16  using namespace VISP_NAMESPACE_NAME;
17 #endif
18 
19 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
20  std::shared_ptr<vpDisplay> display = vpDisplayFactory::createDisplay();
21 #else
23 #endif
24  vpMbTracker *tracker = nullptr;
25 
26  try {
27  std::string opt_videoname = "teabox.mp4";
28  std::string opt_modelname = "teabox";
29  int opt_tracker = 0;
30 
31  for (int i = 1; i < argc; i++) {
32  if (std::string(argv[i]) == "--video" && i + 1 < argc) {
33  opt_videoname = std::string(argv[++i]);
34  }
35  else if (std::string(argv[i]) == "--model" && i + 1 < argc) {
36  opt_modelname = std::string(argv[++i]);
37  }
38  else if (std::string(argv[i]) == "--tracker" && i + 1 < argc) {
39  opt_tracker = atoi(argv[++i]);
40  }
41  else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
42  std::cout << "\nUsage: " << argv[0]
43  << " [--video <video name>]"
44  << " [--model <model name>] "
45  << " [--tracker <0=egde|1=keypoint|2=hybrid>]"
46  << " [--help] [-h]\n"
47  << std::endl;
48 #if (VISP_CXX_STANDARD < VISP_CXX_STANDARD_11)
49  if (display != nullptr) {
50  delete display;
51  }
52 #endif
53  return EXIT_SUCCESS;
54  }
55  }
56  std::string parentname = vpIoTools::getParent(opt_modelname);
57  std::string objectname = vpIoTools::getNameWE(opt_modelname);
58 
59  if (!parentname.empty())
60  objectname = parentname + "/" + objectname;
61 
62  std::cout << "Video name: " << opt_videoname << std::endl;
63  std::cout << "Tracker requested config files: " << objectname << ".[init, cao]" << std::endl;
64  std::cout << "Tracker optional config files: " << objectname << ".[ppm]" << std::endl;
65 
73 
74  vpVideoReader g;
75  g.setFileName(opt_videoname);
76  g.open(I);
77 
78  display->init(I, 100, 100, "Model-based tracker");
79 
81  if (opt_tracker == 0)
82  tracker = new vpMbEdgeTracker;
83 #if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_IMGPROC) && defined(HAVE_OPENCV_VIDEO)
84  else if (opt_tracker == 1)
85  tracker = new vpMbKltTracker;
86  else
87  tracker = new vpMbEdgeKltTracker;
88 #else
89  else {
90  std::cout << "klt and hybrid model-based tracker are not available "
91  "since visp_klt module is missing"
92  << std::endl;
93 #if (VISP_CXX_STANDARD < VISP_CXX_STANDARD_11)
94  if (display != nullptr) {
95  delete display;
96  }
97 #endif
98  return EXIT_FAILURE;
99  }
100 #endif
102 
104  if (opt_tracker == 0 || opt_tracker == 2) {
105  vpMe me;
106  me.setMaskSize(5);
107  me.setMaskNumber(180);
108  me.setRange(8);
110  me.setThreshold(20);
111  me.setMu1(0.5);
112  me.setMu2(0.5);
113  me.setSampleStep(4);
114  dynamic_cast<vpMbEdgeTracker *>(tracker)->setMovingEdge(me);
115  }
116 
117 #if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_IMGPROC) && defined(HAVE_OPENCV_VIDEO)
118  if (opt_tracker == 1 || opt_tracker == 2) {
119  vpKltOpencv klt_settings;
120  klt_settings.setMaxFeatures(300);
121  klt_settings.setWindowSize(5);
122  klt_settings.setQuality(0.015);
123  klt_settings.setMinDistance(8);
124  klt_settings.setHarrisFreeParameter(0.01);
125  klt_settings.setBlockSize(3);
126  klt_settings.setPyramidLevels(3);
127  dynamic_cast<vpMbKltTracker *>(tracker)->setKltOpencv(klt_settings);
128  dynamic_cast<vpMbKltTracker *>(tracker)->setKltMaskBorder(5);
129  }
130 #endif
131 
133  cam.initPersProjWithoutDistortion(839, 839, 325, 243);
135  tracker->setCameraParameters(cam);
137 
139  tracker->loadModel(objectname + ".cao");
142  tracker->setDisplayFeatures(true);
145  tracker->initClick(I, objectname + ".init", true);
147 
148  while (!g.end()) {
149  g.acquire(I);
152  tracker->track(I);
155  tracker->getPose(cMo);
158  tracker->getCameraParameters(cam);
159  tracker->display(I, cMo, cam, vpColor::red, 2);
161  vpDisplay::displayFrame(I, cMo, cam, 0.025, vpColor::none, 3);
162  vpDisplay::displayText(I, 10, 10, "A click to exit...", vpColor::red);
163  vpDisplay::flush(I);
164 
165  if (vpDisplay::getClick(I, false))
166  break;
167  }
169  }
170  catch (const vpException &e) {
171  std::cout << "Catch a ViSP exception: " << e << std::endl;
172 #if (VISP_CXX_STANDARD < VISP_CXX_STANDARD_11)
173  if (display != nullptr) {
174  delete display;
175  }
176 #endif
177  if (tracker != nullptr) {
178  delete tracker;
179  }
180  return EXIT_FAILURE;
181  }
182 
184 #if (VISP_CXX_STANDARD < VISP_CXX_STANDARD_11)
185  if (display != nullptr) {
186  delete display;
187  }
188 #endif
189  if (tracker != nullptr) {
190  delete tracker;
191  }
193 #else
194  (void)argc;
195  (void)argv;
196  std::cout << "Install OpenCV and rebuild ViSP to use this example." << std::endl;
197 #endif
198  return EXIT_SUCCESS;
199  }
Generic class defining intrinsic camera parameters.
void initPersProjWithoutDistortion(double px, double py, double u0, double v0)
static const vpColor red
Definition: vpColor.h:198
static const vpColor none
Definition: vpColor.h:210
Class that defines generic functionalities for display.
Definition: vpDisplay.h:178
static bool getClick(const vpImage< unsigned char > &I, bool blocking=true)
static void display(const vpImage< unsigned char > &I)
static void displayFrame(const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color=vpColor::none, unsigned int thickness=1, const vpImagePoint &offset=vpImagePoint(0, 0), const std::string &frameName="", const vpColor &textColor=vpColor::black, const vpImagePoint &textOffset=vpImagePoint(15, 15))
static void flush(const vpImage< unsigned char > &I)
static void displayText(const vpImage< unsigned char > &I, const vpImagePoint &ip, const std::string &s, const vpColor &color)
error that can be emitted by ViSP classes.
Definition: vpException.h:60
Implementation of an homogeneous matrix and operations on such kind of matrices.
static std::string getNameWE(const std::string &pathname)
Definition: vpIoTools.cpp:1227
static std::string getParent(const std::string &pathname)
Definition: vpIoTools.cpp:1314
Wrapper for the KLT (Kanade-Lucas-Tomasi) feature tracker implemented in OpenCV. Thus to enable this ...
Definition: vpKltOpencv.h:79
void setBlockSize(int blockSize)
Definition: vpKltOpencv.h:272
void setQuality(double qualityLevel)
Definition: vpKltOpencv.h:361
void setHarrisFreeParameter(double harris_k)
Definition: vpKltOpencv.h:280
void setMaxFeatures(int maxCount)
Definition: vpKltOpencv.h:320
void setMinDistance(double minDistance)
Definition: vpKltOpencv.h:329
void setWindowSize(int winSize)
Definition: vpKltOpencv.h:382
void setPyramidLevels(int pyrMaxLevel)
Definition: vpKltOpencv.h:348
Make the complete tracking of an object by using its CAD model.
Main methods for a model-based tracker.
Definition: vpMbTracker.h:107
virtual void track(const vpImage< unsigned char > &I)=0
virtual void getCameraParameters(vpCameraParameters &cam) const
Definition: vpMbTracker.h:250
virtual void setDisplayFeatures(bool displayF)
Definition: vpMbTracker.h:520
virtual void getPose(vpHomogeneousMatrix &cMo) const
Definition: vpMbTracker.h:416
virtual void setCameraParameters(const vpCameraParameters &cam)
Definition: vpMbTracker.h:490
virtual void display(const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, unsigned int thickness=1, bool displayFullModel=false)=0
virtual void loadModel(const std::string &modelFile, bool verbose=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
Definition: vpMe.h:134
void setMu1(const double &mu_1)
Definition: vpMe.h:385
void setRange(const unsigned int &range)
Definition: vpMe.h:415
void setLikelihoodThresholdType(const vpLikelihoodThresholdType likelihood_threshold_type)
Definition: vpMe.h:505
void setMaskNumber(const unsigned int &mask_number)
Definition: vpMe.cpp:552
void setThreshold(const double &threshold)
Definition: vpMe.h:466
void setSampleStep(const double &sample_step)
Definition: vpMe.h:422
void setMaskSize(const unsigned int &mask_size)
Definition: vpMe.cpp:560
void setMu2(const double &mu_2)
Definition: vpMe.h:392
@ NORMALIZED_THRESHOLD
Definition: vpMe.h:145
Class that enables to manipulate easily a video file or a sequence of images. As it inherits from the...
void acquire(vpImage< vpRGBa > &I)
void open(vpImage< vpRGBa > &I)
void setFileName(const std::string &filename)
std::shared_ptr< vpDisplay > createDisplay()
Return a smart pointer vpDisplay specialization if a GUI library is available or nullptr otherwise.
vpDisplay * allocateDisplay()
Return a newly allocated vpDisplay specialization if a GUI library is available or nullptr otherwise.