Visual Servoing Platform  version 3.6.1 under development (2024-07-27)
tutorial-apriltag-detector-live-rgbd-structure-core.cpp
1 #include <visp3/core/vpConfig.h>
3 #ifdef VISP_HAVE_MODULE_SENSOR
4 #include <visp3/sensor/vpOccipitalStructure.h>
5 #endif
7 #include <visp3/detection/vpDetectorAprilTag.h>
9 #include <visp3/core/vpImageConvert.h>
10 #include <visp3/core/vpXmlParserCamera.h>
11 #include <visp3/gui/vpDisplayGDI.h>
12 #include <visp3/gui/vpDisplayOpenCV.h>
13 #include <visp3/gui/vpDisplayX.h>
14 #include <visp3/vision/vpPose.h>
15 
16 int main(int argc, const char **argv)
17 {
19 #if defined(VISP_HAVE_APRILTAG) && defined(VISP_HAVE_OCCIPITAL_STRUCTURE)
21 #ifdef ENABLE_VISP_NAMESPACE
22  using namespace VISP_NAMESPACE_NAME;
23 #endif
24 
27  double tagSize = 0.053;
28  float quad_decimate = 1.0;
29  int nThreads = 1;
30  bool display_tag = false;
31  int color_id = -1;
32  unsigned int thickness = 2;
33  bool align_frame = false;
34 
35 #if !(defined(VISP_HAVE_X11) || defined(VISP_HAVE_GDI) || defined(VISP_HAVE_OPENCV))
36  bool display_off = true;
37  std::cout << "Warning: There is no 3rd party (X11, GDI or openCV) to dislay images..." << std::endl;
38 #else
39  bool display_off = false;
40 #endif
41 
42  for (int i = 1; i < argc; i++) {
43  if (std::string(argv[i]) == "--pose_method" && i + 1 < argc) {
44  poseEstimationMethod = (vpDetectorAprilTag::vpPoseEstimationMethod)atoi(argv[i + 1]);
45  }
46  else if (std::string(argv[i]) == "--tag_size" && i + 1 < argc) {
47  tagSize = atof(argv[i + 1]);
48  }
49  else if (std::string(argv[i]) == "--quad_decimate" && i + 1 < argc) {
50  quad_decimate = (float)atof(argv[i + 1]);
51  }
52  else if (std::string(argv[i]) == "--nthreads" && i + 1 < argc) {
53  nThreads = atoi(argv[i + 1]);
54  }
55  else if (std::string(argv[i]) == "--display_tag") {
56  display_tag = true;
57  }
58  else if (std::string(argv[i]) == "--display_off") {
59  display_off = true;
60  }
61  else if (std::string(argv[i]) == "--color" && i + 1 < argc) {
62  color_id = atoi(argv[i + 1]);
63  }
64  else if (std::string(argv[i]) == "--thickness" && i + 1 < argc) {
65  thickness = (unsigned int)atoi(argv[i + 1]);
66  }
67  else if (std::string(argv[i]) == "--tag_family" && i + 1 < argc) {
68  tagFamily = (vpDetectorAprilTag::vpAprilTagFamily)atoi(argv[i + 1]);
69  }
70  else if (std::string(argv[i]) == "--z_aligned") {
71  align_frame = true;
72  }
73  else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
74  std::cout << "Usage: " << argv[0]
75  << " [--tag_size <tag_size in m> (default: 0.053)]"
76  " [--quad_decimate <quad_decimate> (default: 1)]"
77  " [--nthreads <nb> (default: 1)]"
78  " [--pose_method <method> (0: HOMOGRAPHY, 1: HOMOGRAPHY_VIRTUAL_VS, "
79  " 2: DEMENTHON_VIRTUAL_VS, 3: LAGRANGE_VIRTUAL_VS, "
80  " 4: BEST_RESIDUAL_VIRTUAL_VS, 5: HOMOGRAPHY_ORTHOGONAL_ITERATION) (default: 0)]"
81  " [--tag_family <family> (0: TAG_36h11, 1: TAG_36h10 (DEPRECATED), 2: TAG_36ARTOOLKIT (DEPRECATED),"
82  " 3: TAG_25h9, 4: TAG_25h7 (DEPRECATED), 5: TAG_16h5, 6: TAG_CIRCLE21h7, 7: TAG_CIRCLE49h12,"
83  " 8: TAG_CUSTOM48h12, 9: TAG_STANDARD41h12, 10: TAG_STANDARD52h13) (default: 0)]"
84  " [--display_tag] [--z_aligned]";
85 #if (defined(VISP_HAVE_X11) || defined(VISP_HAVE_GDI) || defined(VISP_HAVE_OPENCV))
86  std::cout << " [--display_off] [--color <color id>] [--thickness <line thickness>]";
87 #endif
88  std::cout << " [--help]" << std::endl;
89  return EXIT_SUCCESS;
90  }
91  }
92 
93  try {
95  std::cout << "Use Occipital Structure grabber" << std::endl;
97  ST::CaptureSessionSettings settings;
98  settings.source = ST::CaptureSessionSourceId::StructureCore;
99  settings.structureCore.visibleEnabled = true;
100  settings.applyExpensiveCorrection = true; // Apply a correction and clean filter to the depth before streaming.
101  unsigned int width = 640, height = 480;
102 
104  vpImage<vpRGBa> I_color(height, width);
105  vpImage<float> I_depth_raw(height, width);
106  vpImage<vpRGBa> I_depth;
107 
108  g.open(settings);
109 
110  std::cout << "I_color: " << I_color.getWidth() << " " << I_color.getHeight() << std::endl;
111  std::cout << "I_depth_raw: " << I_depth_raw.getWidth() << " " << I_depth_raw.getHeight() << std::endl;
112 
113  g.acquire(reinterpret_cast<unsigned char *>(I_color.bitmap), reinterpret_cast<unsigned char *>(I_depth_raw.bitmap));
114 
115  std::cout << "Read camera parameters from Structure core device" << std::endl;
116  vpCameraParameters cam;
119 
120  std::cout << cam << std::endl;
121  std::cout << "poseEstimationMethod: " << poseEstimationMethod << std::endl;
122  std::cout << "tagFamily: " << tagFamily << std::endl;
123  std::cout << "nThreads : " << nThreads << std::endl;
124  std::cout << "Z aligned: " << align_frame << std::endl;
125 
126  vpImage<vpRGBa> I_color2 = I_color;
127  vpImage<float> depthMap;
128  vpImageConvert::createDepthHistogram(I_depth_raw, I_depth);
129 
130  vpDisplay *d1 = nullptr;
131  vpDisplay *d2 = nullptr;
132  vpDisplay *d3 = nullptr;
133  if (!display_off) {
134 #ifdef VISP_HAVE_X11
135  d1 = new vpDisplayX(I_color, 100, 30, "Pose from Homography");
136  d2 = new vpDisplayX(I_color2, I_color.getWidth() + 120, 30, "Pose from RGBD fusion");
137  d3 = new vpDisplayX(I_depth, 100, I_color.getHeight() + 70, "Depth");
138 #elif defined(VISP_HAVE_GDI)
139  d1 = new vpDisplayGDI(I_color, 100, 30, "Pose from Homography");
140  d2 = new vpDisplayGDI(I_color2, I_color.getWidth() + 120, 30, "Pose from RGBD fusion");
141  d3 = new vpDisplayGDI(I_depth, 100, I_color.getHeight() + 70, "Depth");
142 #elif defined(HAVE_OPENCV_HIGHGUI)
143  d1 = new vpDisplayOpenCV(I_color, 100, 30, "Pose from Homography");
144  d2 = new vpDisplayOpenCV(I_color2, I_color.getWidth() + 120, 30, "Pose from RGBD fusion");
145  d3 = new vpDisplayOpenCV(I_depth, 100, I_color.getHeight() + 70, "Depth");
146 #endif
147  }
148 
150  vpDetectorAprilTag detector(tagFamily);
152 
154  detector.setAprilTagQuadDecimate(quad_decimate);
155  detector.setAprilTagPoseEstimationMethod(poseEstimationMethod);
156  detector.setAprilTagNbThreads(nThreads);
157  detector.setDisplayTag(display_tag, color_id < 0 ? vpColor::none : vpColor::getColor(color_id), thickness);
158  detector.setZAlignedWithCameraAxis(align_frame);
160  std::vector<double> time_vec;
161  for (;;) {
162  double t = vpTime::measureTimeMs();
163 
165  g.acquire(reinterpret_cast<unsigned char *>(I_color.bitmap),
166  reinterpret_cast<unsigned char *>(I_depth_raw.bitmap));
168 
169  I_color2 = I_color;
170  vpImageConvert::convert(I_color, I);
171  vpImageConvert::createDepthHistogram(I_depth_raw, I_depth);
172 
173  depthMap.resize(I_depth_raw.getHeight(), I_depth_raw.getWidth());
174 #ifdef VISP_HAVE_OPENMP
175 #pragma omp parallel for
176 #endif
177  for (unsigned int i = 0; i < I_depth_raw.getHeight(); i++) {
178  for (unsigned int j = 0; j < I_depth_raw.getWidth(); j++) {
179  if (!vpMath::isNaN(I_depth_raw[i][j])) {
180  float Z = I_depth_raw[i][j] * 0.001; // Transform depth to meters.
181  depthMap[i][j] = Z;
182  }
183  else {
184  depthMap[i][j] = 0;
185  }
186  }
187  }
188 
189  vpDisplay::display(I_color);
190  vpDisplay::display(I_color2);
191  vpDisplay::display(I_depth);
192 
193  std::vector<vpHomogeneousMatrix> cMo_vec;
194  detector.detect(I, tagSize, cam, cMo_vec);
195 
196  // Display camera pose for each tag
197  for (size_t i = 0; i < cMo_vec.size(); i++) {
198  vpDisplay::displayFrame(I_color, cMo_vec[i], cam, tagSize / 2, vpColor::none, 3);
199  }
200 
202  std::vector<std::vector<vpImagePoint> > tags_corners = detector.getPolygon();
203  std::vector<int> tags_id = detector.getTagsId();
204  std::map<int, double> tags_size;
205  tags_size[-1] = tagSize; // Default tag size
206  std::vector<std::vector<vpPoint> > tags_points3d = detector.getTagsPoints3D(tags_id, tags_size);
207  for (size_t i = 0; i < tags_corners.size(); i++) {
209  double confidence_index;
210  if (vpPose::computePlanarObjectPoseFromRGBD(depthMap, tags_corners[i], cam, tags_points3d[i], cMo,
211  &confidence_index)) {
212  if (confidence_index > 0.5) {
213  vpDisplay::displayFrame(I_color2, cMo, cam, tagSize / 2, vpColor::none, 3);
214  }
215  else if (confidence_index > 0.25) {
216  vpDisplay::displayFrame(I_color2, cMo, cam, tagSize / 2, vpColor::orange, 3);
217  }
218  else {
219  vpDisplay::displayFrame(I_color2, cMo, cam, tagSize / 2, vpColor::red, 3);
220  }
221  std::stringstream ss;
222  ss << "Tag id " << tags_id[i] << " confidence: " << confidence_index;
223  vpDisplay::displayText(I_color2, 35 + i * 15, 20, ss.str(), vpColor::red);
224  }
225  }
227 
228  vpDisplay::displayText(I_color, 20, 20, "Pose from homography + VVS", vpColor::red);
229  vpDisplay::displayText(I_color2, 20, 20, "Pose from RGBD fusion", vpColor::red);
230  vpDisplay::displayText(I_color, 35, 20, "Click to quit.", vpColor::red);
231  t = vpTime::measureTimeMs() - t;
232  time_vec.push_back(t);
233 
234  std::stringstream ss;
235  ss << "Detection time: " << t << " ms for " << detector.getNbObjects() << " tags";
236  vpDisplay::displayText(I_color, 50, 20, ss.str(), vpColor::red);
237 
238  if (vpDisplay::getClick(I_color, false))
239  break;
240 
241  vpDisplay::flush(I_color);
242  vpDisplay::flush(I_color2);
243  vpDisplay::flush(I_depth);
244  }
245 
246  std::cout << "Benchmark loop processing time" << std::endl;
247  std::cout << "Mean / Median / Std: " << vpMath::getMean(time_vec) << " ms"
248  << " ; " << vpMath::getMedian(time_vec) << " ms"
249  << " ; " << vpMath::getStdev(time_vec) << " ms" << std::endl;
250 
251  if (!display_off) {
252  delete d1;
253  delete d2;
254  delete d3;
255  }
256 
257  }
258  catch (const vpException &e) {
259  std::cerr << "Catch an exception: " << e.getMessage() << std::endl;
260  }
261 
262  return EXIT_SUCCESS;
263 #else
264  (void)argc;
265  (void)argv;
266 #ifndef VISP_HAVE_APRILTAG
267  std::cout << "Enable Apriltag support, configure and build ViSP to run this tutorial" << std::endl;
268 #else
269  std::cout << "Install Structure Core SDK, configure and build ViSP again to use this example" << std::endl;
270 #endif
271 #endif
272  return EXIT_SUCCESS;
273 }
Generic class defining intrinsic camera parameters.
@ perspectiveProjWithoutDistortion
Perspective projection without distortion model.
static vpColor getColor(const unsigned int &i)
Definition: vpColor.h:311
static const vpColor red
Definition: vpColor.h:217
static const vpColor none
Definition: vpColor.h:229
static const vpColor orange
Definition: vpColor.h:227
@ TAG_36h11
AprilTag 36h11 pattern (recommended)
Display for windows using GDI (available on any windows 32 platform).
Definition: vpDisplayGDI.h:130
The vpDisplayOpenCV allows to display image using the OpenCV library. Thus to enable this class OpenC...
Use the X11 console to display images on unix-like OS. Thus to enable this class X11 should be instal...
Definition: vpDisplayX.h:135
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
const char * getMessage() const
Definition: vpException.cpp:65
Implementation of an homogeneous matrix and operations on such kind of matrices.
static void createDepthHistogram(const vpImage< uint16_t > &src_depth, vpImage< vpRGBa > &dest_rgba)
static void convert(const vpImage< unsigned char > &src, vpImage< vpRGBa > &dest)
void resize(unsigned int h, unsigned int w)
resize the image : Image initialization
Definition: vpImage.h:538
static bool isNaN(double value)
Definition: vpMath.cpp:92
static double getMedian(const std::vector< double > &v)
Definition: vpMath.cpp:322
static double getStdev(const std::vector< double > &v, bool useBesselCorrection=false)
Definition: vpMath.cpp:353
static double getMean(const std::vector< double > &v)
Definition: vpMath.cpp:302
vpCameraParameters getCameraParameters(const vpOccipitalStructureStream stream_type, vpCameraParameters::vpCameraParametersProjType type=vpCameraParameters::perspectiveProjWithoutDistortion)
void acquire(vpImage< unsigned char > &gray, bool undistorted=false, double *ts=nullptr)
bool open(const ST::CaptureSessionSettings &settings)
static bool computePlanarObjectPoseFromRGBD(const vpImage< float > &depthMap, const std::vector< vpImagePoint > &corners, const vpCameraParameters &colorIntrinsics, const std::vector< vpPoint > &point3d, vpHomogeneousMatrix &cMo, double *confidence_index=nullptr)
Definition: vpPoseRGBD.cpp:158
VISP_EXPORT double measureTimeMs()