factorCameraProj3dPoint.hpp

/* Copyright (c) 2022, Gonzalo Ferrer
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 *
 * factorCameraProj3dPoint.hpp
 *
 *  Created on: March 13, 2023
 *      Author: Gonzalo Ferrer
 *              g.ferrer@skoltech.ru
 *              Mobile Robotics Lab, Skoltech
 */

#ifndef FACTORCAMERAPROJ3DPOINT_HPP_
#define FACTORCAMERAPROJ3DPOINT_HPP_


#include "mrob/matrix_base.hpp"
#include "mrob/SE3.hpp" //requires including and linking SE3 library
#include "mrob/factor.hpp"

namespace mrob{

class FactorCameraProj3dPoint : public Factor
{
  public:
    FactorCameraProj3dPoint(const Mat21 &observation, std::shared_ptr<Node> &nodePose,
            std::shared_ptr<Node> &nodeLandmark,
            const Mat41 &camera_k,
            const Mat2 &obsInf = Mat2::Identity(),
            Factor::robustFactorType robust_type = Factor::robustFactorType::QUADRATIC);
    ~FactorCameraProj3dPoint() override = default;
    void evaluate_residuals() override;
    void evaluate_jacobians() override;
    void evaluate_chi2() override;

    void print() const;

    MatRefConst get_obs() const {return obs_;};
    VectRefConst get_residual() const {return r_;};
    MatRefConst get_information_matrix() const {return W_;};
    MatRefConst get_jacobian([[maybe_unused]] mrob::factor_id_t id = 0) const {return J_;};

  protected:
    Mat21 obs_, r_; // Assumes this observations has been undistorted
    Mat31 landmark_, local_point_;
    Mat41 camera_k_; // This encodes [fx, fy, cx, cy]
    SE3 Tinv_;
    Mat2 W_;//inverse of observation covariance (information matrix)
    Mat<2,9> J_;//Joint Jacobian: 6 (pose) + 3(pint) || + 4 (K)
    bool reversedNodeOrder_;//flag to keep order when building the adjacency matrix. This should be transparent for the user

    //project_point in 3D to 2D by the camera parameters in this class
    //TODO, maybe move projective methods all together? this can be used in many other places in visual
    Mat21 project_point(const Mat31 point);

  public:
    EIGEN_MAKE_ALIGNED_OPERATOR_NEW // as proposed by Eigen

};


}




#endif /* FACTORCAMERAPROJ3DPOINT_HPP_ */