The methods MTPTracker::write_trajectories now writes first the number of trajectories.

[mtp.git] / README.txt

diff --git a/README.txt b/README.txt
index eb8a26f..3d93234 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -31,7 +31,7 @@ with the dot command from graphviz:
 
 * IMPLEMENTATION
 
-The two main classes are MTPGraph and Tracker.
+The two main classes are MTPGraph and MTPTracker.
 
 The MTPGraph class stores a directed acyclic graph (DAG), with a
 length for each edge -- which can be negative -- and can compute the
@@ -43,7 +43,7 @@ no path at all. Note that the procedure is similar to that of KSP, in
 the sense that the family it computes eventually is globally optimal,
 even if the computation is iterative.
 
-The Tracker class allows
+The MTPTracker class allows
 
  (1) to define a spatial topology composed of
 
@@ -64,7 +64,7 @@ consistent with the topology, which maximizes the overall detection
 score (i.e. the sum of the detection scores of the nodes visited by
 the trajectories)
 
-The Tracker class uses the MTPGraph. From the definition of the
+The MTPTracker class uses the MTPGraph. From the definition of the
 spatial topology, it builds a graph with one source, one sink, and two
 nodes per location and time. This structure ensures the trajectories
 computed by the tracker to be node-disjoint by forcing the paths
@@ -74,27 +74,35 @@ The edges from the source or to the sink, or between these pairs, are
 of length zero, and the edge between the two nodes of such a pair has
 a length equal to the opposite of the detection score.
 
-The file mtp.cc gives a very simple usage example of the Tracker
-class.
+The file mtp_example.cc gives a very simple usage example of the
+MTPTracker class by setting the tracker parameters dynamically, and
+running the tracking.
 
-The tracker data file one can read with Tracker::read has the
-following format (with L the number of locations and T the number of
-time steps):
+The tracker data file for MTPTracker::read has the following format,
+where L is the number of locations and T is the number of time steps:
 
 ---------------------------- snip snip -------------------------------
-L T
+int:L int:T
 
-allowed_motion_from_1_to_1 ... allowed_motion_from_1_to_L
+bool:allowed_motion_from_1_to_1 ... bool:allowed_motion_from_1_to_L
 ...
-allowed_motion_from_L_to_1 ... allowed_motion_from_L_to_L
+bool:allowed_motion_from_L_to_1 ... bool:allowed_motion_from_L_to_L
 
-is_an_entrance_1 ... is_an_entrance_L
+bool:is_an_entrance_1 ... bool:is_an_entrance_L
 
-is_an_exit_1 ... is_an_exit_L
+bool:is_an_exit_1 ... bool:is_an_exit_L
 
-detection_score_1_1 ... detection_score_1_L
+float:detection_score_1_1 ... float:detection_score_1_L
 ...
-detection_score_T_1 ... detection_score_T_L
+float:detection_score_T_1 ... float:detection_score_T_L
+---------------------------- snip snip -------------------------------
+
+The method MTPTracker::write_trajectories writes first the number of
+trajectories, followed by one line per trajectory with the following
+structure
+
+---------------------------- snip snip -------------------------------
+int:traj_number int:entrance_time int:duration float:score int:location_1 ... int:location_duration
 ---------------------------- snip snip -------------------------------
 
 --