Comments and README file

examples/PlanarSLAMExample_easy.cpp

@@ -11,8 +11,7 @@
 
 /**
  * @file PlanarSLAMExample.cpp
- * @brief Simple robotics example from tutorial Figure 1.1 (left) by using the
+ * @brief Simple robotics example using the pre-built planar SLAM domain
- * pre-built planar SLAM domain
  * @author Alex Cunningham
  */
 

examples/PlanarSLAMSelfContained_advanced.cpp

@@ -10,9 +10,8 @@
  * -------------------------------------------------------------------------- */
 
 /**
- * @file PlanarSLAMSelfContained.cpp
+ * @file PlanarSLAMSelfContained_advanced.cpp
- * @brief Simple robotics example from tutorial Figure 1.1 (left), with all typedefs
+ * @brief Simple robotics example with all typedefs internal to this script.
- * internal to this script.
  * @author Alex Cunningham
  */
 

examples/Pose2SLAMExample_advanced.cpp

@@ -10,7 +10,7 @@
  * -------------------------------------------------------------------------- */
 
 /**
- * @file Pose2SLAMExample.cpp
+ * @file Pose2SLAMExample_advanced.cpp
  * @brief Simple Pose2SLAM Example using
  * pre-built pose2SLAM domain
  * @author Chris Beall

examples/Pose2SLAMExample_easy.cpp

@@ -1,6 +1,19 @@
+/* ----------------------------------------------------------------------------
+
+ * 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
+
+ * -------------------------------------------------------------------------- */
+
 /*
  * Pose2SLAMExample_easy.cpp
  *
+ * A 2D Pose SLAM example using the predefined typedefs in gtsam/slam/pose2SLAM.h
+ *
  *  Created on: Oct 21, 2010
  *      Author: ydjian
  */

examples/Pose2SLAMwSPCG_advanced.cpp

@@ -10,7 +10,10 @@
  * -------------------------------------------------------------------------- */
 
 /*
- * Solve a simple 3 by 3 grid of Pose2 SLAM problem by using advanced SPCG interface
+ * @file Pose2SLAMwSPCG_advanced.cpp
+ * @brief Solve a simple 3 by 3 grid of Pose2 SLAM problem by using advanced SPCG interface
+ * @author Yong Dian
+ * Created October 21, 2010
  */
 
 #include <boost/shared_ptr.hpp>

examples/Pose2SLAMwSPCG_easy.cpp

@@ -10,10 +10,12 @@
  * -------------------------------------------------------------------------- */
 
 /*
- * Solve a simple 3 by 3 grid of Pose2 SLAM problem by using easy SPCG interface
+ * @file Pose2SLAMwSPCG_easy.cpp
+ * @brief Solve a simple 3 by 3 grid of Pose2 SLAM problem by using easy SPCG interface
+ * @author Yong Dian
+ * Created October 21, 2010
  */
 
-
 #include <boost/shared_ptr.hpp>
 
 #include <gtsam/slam/pose2SLAM.h>

examples/README

@@ -0,0 +1,22 @@
+This directory contains a number of exapmples that illustrate the use of GTSAM:
+
+SimpleRotation:  a super-simple example of optimizing a single rotation according to a single prior
+
+2D Pose SLAM 
+============
+Pose2SLAMExample_easy: A 2D Pose SLAM example using the predefined typedefs in gtsam/slam/pose2SLAM.h
+Pose2SLAMExample_advanced: same, but uses an Optimizer object
+Pose2SLAMwSPCG_easy: solve a simple 3 by 3 grid of Pose2 SLAM problem by using easy SPCG interface
+Pose2SLAMwSPCG_advanced: solve a simple 3 by 3 grid of Pose2 SLAM problem by using advanced SPCG interface
+
+Planar SLAM with landmarks
+==========================
+PlanarSLAMExample: simple robotics example using the pre-built planar SLAM domain
+PlanarSLAMSelfContained_advanced: simple robotics example with all typedefs internal to this script.
+
+Visual SLAM
+===========
+The directory vSLAMexample includes 2 simple examples using GTSAM:
+- vSFMexample using visualSLAM in for structure-from-motion (SFM), and
+- vISAMexample using visualSLAM and ISAM for incremental SLAM updates
+See the separate README file there.

examples/SimpleRotation.cpp

@@ -13,8 +13,6 @@
  * SimpleRotation.cpp
  *
  * This is a super-simple example of optimizing a single rotation according to a single prior
- * yet it is quite painful (took 1.5 hours to code from scratch) and is overly complex
- * An example like this should be very easy to do, so let's work at it.
  *
  *  Created on: Jul 1, 2010
  *  @Author: Frank Dellaert