Removed compute_dp_ranks, added compute_dp_ordering instead.

[mtp.git] / README.txt

diff --git a/README.txt b/README.txt
index afe5cb2..685211d 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -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 situations.
+
 * INSTALLATION
 
 This software should compile with any C++ compiler. Under a unix-like
@@ -30,7 +46,7 @@ tracker.dat, and print the optimal detected trajectories.
 
 If you now execute
 
-  ./mtp tracker.dat
+  ./mtp --verbose --trajectory-file result.trj --graph-file graph.dot tracker.dat
 
 It will load the file tracker.dat saved by the previous command, run
 the detection, save the detected trajectories in result.trj, and the