gtsam 4.1.1
gtsam
Point3.h
Go to the documentation of this file.
1/* ----------------------------------------------------------------------------
2
3 * GTSAM Copyright 2010, Georgia Tech Research Corporation,
4 * Atlanta, Georgia 30332-0415
5 * All Rights Reserved
6 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)
7
8 * See LICENSE for the license information
9
10 * -------------------------------------------------------------------------- */
11
20// \callgraph
21
22#pragma once
23
24#include <gtsam/config.h>
25#include <gtsam/base/VectorSpace.h>
26#include <gtsam/base/Vector.h>
27#include <gtsam/dllexport.h>
28#include <boost/serialization/nvp.hpp>
29#include <numeric>
30
31namespace gtsam {
32
35typedef Vector3 Point3;
36
37// Convenience typedef
38using Point3Pair = std::pair<Point3, Point3>;
39GTSAM_EXPORT std::ostream &operator<<(std::ostream &os, const gtsam::Point3Pair &p);
40
41using Point3Pairs = std::vector<Point3Pair>;
42
44GTSAM_EXPORT double distance3(const Point3& p1, const Point3& q,
45 OptionalJacobian<1, 3> H1 = boost::none,
46 OptionalJacobian<1, 3> H2 = boost::none);
47
49GTSAM_EXPORT double norm3(const Point3& p, OptionalJacobian<1, 3> H = boost::none);
50
52GTSAM_EXPORT Point3 normalize(const Point3& p, OptionalJacobian<3, 3> H = boost::none);
53
55GTSAM_EXPORT Point3 cross(const Point3& p, const Point3& q,
56 OptionalJacobian<3, 3> H_p = boost::none,
57 OptionalJacobian<3, 3> H_q = boost::none);
58
60GTSAM_EXPORT double dot(const Point3& p, const Point3& q,
61 OptionalJacobian<1, 3> H_p = boost::none,
62 OptionalJacobian<1, 3> H_q = boost::none);
63
65template <class CONTAINER>
66Point3 mean(const CONTAINER& points) {
67 if (points.size() == 0) throw std::invalid_argument("Point3::mean input container is empty");
68 Point3 sum(0, 0, 0);
69 sum = std::accumulate(points.begin(), points.end(), sum);
70 return sum / points.size();
71}
72
74GTSAM_EXPORT Point3Pair means(const std::vector<Point3Pair> &abPointPairs);
75
76template <typename A1, typename A2>
77struct Range;
78
79template <>
81 typedef double result_type;
82 double operator()(const Point3& p, const Point3& q,
83 OptionalJacobian<1, 3> H1 = boost::none,
84 OptionalJacobian<1, 3> H2 = boost::none) {
85 return distance3(p, q, H1, H2);
86 }
87};
88
89} // namespace gtsam
90
typedef and functions to augment Eigen's VectorXd
Global functions in a separate testing namespace.
Definition: chartTesting.h:28
Point3 mean(const CONTAINER &points)
mean
Definition: Point3.h:66
Point3Pair means(const std::vector< Point3Pair > &abPointPairs)
Calculate the two means of a set of Point3 pairs.
Definition: Point3.cpp:78
Point3 cross(const Point3 &p, const Point3 &q, OptionalJacobian< 3, 3 > H1, OptionalJacobian< 3, 3 > H2)
cross product
Definition: Point3.cpp:63
double distance3(const Point3 &p1, const Point3 &q, OptionalJacobian< 1, 3 > H1, OptionalJacobian< 1, 3 > H2)
distance between two points
Definition: Point3.cpp:26
Vector3 Point3
As of GTSAM 4, in order to make GTSAM more lean, it is now possible to just typedef Point3 to Vector3...
Definition: Point3.h:35
Point3 normalize(const Point3 &p, OptionalJacobian< 3, 3 > H)
normalize, with optional Jacobian
Definition: Point3.cpp:51
double norm3(const Point3 &p, OptionalJacobian< 1, 3 > H)
Distance of the point from the origin, with Jacobian.
Definition: Point3.cpp:40
double dot(const V1 &a, const V2 &b)
Dot product.
Definition: Vector.h:194
OptionalJacobian is an Eigen::Ref like class that can take be constructed using either a fixed size o...
Definition: OptionalJacobian.h:39
Definition: BearingRange.h:39