GTSAM  4.0.2
C++ library for smoothing and mapping (SAM)
IMUFactor.h
Go to the documentation of this file.
1 
7 #pragma once
8 
12 
13 namespace gtsam {
14 
20 template<class POSE>
21 class IMUFactor : public NoiseModelFactorN<POSE, POSE> {
22 public:
24  typedef IMUFactor<POSE> This;
25 
26 protected:
27 
29  Vector3 accel_, gyro_;
30  double dt_;
31 
32 public:
33 
34  // Provide access to the Matrix& version of evaluateError:
35  using Base::evaluateError;
36 
38  IMUFactor(const Vector3& accel, const Vector3& gyro,
39  double dt, const Key& key1, const Key& key2, const SharedNoiseModel& model)
40  : Base(model, key1, key2), accel_(accel), gyro_(gyro), dt_(dt) {}
41 
43  IMUFactor(const Vector6& imu_vector,
44  double dt, const Key& key1, const Key& key2, const SharedNoiseModel& model)
45  : Base(model, key1, key2), accel_(imu_vector.head(3)), gyro_(imu_vector.tail(3)), dt_(dt) {}
46 
47  ~IMUFactor() override {}
48 
50  gtsam::NonlinearFactor::shared_ptr clone() const override {
51  return std::static_pointer_cast<gtsam::NonlinearFactor>(
52  gtsam::NonlinearFactor::shared_ptr(new This(*this))); }
53 
55  bool equals(const NonlinearFactor& e, double tol = 1e-9) const override {
56  const This* const f = dynamic_cast<const This*>(&e);
57  return f && Base::equals(e) &&
58  equal_with_abs_tol(accel_, f->accel_, tol) &&
59  equal_with_abs_tol(gyro_, f->gyro_, tol) &&
60  std::abs(dt_ - f->dt_) < tol;
61  }
62 
63  void print(const std::string& s="", const gtsam::KeyFormatter& formatter = gtsam::DefaultKeyFormatter) const override {
64  std::string a = "IMUFactor: " + s;
65  Base::print(a, formatter);
66  gtsam::print((Vector)accel_, "accel");
67  gtsam::print((Vector)gyro_, "gyro");
68  std::cout << "dt: " << dt_ << std::endl;
69  }
70 
71  // access
72  const Vector3& gyro() const { return gyro_; }
73  const Vector3& accel() const { return accel_; }
74  Vector6 z() const { return (Vector6() << accel_, gyro_).finished(); }
75 
80  Vector evaluateError(const PoseRTV& x1, const PoseRTV& x2,
81  OptionalMatrixType H1, OptionalMatrixType H2) const override {
82  const Vector6 meas = z();
83  if (H1) *H1 = numericalDerivative21<Vector6, PoseRTV, PoseRTV>(
84  std::bind(This::predict_proxy, std::placeholders::_1, std::placeholders::_2, dt_, meas), x1, x2, 1e-5);
85  if (H2) *H2 = numericalDerivative22<Vector6, PoseRTV, PoseRTV>(
86  std::bind(This::predict_proxy, std::placeholders::_1, std::placeholders::_2, dt_, meas), x1, x2, 1e-5);
87  return predict_proxy(x1, x2, dt_, meas);
88  }
89 
91  virtual Vector evaluateError(const Pose3& x1, const Pose3& x2,
93  assert(false); // no corresponding factor here
94  return Vector6::Zero();
95  }
96 
97 private:
99  static Vector6 predict_proxy(const PoseRTV& x1, const PoseRTV& x2,
100  double dt, const Vector6& meas) {
101  Vector6 hx = x1.imuPrediction(x2, dt);
102  return meas - hx;
103  }
104 };
105 
106 } // \namespace gtsam
Definition: NonlinearFactor.h:431
bool equals(const NonlinearFactor &f, double tol=1e-9) const override
Definition: PoseRTV.h:23
Vector3 accel_
Definition: IMUFactor.h:29
gtsam::NonlinearFactor::shared_ptr clone() const override
Definition: IMUFactor.h:50
Definition: Factor.h:69
virtual Vector evaluateError(const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0
Definition: NonlinearFactor.h:68
Some functions to compute numerical derivatives.
Matrix * OptionalMatrixType
Definition: NonlinearFactor.h:55
void print(const std::string &s="", const gtsam::KeyFormatter &formatter=gtsam::DefaultKeyFormatter) const override
Definition: IMUFactor.h:63
GTSAM_EXPORT void print(const Matrix &A, const std::string &s, std::ostream &stream)
std::function< std::string(Key)> KeyFormatter
Typedef for a function to format a key, i.e. to convert it to a string.
Definition: Key.h:35
bool equal_with_abs_tol(const Eigen::DenseBase< MATRIX > &A, const Eigen::DenseBase< MATRIX > &B, double tol=1e-9)
Definition: Matrix.h:80
Pose3 with translational velocity.
Definition: chartTesting.h:28
void print(const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
virtual Vector evaluateError(const Pose3 &x1, const Pose3 &x2, OptionalMatrixType H1, OptionalMatrixType H2) const
Definition: IMUFactor.h:91
bool equals(const NonlinearFactor &e, double tol=1e-9) const override
Definition: IMUFactor.h:55
Non-linear factor base classes.
Vector evaluateError(const PoseRTV &x1, const PoseRTV &x2, OptionalMatrixType H1, OptionalMatrixType H2) const override
Definition: IMUFactor.h:80
IMUFactor(const Vector6 &imu_vector, double dt, const Key &key1, const Key &key2, const SharedNoiseModel &model)
Definition: IMUFactor.h:43
Definition: IMUFactor.h:21
Definition: Pose3.h:37
Vector6 imuPrediction(const PoseRTV &x2, double dt) const
std::uint64_t Key
Integer nonlinear key type.
Definition: types.h:102
noiseModel::Base::shared_ptr SharedNoiseModel
Definition: NoiseModel.h:741
IMUFactor(const Vector3 &accel, const Vector3 &gyro, double dt, const Key &key1, const Key &key2, const SharedNoiseModel &model)
Definition: IMUFactor.h:38