doxygen fixes

release/4.3a0
Chris Beall 2012-09-07 18:54:12 +00:00
parent 1c9fb8503b
commit 9e960b4589
3 changed files with 18 additions and 4 deletions

View File

@ -94,6 +94,7 @@ namespace gtsam {
/** /**
* Create a level camera at the given 2D pose and height * Create a level camera at the given 2D pose and height
* @param pose2 specifies the location and viewing direction * @param pose2 specifies the location and viewing direction
* @param height specifies the height of the camera (along the positive Z-axis)
* (theta 0 = looking in direction of positive X axis) * (theta 0 = looking in direction of positive X axis)
*/ */
static CalibratedCamera Level(const Pose2& pose2, double height); static CalibratedCamera Level(const Pose2& pose2, double height);
@ -126,8 +127,9 @@ namespace gtsam {
/** /**
* This function receives the camera pose and the landmark location and * This function receives the camera pose and the landmark location and
* returns the location the point is supposed to appear in the image * returns the location the point is supposed to appear in the image
* @param camera the CalibratedCamera
* @param point a 3D point to be projected * @param point a 3D point to be projected
* @param D_intrinsic_pose the optionally computed Jacobian with respect to pose
* @param D_intrinsic_point the optionally computed Jacobian with respect to the 3D point
* @return the intrinsic coordinates of the projected point * @return the intrinsic coordinates of the projected point
*/ */
Point2 project(const Point3& point, Point2 project(const Point3& point,
@ -150,6 +152,8 @@ namespace gtsam {
/** /**
* Calculate range to a landmark * Calculate range to a landmark
* @param point 3D location of landmark * @param point 3D location of landmark
* @param H1 optionally computed Jacobian with respect to pose
* @param H2 optionally computed Jacobian with respect to the 3D point
* @return range (double) * @return range (double)
*/ */
double range(const Point3& point, double range(const Point3& point,
@ -160,6 +164,8 @@ namespace gtsam {
/** /**
* Calculate range to another pose * Calculate range to another pose
* @param pose Other SO(3) pose * @param pose Other SO(3) pose
* @param H1 optionally computed Jacobian with respect to pose
* @param H2 optionally computed Jacobian with respect to the 3D point
* @return range (double) * @return range (double)
*/ */
double range(const Pose3& pose, double range(const Pose3& pose,
@ -170,6 +176,8 @@ namespace gtsam {
/** /**
* Calculate range to another camera * Calculate range to another camera
* @param camera Other camera * @param camera Other camera
* @param H1 optionally computed Jacobian with respect to pose
* @param H2 optionally computed Jacobian with respect to the 3D point
* @return range (double) * @return range (double)
*/ */
double range(const CalibratedCamera& camera, double range(const CalibratedCamera& camera,

View File

@ -156,6 +156,7 @@ namespace gtsam {
/** /**
* A Gaussian noise model created by specifying a covariance matrix. * A Gaussian noise model created by specifying a covariance matrix.
* @param covariance The square covariance Matrix
* @param smart check if can be simplified to derived class * @param smart check if can be simplified to derived class
*/ */
static shared_ptr Covariance(const Matrix& covariance, bool smart = true); static shared_ptr Covariance(const Matrix& covariance, bool smart = true);
@ -263,6 +264,7 @@ namespace gtsam {
/** /**
* A diagonal noise model created by specifying a Vector of variances, i.e. * A diagonal noise model created by specifying a Vector of variances, i.e.
* i.e. the diagonal of the covariance matrix. * i.e. the diagonal of the covariance matrix.
* @param variances A vector containing the variances of this noise model
* @param smart check if can be simplified to derived class * @param smart check if can be simplified to derived class
*/ */
static shared_ptr Variances(const Vector& variances, bool smart = true); static shared_ptr Variances(const Vector& variances, bool smart = true);
@ -492,6 +494,8 @@ namespace gtsam {
/** /**
* An isotropic noise model created by specifying a variance = sigma^2. * An isotropic noise model created by specifying a variance = sigma^2.
* @param dim The dimension of this noise model
* @param variance The variance of this noise model
* @param smart check if can be simplified to derived class * @param smart check if can be simplified to derived class
*/ */
static shared_ptr Variance(size_t dim, double variance, bool smart = true); static shared_ptr Variance(size_t dim, double variance, bool smart = true);

View File

@ -41,10 +41,11 @@ public:
/** /**
* Constructor * Constructor
* TODO: Mark argument order standard (keys, measurement, parameters) * TODO: Mark argument order standard (keys, measurement, parameters)
* @param z is the 2 dimensional location of point in image (the measurement) * @param measured is the 2 dimensional location of point in image (the measurement)
* @param model is the standard deviation * @param model is the standard deviation
* @param j_pose is basically the frame number * @param poseKey is basically the frame number
* @param j_landmark is the index of the landmark * @param pointKey is the index of the landmark
* @param invDepthKey is the index of inverse depth
* @param K shared pointer to the constant calibration * @param K shared pointer to the constant calibration
*/ */
InvDepthFactor3(const gtsam::Point2& measured, const gtsam::SharedNoiseModel& model, InvDepthFactor3(const gtsam::Point2& measured, const gtsam::SharedNoiseModel& model,
@ -57,6 +58,7 @@ public:
/** /**
* print * print
* @param s optional string naming the factor * @param s optional string naming the factor
* @param keyFormatter optional formatter useful for printing Symbols
*/ */
void print(const std::string& s = "InvDepthFactor3", void print(const std::string& s = "InvDepthFactor3",
const gtsam::KeyFormatter& keyFormatter = gtsam::DefaultKeyFormatter) const { const gtsam::KeyFormatter& keyFormatter = gtsam::DefaultKeyFormatter) const {