From 2b4557f425009e6cfc5e8eb081ba2800c5434474 Mon Sep 17 00:00:00 2001 From: Ethan Uppal <113849268+ethanuppal@users.noreply.github.com> Date: Sat, 20 Apr 2024 16:09:52 -0400 Subject: [PATCH] Update docs --- docs/annotated.html | 5 +- docs/class_lidar_view-members.html | 6 +- docs/class_lidar_view.html | 42 +- docs/classes.html | 9 +- docs/classicp_1_1_i_c_p-members.html | 34 +- docs/classicp_1_1_i_c_p.html | 253 ++++--- .../dir_156e6a4e01c93213f20015fc7847b1f4.html | 13 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 + .../dir_8111f045ab156cab490d6e0f8a4c6c64.html | 99 +++ .../dir_e86b0e4603fcde4bd095119c32ac8e36.html | 97 +++ docs/doxygen_crawl.html | 26 +- docs/files.html | 51 +- docs/functions.html | 46 +- docs/functions_func.html | 20 +- docs/functions_vars.html | 14 +- docs/geo_8cpp.html | 4 +- docs/geo_8cpp_source.html | 19 +- docs/geo_8d_source.html | 388 ++++++++++- docs/geo_8h.html | 18 +- docs/geo_8h_source.html | 89 +-- docs/hierarchy.html | 7 +- docs/icp_8cpp_source.html | 182 +++--- docs/icp_8d_source.html | 396 ++++++++++- docs/icp_8h_source.html | 136 ++-- docs/index.html | 2 +- ...int__to__line_8d.html => kdtree_8cpp.html} | 8 +- ...8d_source.html => kdtree_8cpp_source.html} | 14 +- ...oint__to__point_8d.html => kdtree_8d.html} | 8 +- docs/kdtree_8d_source.html | 95 +++ docs/kdtree_8h.html | 91 +++ docs/kdtree_8h_source.html | 95 +++ docs/lidar__view_8cpp_source.html | 263 ++++---- docs/lidar__view_8d_source.html | 616 ++++++++++++++---- docs/lidar__view_8h_source.html | 22 +- docs/menudata.js | 3 +- docs/namespaceicp.html | 58 +- docs/namespacemembers.html | 5 +- docs/namespacemembers_func.html | 2 +- docs/namespacemembers_type.html | 86 +++ docs/namespacemembers_vars.html | 1 + docs/namespacesim__config.html | 18 + docs/point__to__line_8cpp.html | 6 +- docs/point__to__line_8cpp_source.html | 35 +- docs/point__to__point_8cpp.html | 6 +- docs/point__to__point_8cpp_source.html | 211 +++--- docs/point__to__point_8d_source.html | 103 --- docs/search/all_0.js | 5 +- docs/search/all_1.js | 4 +- docs/search/all_10.js | 4 +- docs/search/all_11.js | 5 +- docs/search/all_12.js | 6 +- docs/search/all_13.js | 6 +- docs/search/all_14.js | 4 +- docs/search/all_15.js | 3 +- docs/search/{functions_c.js => all_16.js} | 0 docs/search/all_2.js | 10 +- docs/search/all_3.js | 4 +- docs/search/all_6.js | 6 +- docs/search/all_7.js | 2 +- docs/search/all_8.js | 10 +- docs/search/all_9.js | 10 +- docs/search/all_a.js | 5 +- docs/search/all_b.js | 3 +- docs/search/all_c.js | 10 +- docs/search/all_d.js | 10 +- docs/search/all_e.js | 14 +- docs/search/all_f.js | 14 +- docs/search/classes_3.js | 2 +- docs/search/classes_4.js | 4 - docs/search/files_2.js | 6 +- docs/search/files_3.js | 4 +- docs/search/files_4.js | 5 +- docs/search/files_5.js | 5 +- docs/search/files_6.js | 5 +- docs/search/files_7.js | 5 + docs/search/functions_0.js | 2 +- docs/search/functions_1.js | 4 +- docs/search/functions_2.js | 5 +- docs/search/functions_3.js | 2 +- docs/search/functions_4.js | 4 +- docs/search/functions_5.js | 5 +- docs/search/functions_6.js | 3 +- docs/search/functions_7.js | 2 +- docs/search/functions_8.js | 2 +- docs/search/functions_9.js | 5 +- docs/search/functions_a.js | 2 +- docs/search/functions_b.js | 6 +- docs/search/searchdata.js | 25 +- docs/search/typedefs_0.js | 4 + docs/search/typedefs_1.js | 4 + docs/search/variables_0.js | 4 +- docs/search/variables_1.js | 4 +- docs/search/variables_2.js | 4 +- docs/search/variables_3.js | 2 +- docs/search/variables_4.js | 2 +- docs/search/variables_5.js | 4 +- docs/search/variables_6.js | 6 +- docs/search/variables_7.js | 6 +- docs/search/variables_8.js | 4 +- docs/search/variables_9.js | 4 +- docs/search/variables_a.js | 4 +- docs/search/variables_b.js | 4 +- docs/search/variables_c.js | 5 + docs/search/variables_d.js | 4 + docs/sim__config_8cpp.html | 2 + docs/sim__config_8cpp_source.html | 5 +- docs/sim__config_8h_source.html | 5 +- docs/structicp_1_1_methods.html | 6 +- ... structicp_1_1_r_b_transform-members.html} | 15 +- ....html => structicp_1_1_r_b_transform.html} | 98 ++- docs/structicp_1_1_transform-members.html | 100 --- docs/structicp_1_1_transform.html | 319 --------- docs/vanilla_8cpp.html | 1 + docs/vanilla_8cpp_source.html | 151 ++--- docs/vanilla_8d_source.html | 519 +++++++-------- 115 files changed, 3332 insertions(+), 1896 deletions(-) create mode 100644 docs/dir_8111f045ab156cab490d6e0f8a4c6c64.html create mode 100644 docs/dir_e86b0e4603fcde4bd095119c32ac8e36.html rename docs/{point__to__line_8d.html => kdtree_8cpp.html} (91%) rename docs/{point__to__line_8d_source.html => kdtree_8cpp_source.html} (68%) rename docs/{point__to__point_8d.html => kdtree_8d.html} (91%) create mode 100644 docs/kdtree_8d_source.html create mode 100644 docs/kdtree_8h.html create mode 100644 docs/kdtree_8h_source.html create mode 100644 docs/namespacemembers_type.html delete mode 100644 docs/point__to__point_8d_source.html rename docs/search/{functions_c.js => all_16.js} (100%) delete mode 100644 docs/search/classes_4.js create mode 100644 docs/search/files_7.js create mode 100644 docs/search/typedefs_0.js create mode 100644 docs/search/typedefs_1.js create mode 100644 docs/search/variables_c.js create mode 100644 docs/search/variables_d.js rename docs/{structicp_1_1_point-members.html => structicp_1_1_r_b_transform-members.html} (70%) rename docs/{structicp_1_1_point.html => structicp_1_1_r_b_transform.html} (50%) delete mode 100644 docs/structicp_1_1_transform-members.html delete mode 100644 docs/structicp_1_1_transform.html diff --git a/docs/annotated.html b/docs/annotated.html index 5e4d545..0cd4a4c 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -81,9 +81,8 @@
construct_instance() | LidarView | |
draw(SDL_Renderer *renderer, const SDL_Rect *frame, double dtime) override | LidarView | |
get_dest() const | LidarView | |
get_source() const | LidarView | |
get_dest() const | LidarView | |
get_source() const | LidarView | |
LidarView() | LidarView | |
LidarView(std::vector< icp::Point > source, std::vector< icp::Point > destination, const std::string method) | LidarView | |
LidarView(std::vector< icp::Vector > source, std::vector< icp::Vector > destination, const std::string method) | LidarView | |
on_event(const SDL_Event &event) override | LidarView | |
~LidarView() noexcept override | LidarView |
method
) on the given instance (source
and destination
). method
) on the given instance (source
and destination
). Definition at line 103 of file lidar_view.cpp.
+Definition at line 107 of file lidar_view.cpp.
- -Perform one iteration of ICP for point clouds a
and b
.
Perform one iteration of ICP for the point clouds a
and b
provided with ICP::begin.
constructor
, returning false
if name
has already been registered.
-Definition at line 47 of file icp.cpp.
+Definition at line 69 of file icp.cpp.
@@ -471,12 +491,12 @@Definition at line 55 of file icp.cpp.
+Definition at line 77 of file icp.cpp.
- -
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
Definition at line 66 of file icp.h.
@@ -629,7 +728,7 @@Definition at line 48 of file icp.h.
+Definition at line 60 of file icp.h.
@@ -659,8 +758,8 @@Transform icp::ICP::t | +RBTransform icp::ICP::transform |
+Directories | |
old | |
Files | |||||||||
geo.cpp | |||||||||
icp.h | |||||||||
point_to_line.cpp | |||||||||
point_to_line.d | |||||||||
point_to_point.cpp | |||||||||
point_to_point.d | |||||||||
vanilla.cpp | |||||||||
vanilla.d |
Directories | |||||
algo | |||||
icp | |||||
sim |
+ scan matching
+
+ ICP algorithm library
+ |
+
+Files | |
kdtree.cpp | |
kdtree.d | |
kdtree.h | |
+ scan matching
+
+ ICP algorithm library
+ |
+
+Files | |
point_to_line.cpp | |
point_to_point.cpp | |
book | |
▼ src | |
▼ icp | |
geo.cpp | |
geo.d | |
geo.h | |
icp.cpp | |
icp.d | |
icp.h | |
point_to_line.cpp | |
point_to_line.d | |
point_to_point.cpp | |
point_to_point.d | |
vanilla.cpp | |
vanilla.d | |
▼ sim | |
instance.cpp | |
instance.d | |
instance.h | |
lidar_view.cpp | |
lidar_view.d | |
lidar_view.h | |
sim_config.cpp | |
sim_config.d | |
sim_config.h | |
▼ algo | |
kdtree.cpp | |
kdtree.d | |
kdtree.h | |
▼ icp | |
▼ old | |
point_to_line.cpp | |
point_to_point.cpp | |
geo.cpp | |
geo.d | |
geo.h | |
icp.cpp | |
icp.d | |
icp.h | |
vanilla.cpp | |
vanilla.d | |
▼ sim | |
instance.cpp | |
instance.d | |
instance.h | |
lidar_view.cpp | |
lidar_view.d | |
lidar_view.h | |
sim_config.cpp | |
sim_config.d | |
sim_config.h |
Functions | |
Point | icp::get_center_of_mass (const std::vector< Point > &points) |
Vector | icp::get_centroid (const std::vector< Vector > &points) |
#include <vector>
#include <cmath>
#include <Eigen/Core>
Go to the source code of this file.
Classes | |
struct | icp::Point |
struct | icp::Transform |
struct | icp::RBTransform |
Rigid-body transformation. More... | |
@@ -101,10 +102,17 @@
namespace | icp | | |
+Typedefs | |
using | icp::Vector = Eigen::Vector2d |
using | icp::Matrix = Eigen::Matrix2d |
Functions | |
Point | icp::get_center_of_mass (const std::vector< Point > &points) |
Vector | icp::get_centroid (const std::vector< Vector > &points) |
Cicp::ICP | Interface for iterative closest points; please read the Detailed Description for usage information |
Cicp::Methods | |
Cicp::Point | |
Cicp::Transform | |
▼CView | |
CLidarView | |
Cicp::RBTransform | Rigid-body transformation |
▼CView | |
CLidarView |
Now, run
Instructions are printed to standard output.
The program itself can be built with
which will create an executable named main
in the working directory.
+ scan matching
+
+ ICP algorithm library
+ |
+
+ scan matching
+
+ ICP algorithm library
+ |
+
+ scan matching
+
+ ICP algorithm library
+ |
+
+Typedefs | |
using | Vector = Eigen::Vector2d |
using | Matrix = Eigen::Matrix2d |
Functions | |
Point | get_center_of_mass (const std::vector< Point > &points) |
Vector | get_centroid (const std::vector< Vector > &points) |
using icp::Matrix = Eigen::Matrix2d | +
using icp::Vector = Eigen::Vector2d | +
Point icp::get_center_of_mass | +Vector icp::get_centroid | ( | -const std::vector< Point > & | points | ) | +const std::vector< Vector > & | points | ) |
+ scan matching
+
+ ICP algorithm library
+ |
+
bool sim_config::use_light_background = false | +
Definition at line 25 of file sim_config.cpp.
+Go to the source code of this file.
- scan matching
-
- ICP algorithm library
- |
-
Definition at line 114 of file icp.h.
+Definition at line 125 of file icp.h.
@@ -125,7 +125,7 @@Definition at line 112 of file icp.h.
+Definition at line 123 of file icp.h.
diff --git a/docs/structicp_1_1_point-members.html b/docs/structicp_1_1_r_b_transform-members.html similarity index 70% rename from docs/structicp_1_1_point-members.html rename to docs/structicp_1_1_r_b_transform-members.html index 68d0475..3e139b4 100644 --- a/docs/structicp_1_1_point-members.html +++ b/docs/structicp_1_1_r_b_transform-members.html @@ -73,20 +73,21 @@This is the complete list of members for icp::Point, including all inherited members.
+This is the complete list of members for icp::RBTransform, including all inherited members.
Point() | icp::Point | inline |
Point(double x, double y) | icp::Point | inline |
x | icp::Point | |
y | icp::Point | |
apply_to(Vector v) const | icp::RBTransform | inline |
RBTransform() | icp::RBTransform | inline |
RBTransform(Vector translation, Matrix rotation) | icp::RBTransform | inline |
rotation | icp::RBTransform | |
translation | icp::RBTransform |
Rigid-body transformation. + More...
+#include <geo.h>
Public Member Functions | |
Point () | |
Point (double x, double y) | |
RBTransform () | |
RBTransform (Vector translation, Matrix rotation) | |
Vector | apply_to (Vector v) const |
Public Attributes | |
double | x |
double | y |
Vector | translation |
Matrix | rotation |
Definition at line 9 of file geo.h.
+icp::Point::Point | +icp::RBTransform::RBTransform | ( | ) | @@ -128,12 +134,12 @@ |
double icp::Point::x | +Matrix icp::RBTransform::rotation |
double icp::Point::y | +Vector icp::RBTransform::translation |
- scan matching
-
- ICP algorithm library
- |
-
This is the complete list of members for icp::Transform, including all inherited members.
-cm | icp::Transform | |
dx | icp::Transform | |
dy | icp::Transform | |
theta | icp::Transform | |
Transform() | icp::Transform | inline |
Transform(double dx, double dy, double theta) | icp::Transform | inline |
transform_x(double x, double y) const | icp::Transform | inline |
transform_y(double x, double y) const | icp::Transform | inline |
- scan matching
-
- ICP algorithm library
- |
-
#include <geo.h>
-Public Member Functions | |
Transform () | |
Transform (double dx, double dy, double theta) | |
double | transform_x (double x, double y) const |
double | transform_y (double x, double y) const |
-Public Attributes | |
double | dx |
double | dy |
double | theta |
currently only around CoM, need to make more complicated later | |
Point | cm |
-
|
- -inline | -
-
|
- -inline | -
-
|
- -inline | -
-
|
- -inline | -
double icp::Transform::theta | -
#include <cstdlib>
#include "icp.h"
#include "util/logger.h"
#include <Eigen/Core>
#include <Eigen/SVD>
Go to the source code of this file.
diff --git a/docs/vanilla_8cpp_source.html b/docs/vanilla_8cpp_source.html index 79257f8..7cdfa13 100644 --- a/docs/vanilla_8cpp_source.html +++ b/docs/vanilla_8cpp_source.html @@ -91,85 +91,90 @@ - - - - - - + + + + + + - - - - - - - - - - - - - -