pose_optimize.hpp

Go to the documentation of this file.

// Copyright 2015, Philipp Zabel
// Copyright 2020-2023
// Copyright 2026, Beyley Cardellio
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  RANSAC PnP pose refinement
 * @author Philipp Zabel <philipp.zabel@gmail.com>
 * @author Jan Schmidt <jan@centricular.com>
 * @author Beyley Cardellio <ep1cm1n10n123@gmail.com>
 * @ingroup tracking
 */
 
#pragma once
 
#include "xrt/xrt_config_have.h"
#include "xrt/xrt_defines.h"
 
#include "tracking/t_constellation.h"
 
#include "constellation/camera_model.h"
 
 
namespace xrt::tracking::constellation::optimizer {
 
enum class PoseStateIndex : int
{
        // Pos
        PosX = 0,
        PosY = 1,
        PosZ = 2,
 
        // Quat (must match xrt_quat/Eigen ordering)
        RotX = 3,
        RotY = 4,
        RotZ = 5,
        RotW = 6,
 
        NumIndices,
};
 
constexpr int kPoseStateSize = static_cast<int>(PoseStateIndex::NumIndices);
 
enum class CovarianceIndex : int
{
        PosX = 0,
        PosY = 1,
        PosZ = 2,
 
        RotX = 3,
        RotY = 4,
        RotZ = 5,
 
        NumIndices,
};
 
constexpr int kPoseCovarianceSize = static_cast<int>(CovarianceIndex::NumIndices);
 
// Same format as an Eigen::Matrix<double, 6, 6>.
typedef double RawPoseCovarianceMatrix[kPoseCovarianceSize * kPoseCovarianceSize];
 
/*!
 * Does a pose optimization and RANSAC refinement on the given blobs and LED model, returning the optimized pose and
 * covariance.
 *
 * @param log_level           The logging level to use for debug output.
 * @param params              The camera model parameters.
 * @param init_pose           The initial pose estimate to start the optimization from.
 * @param blobs               The array of blobs to use for the optimization, will write to here to unmark outliers.
 * @param num_blobs           The number of blobs in the array.
 * @param leds_model          The LED model to use for the optimization.
 * @param device_id           The device ID to optimize the pose for.
 * @param[out] out_pose       The optimized pose will be written to this variable.
 * @param[out] out_covariance The covariance of the final pose will be written to this variable, if not nullptr.
 * @param[out] out_whitening  The whitening matrix of the pose, must be non-nullptr if out_covariance is set.
 *
 * @return true if the optimization was successful, false otherwise.
 */
bool
optimizePose(u_logging_level log_level,
             bool deterministic,
             const t_camera_model_params &params,
             xrt_pose init_pose,
             t_blob *blobs,
             uint32_t num_blobs,
             t_constellation_tracker_led_model *leds_model,
             t_constellation_device_id_t device_id,
             xrt_pose &out_pose,
             RawPoseCovarianceMatrix out_covariance,
             RawPoseCovarianceMatrix out_whitening);
 
/*!
 * Computes the covariance of a pose given the initial pose, blobs, and LED model.
 *
 * @param log_level           The logging level to use for debug output.
 * @param params              The camera model parameters.
 * @param init_pose           The initial pose estimate to start the optimization from.
 * @param blobs               The array of blobs to use for the optimization.
 * @param num_blobs           The number of blobs in the array.
 * @param leds_model          The LED model to use for the optimization.
 * @param device_id           The device ID to compute the covariance for.
 * @param[out] out_covariance The covariance of the final pose will be written to this variable.
 * @param[out] out_whitening  The whitening matrix of the pose, must be non-nullptr if out_covariance is set.
 *
 * @return void
 */
void
computePoseCovariance(u_logging_level log_level,
                      const t_camera_model_params &params,
                      xrt_pose init_pose,
                      t_blob *blobs,
                      uint32_t num_blobs,
                      t_constellation_tracker_led_model *leds_model,
                      t_constellation_device_id_t device_id,
                      RawPoseCovarianceMatrix out_covariance,
                      RawPoseCovarianceMatrix out_whitening);
 
/*!
 * Computes the radii and covariance orientation from the 3x3 position part of the pose covariance matrix
 * (3x eigenvalue, so 99%-ish probability containment).
 *
 * @param raw_covariance The raw pose covariance matrix to compute the radii and orientation from.
 * @param[out] radii     The radii of the position covariance will be written to this variable.
 * @param[out] Q_cam_cov The orientation of the covariance will be written to this variable.
 */
void
covariancePositionRadius(const RawPoseCovarianceMatrix &raw_covariance, xrt_vec3 &radii, xrt_quat &Q_cam_cov);
 
}; // namespace xrt::tracking::constellation::optimizer