Visual Servoing Platform  version 3.6.1 under development (2025-02-18)
tutorial-detection-object-mbt2.cpp
1 #include <visp3/core/vpConfig.h>
3 #include <visp3/core/vpIoTools.h>
4 #include <visp3/gui/vpDisplayFactory.h>
5 #include <visp3/io/vpVideoReader.h>
6 #include <visp3/mbt/vpMbGenericTracker.h>
7 #include <visp3/vision/vpKeyPoint.h>
8 
9 #ifdef ENABLE_VISP_NAMESPACE
10 using namespace VISP_NAMESPACE_NAME;
11 #endif
12 
13 #if defined(HAVE_OPENCV_IMGPROC) && defined(VISP_HAVE_DISPLAY) && \
14  ((VISP_HAVE_OPENCV_VERSION < 0x050000) && defined(HAVE_OPENCV_CALIB3D) && defined(HAVE_OPENCV_FEATURES2D)) || \
15  ((VISP_HAVE_OPENCV_VERSION >= 0x050000) && defined(HAVE_OPENCV_3D) && defined(HAVE_OPENCV_FEATURES))
16 
17 void learnCube(const vpImage<unsigned char> &I, vpMbGenericTracker &tracker, vpKeyPoint &keypoint_learning, int id)
18 {
20  std::vector<cv::KeyPoint> trainKeyPoints;
21  double elapsedTime;
22  keypoint_learning.detect(I, trainKeyPoints, elapsedTime);
24 
26  std::vector<vpPolygon> polygons;
27  std::vector<std::vector<vpPoint> > roisPt;
28  std::pair<std::vector<vpPolygon>, std::vector<std::vector<vpPoint> > > pair = tracker.getPolygonFaces();
29  polygons = pair.first;
30  roisPt = pair.second;
31 
32  std::vector<cv::Point3f> points3f;
34  tracker.getPose(cMo);
36  tracker.getCameraParameters(cam);
37  vpKeyPoint::compute3DForPointsInPolygons(cMo, cam, trainKeyPoints, polygons, roisPt, points3f);
39 
41  keypoint_learning.buildReference(I, trainKeyPoints, points3f, true, id);
43 
45  for (std::vector<cv::KeyPoint>::const_iterator it = trainKeyPoints.begin(); it != trainKeyPoints.end(); ++it) {
46  vpDisplay::displayCross(I, (int)it->pt.y, (int)it->pt.x, 4, vpColor::red);
47  }
49 }
50 #endif
51 
52 int main(int argc, char **argv)
53 {
54 #if defined(HAVE_OPENCV_IMGPROC) && \
55  ((VISP_HAVE_OPENCV_VERSION < 0x050000) && defined(HAVE_OPENCV_FEATURES2D)) || ((VISP_HAVE_OPENCV_VERSION >= 0x050000) && defined(HAVE_OPENCV_FEATURES))
56 
58 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
59  std::shared_ptr<vpDisplay> display, display2;
60 #else
61  vpDisplay *display = nullptr;
62  vpDisplay *display2 = nullptr;
63 #endif
64  try {
65  std::string videoname = "cube.mp4";
66 
67  for (int i = 1; i < argc; i++) {
68  if (std::string(argv[i]) == "--name" && i + 1 < argc)
69  videoname = std::string(argv[++i]);
70  else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
71  std::cout << "\nUsage: " << argv[0]
72  << " [--name <video name>]"
73  << " [--help] [-h]\n" << std::endl;
74  return EXIT_SUCCESS;
75  }
76  }
77  std::string parentname = vpIoTools::getParent(videoname);
78  std::string objectname = vpIoTools::getNameWE(videoname);
79 
80  if (!parentname.empty())
81  objectname = parentname + "/" + objectname;
82 
83  std::cout << "Video name: " << videoname << std::endl;
84  std::cout << "Tracker requested config files: " << objectname << ".[init,"
85  << "xml,"
86  << "cao or wrl]" << std::endl;
87  std::cout << "Tracker optional config files: " << objectname << ".[ppm]" << std::endl;
88 
92 
94  bool usexml = false;
95 #if defined(VISP_HAVE_PUGIXML)
96  if (vpIoTools::checkFilename(objectname + ".xml")) {
97  tracker.loadConfigFile(objectname + ".xml");
98  tracker.getCameraParameters(cam);
99  usexml = true;
100  }
101 #endif
102  if (!usexml) {
103  vpMe me;
104  me.setMaskSize(5);
105  me.setMaskNumber(180);
106  me.setRange(7);
108  me.setThreshold(20);
109  me.setMu1(0.5);
110  me.setMu2(0.5);
111  me.setSampleStep(4);
112  me.setNbTotalSample(250);
113  tracker.setMovingEdge(me);
114  cam.initPersProjWithoutDistortion(547, 542, 339, 235);
115  tracker.setCameraParameters(cam);
116  tracker.setAngleAppear(vpMath::rad(89));
117  tracker.setAngleDisappear(vpMath::rad(89));
118  tracker.setNearClippingDistance(0.01);
119  tracker.setFarClippingDistance(10.0);
121  }
122 
123  tracker.setOgreVisibilityTest(false);
124  if (vpIoTools::checkFilename(objectname + ".cao")) {
125  tracker.loadModel(objectname + ".cao");
126  }
127  else if (vpIoTools::checkFilename(objectname + ".wrl")) {
128  tracker.loadModel(objectname + ".wrl");
129  }
130  tracker.setDisplayFeatures(true);
132 
134  vpKeyPoint keypoint_learning("ORB", "ORB", "BruteForce-Hamming");
135 #if ((VISP_HAVE_OPENCV_VERSION < 0x050000) && defined(HAVE_OPENCV_FEATURES2D)) || ((VISP_HAVE_OPENCV_VERSION >= 0x050000) && defined(HAVE_OPENCV_FEATURES))
136 #if (VISP_HAVE_OPENCV_VERSION < 0x030000)
137  keypoint_learning.setDetectorParameter("ORB", "nLevels", 1);
138 #else
139  cv::Ptr<cv::ORB> orb_learning = keypoint_learning.getDetector("ORB").dynamicCast<cv::ORB>();
140  if (orb_learning) {
141  orb_learning->setNLevels(1);
142  }
143 #endif
144 #endif
146 
147  /*
148  * Start the part of the code dedicated to object learning from 3 images
149  */
150  std::string imageName[] = { "cube0001.png", "cube0150.png", "cube0200.png" };
151  vpHomogeneousMatrix initPoseTab[] = {
152  vpHomogeneousMatrix(0.02143385294, 0.1098083886, 0.5127439561, 2.087159614, 1.141775176, -0.4701291124),
153  vpHomogeneousMatrix(0.02651282185, -0.03713587374, 0.6873765919, 2.314744454, 0.3492296488, -0.1226054828),
154  vpHomogeneousMatrix(0.02965448956, -0.07283091786, 0.7253526051, 2.300529617, -0.4286674806, 0.1788761025) };
155  for (int i = 0; i < 3; i++) {
156  vpImageIo::read(I, imageName[i]);
157  if (i == 0) {
158 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
159  display = vpDisplayFactory::createDisplay(I, 10, 10);
160 #else
161  display = vpDisplayFactory::allocateDisplay(I, 10, 10);
162 #endif
163  }
164  std::stringstream title;
165  title << "Learning cube on image: " << imageName[i];
166  vpDisplay::setTitle(I, title.str().c_str());
167 
169 
171  tracker.setPose(I, initPoseTab[i]);
173 
175  tracker.track(I);
177 
179  tracker.getPose(cMo);
180  tracker.display(I, cMo, cam, vpColor::red);
182 
184  learnCube(I, tracker, keypoint_learning, i);
186 
187  vpDisplay::displayText(I, 10, 10, "Learning step: keypoints are detected on visible cube faces", vpColor::red);
188  if (i < 2) {
189  vpDisplay::displayText(I, 30, 10, "Click to continue the learning...", vpColor::red);
190  }
191  else {
192  vpDisplay::displayText(I, 30, 10, "Click to continue with the detection...", vpColor::red);
193  }
194 
195  vpDisplay::flush(I);
196  vpDisplay::getClick(I, true);
197  }
198 
200  keypoint_learning.saveLearningData("cube_learning_data.bin", true);
202 
203  /*
204  * Start the part of the code dedicated to detection and localization
205  */
207  vpKeyPoint keypoint_detection("ORB", "ORB", "BruteForce-Hamming");
208 #if ((VISP_HAVE_OPENCV_VERSION < 0x050000) && defined(HAVE_OPENCV_FEATURES2D)) || ((VISP_HAVE_OPENCV_VERSION >= 0x050000) && defined(HAVE_OPENCV_FEATURES))
209 #if (VISP_HAVE_OPENCV_VERSION < 0x030000)
210  keypoint_detection.setDetectorParameter("ORB", "nLevels", 1);
211 #else
212  cv::Ptr<cv::ORB> orb_detector = keypoint_detection.getDetector("ORB").dynamicCast<cv::ORB>();
213  orb_detector = keypoint_detection.getDetector("ORB").dynamicCast<cv::ORB>();
214  if (orb_detector) {
215  orb_detector->setNLevels(1);
216  }
217 #endif
218 #endif
220 
222  keypoint_detection.loadLearningData("cube_learning_data.bin", true);
224 
226  vpImage<unsigned char> IMatching;
227  keypoint_detection.createImageMatching(I, IMatching);
229 
230  vpVideoReader g;
231  g.setFileName(videoname);
232  g.open(I);
233 
234 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
235  display2 = vpDisplayFactory::createDisplay(IMatching, 50, 50, "Display matching between learned and current images");
236 #else
237  display2 = vpDisplayFactory::allocateDisplay(IMatching, 50, 50, "Display matching between learned and current images");
238 #endif
239  vpDisplay::setTitle(I, "Cube detection and localization");
240 
241  double error;
242  bool click_done = false;
243 
244  while (!g.end()) {
245  g.acquire(I);
247 
249  keypoint_detection.insertImageMatching(I, IMatching);
251 
252  vpDisplay::display(IMatching);
253  vpDisplay::displayText(I, 10, 10, "Detection and localization in process...", vpColor::red);
254 
255  double elapsedTime;
257  if (keypoint_detection.matchPoint(I, cam, cMo, error, elapsedTime)) {
259 
261  tracker.setPose(I, cMo);
263 
265  tracker.display(I, cMo, cam, vpColor::red, 2);
266  vpDisplay::displayFrame(I, cMo, cam, 0.05, vpColor::none, 3);
268 
269  keypoint_detection.displayMatching(I, IMatching);
270 
272  std::vector<vpImagePoint> ransacInliers = keypoint_detection.getRansacInliers();
273  std::vector<vpImagePoint> ransacOutliers = keypoint_detection.getRansacOutliers();
275 
277  for (std::vector<vpImagePoint>::const_iterator it = ransacInliers.begin(); it != ransacInliers.end(); ++it) {
279  vpImagePoint imPt(*it);
280  imPt.set_u(imPt.get_u() + I.getWidth());
281  imPt.set_v(imPt.get_v() + I.getHeight());
282  vpDisplay::displayCircle(IMatching, imPt, 4, vpColor::green);
283  }
285 
287  for (std::vector<vpImagePoint>::const_iterator it = ransacOutliers.begin(); it != ransacOutliers.end(); ++it) {
289  vpImagePoint imPt(*it);
290  imPt.set_u(imPt.get_u() + I.getWidth());
291  imPt.set_v(imPt.get_v() + I.getHeight());
292  vpDisplay::displayCircle(IMatching, imPt, 4, vpColor::red);
293  }
295 
297  keypoint_detection.displayMatching(I, IMatching);
299 
301  vpCameraParameters cam2;
302  cam2.initPersProjWithoutDistortion(cam.get_px(), cam.get_py(), cam.get_u0() + I.getWidth(),
303  cam.get_v0() + I.getHeight());
304  tracker.setCameraParameters(cam2);
305  tracker.setPose(IMatching, cMo);
306  tracker.display(IMatching, cMo, cam2, vpColor::red, 2);
307  vpDisplay::displayFrame(IMatching, cMo, cam2, 0.05, vpColor::none, 3);
309  }
310 
311  vpDisplay::flush(I);
312  vpDisplay::displayText(IMatching, 30, 10, "A click to exit.", vpColor::red);
313  vpDisplay::flush(IMatching);
314  if (vpDisplay::getClick(I, false)) {
315  click_done = true;
316  break;
317  }
318  if (vpDisplay::getClick(IMatching, false)) {
319  click_done = true;
320  break;
321  }
322  }
323 
324  if (!click_done)
325  vpDisplay::getClick(IMatching);
326  }
327  catch (const vpException &e) {
328  std::cout << "Catch an exception: " << e << std::endl;
329  }
330 #if (VISP_CXX_STANDARD < VISP_CXX_STANDARD_11)
331  if (display != nullptr) {
332  delete display;
333  }
334 
335  if (display2 != nullptr) {
336  delete display2;
337  }
338 #endif
339 #else
340  (void)argc;
341  (void)argv;
342  std::cout << "Install OpenCV and rebuild ViSP to use this example." << std::endl;
343 #endif
344 
345  return EXIT_SUCCESS;
346  }
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
static const vpColor green
Definition: vpColor.h:201
Class that defines generic functionalities for display.
Definition: vpDisplay.h:178
static bool getClick(const vpImage< unsigned char > &I, bool blocking=true)
static void displayCircle(const vpImage< unsigned char > &I, const vpImageCircle &circle, const vpColor &color, bool fill=false, unsigned int thickness=1)
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 displayCross(const vpImage< unsigned char > &I, const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1)
static void setTitle(const vpImage< unsigned char > &I, const std::string &windowtitle)
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 void read(vpImage< unsigned char > &I, const std::string &filename, int backend=IO_DEFAULT_BACKEND)
Definition: vpImageIo.cpp:147
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82
unsigned int getWidth() const
Definition: vpImage.h:242
unsigned int getHeight() const
Definition: vpImage.h:181
static bool checkFilename(const std::string &filename)
Definition: vpIoTools.cpp:786
static std::string getNameWE(const std::string &pathname)
Definition: vpIoTools.cpp:1227
static std::string getParent(const std::string &pathname)
Definition: vpIoTools.cpp:1314
Class that allows keypoints 2D features detection (and descriptors extraction) and matching thanks to...
Definition: vpKeyPoint.h:267
void detect(const vpImage< unsigned char > &I, std::vector< cv::KeyPoint > &keyPoints, const vpRect &rectangle=vpRect())
Definition: vpKeyPoint.cpp:989
static void compute3DForPointsInPolygons(const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, std::vector< cv::KeyPoint > &candidates, const std::vector< vpPolygon > &polygons, const std::vector< std::vector< vpPoint > > &roisPt, std::vector< cv::Point3f > &points, cv::Mat *descriptors=nullptr)
Definition: vpKeyPoint.cpp:481
void saveLearningData(const std::string &filename, bool binaryMode=false, bool saveTrainingImages=true)
unsigned int buildReference(const vpImage< unsigned char > &I)
Definition: vpKeyPoint.cpp:211
cv::Ptr< cv::FeatureDetector > getDetector(const vpFeatureDetectorType &type) const
Definition: vpKeyPoint.h:1091
static double rad(double deg)
Definition: vpMath.h:129
Real-time 6D object pose tracking using its CAD model.
virtual void setCameraParameters(const vpCameraParameters &camera) VP_OVERRIDE
virtual void setOgreVisibilityTest(const bool &v) VP_OVERRIDE
virtual std::pair< std::vector< vpPolygon >, std::vector< std::vector< vpPoint > > > getPolygonFaces(bool orderPolygons=true, bool useVisibility=true, bool clipPolygon=false) VP_OVERRIDE
virtual void setDisplayFeatures(bool displayF) VP_OVERRIDE
virtual void getCameraParameters(vpCameraParameters &camera) const VP_OVERRIDE
virtual void getPose(vpHomogeneousMatrix &cMo) const VP_OVERRIDE
virtual void setMovingEdge(const vpMe &me)
virtual void setAngleDisappear(const double &a) VP_OVERRIDE
virtual void track(const vpImage< unsigned char > &I) VP_OVERRIDE
virtual void loadModel(const std::string &modelFile, bool verbose=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix()) VP_OVERRIDE
virtual void getClipping(unsigned int &clippingFlag1, unsigned int &clippingFlag2) const
virtual void setClipping(const unsigned int &flags) VP_OVERRIDE
virtual void setPose(const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cdMo) VP_OVERRIDE
virtual void setNearClippingDistance(const double &dist) VP_OVERRIDE
virtual void display(const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, unsigned int thickness=1, bool displayFullModel=false) VP_OVERRIDE
virtual void loadConfigFile(const std::string &configFile, bool verbose=true) VP_OVERRIDE
virtual void setAngleAppear(const double &a) VP_OVERRIDE
virtual void setFarClippingDistance(const double &dist) VP_OVERRIDE
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 setNbTotalSample(const int &ntotal_sample)
Definition: vpMe.h:399
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.