SO3.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 
 * GTSAM Copyright 2010, Georgia Tech Research Corporation,
 * Atlanta, Georgia 30332-0415
 * All Rights Reserved
 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)
 
 * See LICENSE for the license information
 
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <gtsam/geometry/SOn.h>
 
#include <gtsam/base/Lie.h>
#include <gtsam/base/Matrix.h>
#include <gtsam/dllexport.h>
 
#include <vector>
 
namespace gtsam {
 
using SO3 = SO<3>;
 
// Below are all declarations of SO<3> specializations.
// They are *defined* in SO3.cpp.
 
template <>
GTSAM_EXPORT
SO3 SO3::AxisAngle(const Vector3& axis, double theta);
 
template <>
GTSAM_EXPORT
SO3 SO3::ClosestTo(const Matrix3& M);
 
template <>
GTSAM_EXPORT
SO3 SO3::ChordalMean(const std::vector<SO3>& rotations);
 
template <>
GTSAM_EXPORT
Matrix3 SO3::Hat(const Vector3& xi);  
 
template <>
GTSAM_EXPORT
Vector3 SO3::Vee(const Matrix3& X);  
 
template <>
Matrix3 SO3::AdjointMap() const;
 
template <>
GTSAM_EXPORT
SO3 SO3::Expmap(const Vector3& omega, ChartJacobian H);
 
template <>
GTSAM_EXPORT
Matrix3 SO3::ExpmapDerivative(const Vector3& omega);
 
template <>
GTSAM_EXPORT
Vector3 SO3::Logmap(const SO3& R, ChartJacobian H);
 
template <>
GTSAM_EXPORT
Matrix3 SO3::LogmapDerivative(const Vector3& omega);
 
// Chart at origin for SO3 is *not* Cayley but actual Expmap/Logmap
template <>
GTSAM_EXPORT
SO3 SO3::ChartAtOrigin::Retract(const Vector3& omega, ChartJacobian H);
 
template <>
GTSAM_EXPORT
Vector3 SO3::ChartAtOrigin::Local(const SO3& R, ChartJacobian H);
 
template <>
GTSAM_EXPORT
Vector9 SO3::vec(OptionalJacobian<9, 3> H) const;
 
#if GTSAM_ENABLE_BOOST_SERIALIZATION
template <class Archive>
void serialize(Archive& ar, SO3& R, const unsigned int /*version*/) {
  Matrix3& M = R.matrix_;
  ar& boost::serialization::make_nvp("R11", M(0, 0));
  ar& boost::serialization::make_nvp("R12", M(0, 1));
  ar& boost::serialization::make_nvp("R13", M(0, 2));
  ar& boost::serialization::make_nvp("R21", M(1, 0));
  ar& boost::serialization::make_nvp("R22", M(1, 1));
  ar& boost::serialization::make_nvp("R23", M(1, 2));
  ar& boost::serialization::make_nvp("R31", M(2, 0));
  ar& boost::serialization::make_nvp("R32", M(2, 1));
  ar& boost::serialization::make_nvp("R33", M(2, 2));
}
#endif
 
namespace so3 {
 
GTSAM_EXPORT Matrix3 compose(const Matrix3& M, const SO3& R,
                OptionalJacobian<9, 9> H = {});
 
GTSAM_EXPORT Matrix99 Dcompose(const SO3& R);
 
// Below are two functors that allow for saving computation when exponential map
// and its derivatives are needed at the same location in so<3>. The second
// functor also implements dedicated methods to apply dexp and/or inv(dexp).
 
struct GTSAM_EXPORT ExpmapFunctor {
  const double theta2, theta;
  const Matrix3 W, WW;
  bool nearZero{ false };
 
  // Ethan Eade's constants:
  double A;  // A = sin(theta) / theta
  double B;  // B = (1 - cos(theta))
 
  explicit ExpmapFunctor(const Vector3& omega);
 
  ExpmapFunctor(double nearZeroThresholdSq, const Vector3& axis);
 
  ExpmapFunctor(const Vector3& axis, double angle);
 
  Matrix3 expmap() const;
 
protected:
  void init(double nearZeroThresholdSq);
};
 
struct GTSAM_EXPORT DexpFunctor : public ExpmapFunctor {
  const Vector3 omega;
 
  // Ethan's C constant used in Jacobians
  double C;  // (1 - A) / theta^2
 
  // Constant used in inverse Jacobians
  double D;  // (1 - A/2B) / theta2
 
  // Constants used in cross and doubleCross
  double E;  // (2B - A) / theta2
  double F;  // (3C - B) / theta2
 
  explicit DexpFunctor(const Vector3& omega);
 
  explicit DexpFunctor(const Vector3& omega, double nearZeroThresholdSq, double nearPiThresholdSq);
 
  // NOTE(luca): Right Jacobian for Exponential map in SO(3) - equation
  // (10.86) and following equations in G.S. Chirikjian, "Stochastic Models,
  // Information Theory, and Lie Groups", Volume 2, 2008.
  //   Expmap(xi + dxi) \approx Expmap(xi) * Expmap(dexp * dxi)
  // This maps a perturbation dxi=(w,v) in the tangent space to
  // a perturbation on the manifold Expmap(dexp * xi)
  Matrix3 rightJacobian() const { return I_3x3 - B * W + C * WW; }
 
  // Compute the left Jacobian for Exponential map in SO(3)
  Matrix3 leftJacobian() const { return I_3x3 + B * W + C * WW; }
 
  Matrix3 rightJacobianInverse() const;
 
  // Inverse of left Jacobian
  Matrix3 leftJacobianInverse() const;
 
  Vector3 applyRightJacobian(const Vector3& v,
    OptionalJacobian<3, 3> H1 = {}, OptionalJacobian<3, 3> H2 = {}) const;
 
  Vector3 applyRightJacobianInverse(const Vector3& v,
    OptionalJacobian<3, 3> H1 = {}, OptionalJacobian<3, 3> H2 = {}) const;
 
  Vector3 applyLeftJacobian(const Vector3& v,
    OptionalJacobian<3, 3> H1 = {}, OptionalJacobian<3, 3> H2 = {}) const;
 
  Vector3 applyLeftJacobianInverse(const Vector3& v,
    OptionalJacobian<3, 3> H1 = {}, OptionalJacobian<3, 3> H2 = {}) const;
 
#ifdef GTSAM_ALLOW_DEPRECATED_SINCE_V43
  inline Matrix3 dexp() const { return rightJacobian(); }
 
  inline Matrix3 invDexp() const { return rightJacobianInverse(); }
#endif
};
}  //  namespace so3
 
/*
 * Define the traits. internal::MatrixLieGroup provides both Lie group and Testable
 */
 
template <>
struct traits<SO3> : public internal::MatrixLieGroup<SO3> {};
 
template <>
struct traits<const SO3> : public internal::MatrixLieGroup<SO3> {};
 
}  // end namespace gtsam