vpMbtFaceDepthDense.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Manage depth dense features for a particular face.
 */
 
#ifndef VP_MBT_FACE_DEPTH_DENSE_H
#define VP_MBT_FACE_DEPTH_DENSE_H
 
#include <iostream>
 
#include <visp3/core/vpConfig.h>
#if defined(VISP_HAVE_PCL) && defined(VISP_HAVE_PCL_COMMON)
#include <pcl/point_cloud.h>
#include <pcl/point_types.h>
#endif
 
#include <visp3/core/vpPlane.h>
#include <visp3/mbt/vpMbTracker.h>
#include <visp3/mbt/vpMbtDistanceLine.h>
 
#define DEBUG_DISPLAY_DEPTH_DENSE 0
 
BEGIN_VISP_NAMESPACE
  class VISP_EXPORT vpMbtFaceDepthDense
{
public:
  enum vpDepthDenseFilteringType
  {
    NO_FILTERING = 0,                         
    DEPTH_OCCUPANCY_RATIO_FILTERING = 1 << 1, 
    MIN_DISTANCE_FILTERING = 1 << 2,          
    MAX_DISTANCE_FILTERING = 1 << 3           
  };

  vpCameraParameters m_cam;
  unsigned int m_clippingFlag;
  double m_distFarClip;
  double m_distNearClip;
  vpMbHiddenFaces<vpMbtPolygon> *m_hiddenFace;
  vpPlane m_planeObject;
  vpMbtPolygon *m_polygon;
  bool m_useScanLine;
 
  vpMbtFaceDepthDense();
  vpMbtFaceDepthDense(const vpMbtFaceDepthDense &mbt_face);
  virtual ~vpMbtFaceDepthDense();
  vpMbtFaceDepthDense &operator=(const vpMbtFaceDepthDense &mbt_face);
 
  void addLine(vpPoint &p1, vpPoint &p2, vpMbHiddenFaces<vpMbtPolygon> *const faces, vpUniRand &rand_gen,
               int polygon = -1, std::string name = "");
 
#if defined(VISP_HAVE_PCL) && defined(VISP_HAVE_PCL_COMMON)
  bool computeDesiredFeatures(const vpHomogeneousMatrix &cMo,
                              const pcl::PointCloud<pcl::PointXYZ>::ConstPtr &point_cloud, unsigned int stepX,
                              unsigned int stepY
#if DEBUG_DISPLAY_DEPTH_DENSE
                              ,
                              vpImage<unsigned char> &debugImage, std::vector<std::vector<vpImagePoint> > &roiPts_vec
#endif
                              ,
                              const vpImage<bool> *mask = nullptr);
#endif
  bool computeDesiredFeatures(const vpHomogeneousMatrix &cMo, unsigned int width, unsigned int height,
                              const std::vector<vpColVector> &point_cloud, unsigned int stepX, unsigned int stepY
#if DEBUG_DISPLAY_DEPTH_DENSE
                              ,
                              vpImage<unsigned char> &debugImage, std::vector<std::vector<vpImagePoint> > &roiPts_vec
#endif
                              ,
                              const vpImage<bool> *mask = nullptr);
  bool computeDesiredFeatures(const vpHomogeneousMatrix &cMo, unsigned int width, unsigned int height,
                              const vpMatrix &point_cloud, unsigned int stepX, unsigned int stepY
#if DEBUG_DISPLAY_DEPTH_DENSE
                              ,
                              vpImage<unsigned char> &debugImage, std::vector<std::vector<vpImagePoint> > &roiPts_vec
#endif
                              ,
                              const vpImage<bool> *mask = nullptr);
 
  void computeInteractionMatrixAndResidu(const vpHomogeneousMatrix &cMo, vpMatrix &L, vpColVector &error);
 
  void computeVisibility();
  void computeVisibilityDisplay();
 
  void display(const vpImage<unsigned char> &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam,
               const vpColor &col, unsigned int thickness = 1, bool displayFullModel = false);
  void display(const vpImage<vpRGBa> &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam,
               const vpColor &col, unsigned int thickness = 1, bool displayFullModel = false);
 
  void displayFeature(const vpImage<unsigned char> &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam,
                      double scale = 0.05, unsigned int thickness = 1);
  void displayFeature(const vpImage<vpRGBa> &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam,
                      double scale = 0.05, unsigned int thickness = 1);
 
  std::vector<std::vector<double> > getModelForDisplay(unsigned int width, unsigned int height,
                                                       const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam,
                                                       bool displayFullModel = false);
 
  inline unsigned int getNbFeatures() const { return static_cast<unsigned int>(m_pointCloudFace.size() / 3); }
 
  inline bool isTracked() const { return m_isTrackedDepthDenseFace; }
 
  inline bool isVisible() const { return m_polygon->isvisible; }
 
  void setCameraParameters(const vpCameraParameters &camera);
 
  void setScanLineVisibilityTest(bool v);
 
  inline void setDepthDenseFilteringMaxDistance(double maxDistance) { m_depthDenseFilteringMaxDist = maxDistance; }
 
  inline void setDepthDenseFilteringMethod(int method) { m_depthDenseFilteringMethod = method; }
 
  inline void setDepthDenseFilteringMinDistance(double minDistance) { m_depthDenseFilteringMinDist = minDistance; }
 
  inline void setDepthDenseFilteringOccupancyRatio(double occupancyRatio)
  {
    if (occupancyRatio < 0.0 || occupancyRatio > 1.0) {
      std::cerr << "occupancyRatio < 0.0 || occupancyRatio > 1.0" << std::endl;
    }
    else {
      m_depthDenseFilteringOccupancyRatio = occupancyRatio;
    }
  }
 
  inline void setTracked(bool tracked) { m_isTrackedDepthDenseFace = tracked; }
 
private:
  class PolygonLine
  {
  public:
    vpPoint *m_p1;
    vpPoint *m_p2;
    vpMbtPolygon m_poly;
    vpImagePoint m_imPt1;
    vpImagePoint m_imPt2;
 
    PolygonLine() : m_p1(nullptr), m_p2(nullptr), m_poly(), m_imPt1(), m_imPt2() { }
 
    PolygonLine(const PolygonLine &polyLine)
      : m_p1(nullptr), m_p2(nullptr), m_poly(polyLine.m_poly), m_imPt1(polyLine.m_imPt1), m_imPt2(polyLine.m_imPt2)
    {
      m_p1 = &m_poly.p[0];
      m_p2 = &m_poly.p[1];
    }
 
    PolygonLine &operator=(PolygonLine other)
    {
      swap(*this, other);
 
      return *this;
    }
 
    void swap(PolygonLine &first, PolygonLine &second)
    {
      using std::swap;
      swap(first.m_p1, second.m_p1);
      swap(first.m_p2, second.m_p2);
      swap(first.m_poly, second.m_poly);
      swap(first.m_imPt1, second.m_imPt1);
      swap(first.m_imPt2, second.m_imPt2);
    }
  };
 
protected:
  int m_depthDenseFilteringMethod;
  double m_depthDenseFilteringMaxDist;
  double m_depthDenseFilteringMinDist;
  double m_depthDenseFilteringOccupancyRatio;
  bool m_isTrackedDepthDenseFace;
  bool m_isVisible;
  std::vector<vpMbtDistanceLine *> m_listOfFaceLines;
  vpPlane m_planeCamera;
  std::vector<double> m_pointCloudFace;
  std::vector<PolygonLine> m_polygonLines;
 
protected:
  void computeROI(const vpHomogeneousMatrix &cMo, unsigned int width, unsigned int height,
                  std::vector<vpImagePoint> &roiPts
#if DEBUG_DISPLAY_DEPTH_DENSE
                  ,
                  std::vector<std::vector<vpImagePoint> > &roiPts_vec
#endif
                  ,
                  double &distanceToFace);
 
  bool samePoint(const vpPoint &P1, const vpPoint &P2) const;
};
END_VISP_NAMESPACE
#endif