expose-explog.cpp

Go to the documentation of this file.

//
// Copyright (c) 2015-2021 CNRS INRIA
// Copyright (c) 2015 Wandercraft, 86 rue de Paris 91400 Orsay, France.
//
 
#include <boost/python.hpp>
 
#include "pinocchio/bindings/python/context.hpp"
#include "pinocchio/bindings/python/spatial/explog.hpp"
 
namespace pinocchio
{
  namespace python
  {
    namespace bp = boost::python;
 
    void exposeExplog()
    {
 
      bp::def(
        "exp3", &exp3_proxy<context::Vector3s>, bp::arg("w"),
        "Exp: so3 -> SO3. Return the integral of the input"
        " vector w during time 1. This is also known as the Rodrigues formula.");
 
      bp::def(
        "exp3_quat", &exp3_proxy_quat<context::Vector3s>, bp::arg("w"),
        "Exp: so3 -> S3. Returns the integral of the input vector w during time 1, represented "
        "as a unit Quaternion.");
 
      bp::def(
        "Jexp3", &Jexp3_proxy<context::Vector3s>, bp::arg("w"),
        "Jacobian of exp(v) which maps from the tangent of SO(3) at R = exp(v) to"
        " the tangent of SO(3) at Identity.");
 
      bp::def(
        "log3", &log3_proxy<context::Matrix3s>, bp::arg("R"),
        "Log: SO3 -> so3 is the pseudo-inverse of Exp: so3 -> SO3. Log maps from SO3"
        " -> { v in so3, ||v|| < 2pi }.");
 
      bp::def(
        "log3", &log3_proxy<context::Matrix3s, context::Matrix1s>, bp::args("R", "theta"),
        "Log: SO3 -> so3 is the pseudo-inverse of Exp: so3 -> SO3. Log maps from SO3"
        " -> { v in so3, ||v|| < 2pi }.\n"
        "It also returns the angle of rotation theta around the rotation axis.");
 
      bp::def(
        "log3", &log3_proxy_fix<context::Matrix3s, context::Scalar>, bp::args("R", "theta"),
        "Log: SO3 -> so3 is the pseudo-inverse of Exp: so3 -> SO3. Log maps from SO3"
        " -> { v in so3, ||v|| < 2pi }.\n"
        "It also returns the angle of rotation theta around the rotation axis.");
 
      bp::def(
        "log3", &log3_proxy<context::Quaternion>, bp::args("quat"),
        "Log: S^3 -> so3 is the pseudo-inverse of Exp: so3 -> S^3, the exponential map from "
        "so3 to the unit"
        " quaternions. It maps from S^3 -> { v in so3, ||v|| < 2pi }.");
 
      bp::def(
        "log3", &log3_proxy_quatvec<context::Vector4s>, bp::args("quat"),
        "Log: S^3 -> so3 is the pseudo-inverse of Exp: so3 -> S^3, the exponential map from "
        "so3 to the unit"
        " quaternions. It maps from S^3 -> { v in so3, ||v|| < 2pi }.");
 
      bp::def(
        "log3", &log3_proxy_quatvec<context::Vector4s, context::Matrix1s>,
        bp::args("quat", "theta"),
        "Log: S^3 -> so3 is the pseudo-inverse of Exp: so3 -> S^3, the exponential map from "
        "so3 to the unit"
        " quaternions. It maps from S^3 -> { v in so3, ||v|| < 2pi }.\n"
        "It also returns the angle of rotation theta around the rotation axis.");
 
      bp::def(
        "log3", &log3_proxy_quatvec_fix<context::Vector4s, context::Scalar>,
        bp::args("quat", "theta"),
        "Log: S^3 -> so3 is the pseudo-inverse of Exp: so3 -> S^3, the exponential map from "
        "so3 to the unit"
        " quaternions. It maps from S^3 -> { v in so3, ||v|| < 2pi }.\n"
        "It also returns the angle of rotation theta around the rotation axis.");
 
      bp::def(
        "Jlog3", &Jlog3_proxy<context::Matrix3s>, bp::arg("R"),
        "Jacobian of log(R) which maps from the tangent of SO(3) at R to"
        " the tangent of SO(3) at Identity.");
 
      bp::def(
        "Hlog3", &Hlog3_proxy<Eigen::Matrix3d, Eigen::Vector3d>, bp::args("R", "v"),
        "Vector v to be multiplied to the hessian", "v^T * H where H is the Hessian of log(R)");
 
      bp::def(
        "exp6", &exp6_proxy<context::Scalar, context::Options>, bp::arg("motion"),
        "Exp: se3 -> SE3. Return the integral of the input"
        " spatial velocity during time 1.");
 
      bp::def(
        "exp6", &exp6_proxy<context::Motion::Vector6>, bp::arg("v"),
        "Exp: se3 -> SE3. Return the integral of the input"
        " spatial velocity during time 1.");
 
      bp::def(
        "exp6_quat", &exp6_proxy_quatvec<context::Motion::Vector6>, bp::arg("v"),
        "Exp: se3 -> R3 * S3. Return the integral of the input 6D spatial velocity over unit time,"
        " using quaternion to represent rotation as in the standard configuration layout"
        " for the Lie group SE3.");
 
      bp::def(
        "Jexp6", &Jexp6_proxy<context::Scalar, context::Options>, bp::arg("motion"),
        "Jacobian of exp(v) which maps from the tangent of SE(3) at exp(v) to"
        " the tangent of SE(3) at Identity.");
 
      bp::def(
        "Jexp6", &Jexp6_proxy<context::Motion::Vector6>, bp::arg("v"),
        "Jacobian of exp(v) which maps from the tangent of SE(3) at exp(v) to"
        " the tangent of SE(3) at Identity.");
 
      bp::def(
        "log6",
        (context::Motion(*)(const context::SE3 &)) & log6<context::Scalar, context::Options>,
        bp::arg("M"),
        "Log: SE3 -> se3. Pseudo-inverse of exp from SE3"
        " -> { v,w in se3, ||w|| < 2pi }.");
 
      bp::def(
        "log6", &log6_proxy<context::Matrix4s>, bp::arg("homegeneous_matrix"),
        "Log: SE3 -> se3. Pseudo-inverse of Exp: so3 -> SO3. Log maps from SE3"
        " -> { v,w in se3, ||w|| < 2pi }.");
 
      bp::def(
        "log6_quat", &log6_proxy_quatvec<context::Vector7s>, bp::arg("q"),
        "Log: R^3 * S^3 -> se3. Pseudo-inverse of Exp: se3 -> R^3 * S^3,",
        " the variant of the SE3 Exp using quaternions for the rotations.");
 
      bp::def(
        "Jlog6", &Jlog6_proxy<context::Scalar, context::Options>, bp::arg("M"),
        "Jacobian of log(M) which maps from the tangent of SE(3) at M to"
        " the tangent of SE(3) at Identity.");
    }
 
  } // namespace python
} // namespace pinocchio