12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feature: add some comment descriptions to the class

release/4.3a0
lvzhaoyang 2015-06-25 11:41:58 -04:00
parent 7ebc9e48e5
commit b569a4ab92
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gtsam/geometry/OrientedPlane3.h
View File

@ -26,7 +26,12 @@
namespace gtsam { namespace gtsam {
/// Represents an infinite plane in 3D. /**
* @brief Represents an infinite plane in 3D, which is composed of a planar normal and its
* perpendicular distance to the origin.
* Currently it provides a transform of the plane, and a norm 1 differencing of two planes.
* Refer to Trevor12iros for more math details.
*/
class GTSAM_EXPORT OrientedPlane3 { class GTSAM_EXPORT OrientedPlane3 {
private: private:
@ -89,7 +94,7 @@ public:
OptionalJacobian<3, 6> Hr = boost::none) const; OptionalJacobian<3, 6> Hr = boost::none) const;
/** /**
* @ deprecated the static method has wrong Jacobian order, * @deprecated the static method has wrong Jacobian order,
* please use the member method transform() * please use the member method transform()
* @param The raw plane * @param The raw plane
* @param xr a transformation in current coordiante * @param xr a transformation in current coordiante