Cleaning, and doxygen

This commit is contained in:
Thomas FORGIONE 2015-03-12 11:22:15 +01:00
parent f7ca8dab7e
commit a2c9afb536
3 changed files with 41 additions and 13 deletions

View File

@ -20,19 +20,47 @@
/// - SkeletonDrawing
///
/// \section Skeleton
/// This is the main binary. it takes several arguments
/// \verbatim
// Allowed options:
// -h [ --help ] produce help message
// --img1 arg first image (for the keypoints detection)
// --img2 arg second image (for the keypoints detection)
// --mask1 arg binary mask of the first image (to remove useless
// keypoints)
// --mask2 arg binary mask of the second image
// --skl1 arg first skeleton, and its branches
// --skl2 arg second skeleton
// -o [ --output ] arg output file
/// \endverbatim
/// This is the main binary. It is meant to read two skeletons splitted, and
/// match the branches accordingly to the keypoint detected in the pictures.
/// It generates a file with the following syntax :
/// \code
/// m 1 2
/// m 4 6
/// ...
/// \endcode
///
/// Each line like
/// \code
/// m i j
/// \endcode
/// means that the i-th branch of the first skeleton was associated to the j-th
/// branch on the second one
///
/// Note that this program will probably not work if there are not the same
/// number of branches in the two skeletons.
///
/// Allowed options:
/// -h [ --help ] produce help message
/// --img1 arg first image (for the keypoints detection)
/// --img2 arg second image (for the keypoints detection)
/// --mask1 arg binary mask of the first image (to remove useless
/// keypoints)
/// --mask2 arg binary mask of the second image
/// --skl1 arg first skeleton, and its branches
/// --skl2 arg second skeleton
/// -o [ --output ] arg output file
///
/// \section SkeletonDrawing
/// This program displays the result of a very simple test, where skeletons
/// were drawn by hand, and the keypoints are defined in the source (and not detected).
/// It shows how the program is able to work in simple cases.
///
/// This program is meant to be used like this
/// \code
/// bin/SkeletonDrawing data/skl/skullTest*
/// \endcode
///
///
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////