Added the descriptions of the individual commands.
authorFrancois Fleuret <francois@fleuret.org>
Tue, 25 Dec 2012 10:24:25 +0000 (11:24 +0100)
committerFrancois Fleuret <francois@fleuret.org>
Tue, 25 Dec 2012 10:24:25 +0000 (11:24 +0100)
README.txt

index 894f59d..ba8e593 100644 (file)
@@ -17,6 +17,22 @@ This implementation is not the reference implementation used for the
 experiments presented in this article. It uses a Dijkstra with a
 Binary Heap for the min-queue, and not the optimal Fibonacci heap.
 
+This software package includes three commands:
+
+ - mtp is the generic command to use in practice. It takes tracking
+   parameters as input, and prints the tracked trajectories as
+   output. The format for these parameters is given at the bottom of
+   this documentation.
+
+ - mtp_example creates a tracking toy example, and runs the tracking
+   algorithm on it. It gives an example of how to use MTPTracker on a
+   configuration produced dynamically, and produce a test input file
+   for the mtp command.
+
+ - mtp_stress_test creates a larger problem with a lot of noise and
+   multiple trajectories, to check the behavior of the code under
+   slightly more complex situation.
+
 * INSTALLATION
 
 This software should compile with any C++ compiler. Under a unix-like