util2d.h

/*
Copyright (c) 2010-2025, Mathieu Labbe - IntRoLab - Universite de Sherbrooke
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Universite de Sherbrooke nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef UTIL2D_H_
#define UTIL2D_H_
 
#include <rtabmap/core/rtabmap_core_export.h>
 
#include <opencv2/core/core.hpp>
#include <rtabmap/core/Transform.h>
#include <rtabmap/core/Parameters.h>
#include <rtabmap/core/CameraModel.h>
#include <vector>
 
namespace rtabmap
{
 
namespace util2d
{
 
float RTABMAP_CORE_EXPORT ssd(const cv::Mat & windowLeft, const cv::Mat & windowRight);
 
float RTABMAP_CORE_EXPORT sad(const cv::Mat & windowLeft, const cv::Mat & windowRight);
 
std::vector<cv::Point2f> RTABMAP_CORE_EXPORT calcStereoCorrespondences(
    const cv::Mat & leftImage,
    const cv::Mat & rightImage,
    const std::vector<cv::Point2f> & leftCorners,
    std::vector<unsigned char> & status,
    cv::Size winSize = cv::Size(6,3),
    int maxLevel = 3,
    int iterations = 5,
    float minDisparity = 0.0f,
    float maxDisparity = 64.0f,
    bool ssdApproach = true);
 
void RTABMAP_CORE_EXPORT calcOpticalFlowPyrLKStereo( cv::InputArray _prevImg, cv::InputArray _nextImg,
                           cv::InputArray _prevPts, cv::InputOutputArray _nextPts,
                           cv::OutputArray _status, cv::OutputArray _err,
                           cv::Size winSize = cv::Size(15,3), int maxLevel = 3,
               cv::TermCriteria criteria = cv::TermCriteria(cv::TermCriteria::COUNT+cv::TermCriteria::EPS, 30, 0.01),
               int flags = 0, double minEigThreshold = 1e-4 );
 
cv::Mat RTABMAP_CORE_EXPORT disparityFromStereoImages(
    const cv::Mat & leftImage,
    const cv::Mat & rightImage,
      const ParametersMap & parameters = ParametersMap());
 
cv::Mat RTABMAP_CORE_EXPORT depthFromDisparity(const cv::Mat & disparity,
    float fx, float baseline,
    int type = CV_32FC1); // CV_32FC1 or CV_16UC1
 
cv::Mat RTABMAP_CORE_EXPORT depthFromStereoImages(
    const cv::Mat & leftImage,
    const cv::Mat & rightImage,
    const std::vector<cv::Point2f> & leftCorners,
    float fx,
    float baseline,
    int flowWinSize = 9,
    int flowMaxLevel = 4,
    int flowIterations = 20,
    double flowEps = 0.02);
 
cv::Mat RTABMAP_CORE_EXPORT disparityFromStereoCorrespondences(
    const cv::Size & disparitySize,
    const std::vector<cv::Point2f> & leftCorners,
    const std::vector<cv::Point2f> & rightCorners,
    const std::vector<unsigned char> & mask);
 
cv::Mat RTABMAP_CORE_EXPORT depthFromStereoCorrespondences(
    const cv::Mat & leftImage,
    const std::vector<cv::Point2f> & leftCorners,
    const std::vector<cv::Point2f> & rightCorners,
    const std::vector<unsigned char> & mask,
    float fx, float baseline);
 
cv::Mat RTABMAP_CORE_EXPORT cvtDepthFromFloat(const cv::Mat & depth32F);
 
cv::Mat RTABMAP_CORE_EXPORT cvtDepthToFloat(const cv::Mat & depth16U);
 
float RTABMAP_CORE_EXPORT getDepth(
    const cv::Mat & depthImage,
    float x, float y,
    bool smoothing,
    float depthErrorRatio = 0.02f, //ratio
    bool estWithNeighborsIfNull = false);
 
cv::Rect RTABMAP_CORE_EXPORT computeRoi(const cv::Mat & image, const std::string & roiRatios);
 
cv::Rect RTABMAP_CORE_EXPORT computeRoi(const cv::Size & imageSize, const std::string & roiRatios);
 
cv::Rect RTABMAP_CORE_EXPORT computeRoi(const cv::Mat & image, const std::vector<float> & roiRatios);
 
cv::Rect RTABMAP_CORE_EXPORT computeRoi(const cv::Size & imageSize, const std::vector<float> & roiRatios);
 
 
cv::Mat RTABMAP_CORE_EXPORT decimate(const cv::Mat & image, int d);
 
cv::Mat RTABMAP_CORE_EXPORT interpolate(const cv::Mat & image, int factor, float depthErrorRatio = 0.02f);
 
cv::Mat RTABMAP_CORE_EXPORT registerDepth(
    const cv::Mat & depth,
    const cv::Mat & depthK,
    const cv::Size & colorSize,
    const cv::Mat & colorK,
    const rtabmap::Transform & transform);
cv::Mat RTABMAP_CORE_EXPORT registerDepth(
  const cv::Mat & depth,
  const cv::Mat & confidence,
  const cv::Mat & depthK,
  const cv::Size & colorSize,
  const cv::Mat & colorK,
  const rtabmap::Transform & transform,
  cv::Mat & registeredConfidence);
 
cv::Mat RTABMAP_CORE_EXPORT fillDepthHoles(
    const cv::Mat & depth,
    int maximumHoleSize = 1,
    float errorRatio = 0.02f);
 
void RTABMAP_CORE_EXPORT fillRegisteredDepthHoles(
    cv::Mat & depthRegistered,
    bool vertical,
    bool horizontal,
    bool fillDoubleHoles = false);
 
cv::Mat RTABMAP_CORE_EXPORT fastBilateralFiltering(
    const cv::Mat & depth,
    float sigmaS = 15.0f,
    float sigmaR = 0.05f,
    bool earlyDivision = false);
 
void RTABMAP_CORE_EXPORT depthBleedingFiltering(
  cv::Mat & depth,
  float maxDepthError);
 
cv::Mat RTABMAP_CORE_EXPORT brightnessAndContrastAuto(
    const cv::Mat & src,
    const cv::Mat & mask,
    float clipLowHistPercent=0,
    float clipHighHistPercent=0,
    float * alphaOut = 0,
    float * betaOut = 0);
 
cv::Mat RTABMAP_CORE_EXPORT exposureFusion(
  const std::vector<cv::Mat> & images);
 
void RTABMAP_CORE_EXPORT HSVtoRGB( float *r, float *g, float *b, float h, float s, float v );
 
void RTABMAP_CORE_EXPORT NMS(
    const std::vector<cv::KeyPoint> & ptsIn,
    const cv::Mat & descriptorsIn,
    std::vector<cv::KeyPoint> & ptsOut,
    cv::Mat & descriptorsOut,
    int dist_thresh, int img_width, int img_height);
 
std::vector<int> RTABMAP_CORE_EXPORT SSC(
  const std::vector<cv::KeyPoint> & keypoints,
  int maxKeypoints,
  float tolerance,
  int cols,
  int rows,
  const std::vector<int> & indx = {});
 
bool RTABMAP_CORE_EXPORT rotateImagesUpsideUpIfNecessary(
  CameraModel & model,
  cv::Mat & rgb,
  cv::Mat & depth);
 
} // namespace util2d
} // namespace rtabmap
 
#endif /* UTIL2D_H_ */