Added README.md
[mtp.git] / mtp.cc
diff --git a/mtp.cc b/mtp.cc
index 957e56f..15d0e08 100644 (file)
--- a/mtp.cc
+++ b/mtp.cc
@@ -26,6 +26,7 @@
 #include <fstream>
 #include <sys/time.h>
 #include <getopt.h>
+#include <limits.h>
 #include <string.h>
 
 using namespace std;
@@ -34,12 +35,56 @@ using namespace std;
 
 #define FILENAME_SIZE 1024
 
-char trajectory_filename[FILENAME_SIZE];
-char graph_filename[FILENAME_SIZE];
-int verbose;
+struct Global {
+  char trajectory_filename[FILENAME_SIZE];
+  char graph_filename[FILENAME_SIZE];
+  int verbose;
+} global;
 
 void usage(ostream *os) {
-  (*os) << "mtp [-h|--help] [-v|--verbose] [-t|--trajectory-filename <trajectory filename>] [-g|--graph-filename <graph filename>] [<tracking parameter file>]" << endl;
+  (*os) << "mtp [-h|--help] [--help-formats] [-v|--verbose] [-t|--trajectory-filename <trajectory filename>] [-g|--graph-filename <graph filename>] [<tracking parameter file>]" << endl;
+  (*os) << endl;
+  (*os) << "The mtp command processes a file containing the description of a topology" << endl;
+  (*os) << "and detection scores, and prints the optimal set of trajectories." << endl;
+  (*os) << endl;
+  (*os) << "If no filename is provided, it reads the parameters from the standard" << endl;
+  (*os) << "input. If no trajectory filename is provided, it writes the result to" << endl;
+  (*os) << "the standard output." << endl;
+  (*os) << endl;
+  (*os) << "Written by Francois Fleuret. (C) Idiap Research Institute, 2012." << endl;
+}
+
+void print_help_formats() {
+  cout << "The tracking parameters the command takes as input have the following" << endl;
+  cout << "format, where L is the number of locations and T is the number of time" << endl;
+  cout << "steps:" << endl;
+  cout << endl;
+  cout << "---------------------------- snip snip -------------------------------" << endl;
+  cout << "  int:L int:T" << endl;
+  cout << endl;
+  cout << "  bool:allowed_motion_from_1_to_1 ... bool:allowed_motion_from_1_to_L" << endl;
+  cout << "  ..." << endl;
+  cout << "  bool:allowed_motion_from_L_to_1 ... bool:allowed_motion_from_L_to_L" << endl;
+  cout << endl;
+  cout << "  bool:entrance_1_1 ... bool:entrance_1_L" << endl;
+  cout << "  ..." << endl;
+  cout << "  bool:entrance_T_1 ... bool:entrance_T_L" << endl;
+  cout << endl;
+  cout << "  bool:exit_1_1 ... bool:exit_1_L" << endl;
+  cout << "  ..." << endl;
+  cout << "  bool:exit_T_1 ... bool:exit_T_L" << endl;
+  cout << endl;
+  cout << "  float:detection_score_1_1 ... float:detection_score_1_L" << endl;
+  cout << "  ..." << endl;
+  cout << "  float:detection_score_T_1 ... float:detection_score_T_L" << endl;
+  cout << "---------------------------- snip snip -------------------------------" << endl;
+  cout << endl;
+  cout << "As results, the command writes first the number of trajectories," << endl;
+  cout << "followed by one line per trajectory with the following structure:" << endl;
+  cout << endl;
+  cout << "---------------------------- snip snip -------------------------------" << endl;
+  cout << "  int:traj_number int:entrance_time int:duration float:score int:location_1 ... int:location_duration" << endl;
+  cout << "---------------------------- snip snip -------------------------------" << endl;
 }
 
 scalar_t diff_in_second(struct timeval *start, struct timeval *end) {
@@ -52,43 +97,57 @@ void do_tracking(istream *in_tracker) {
   timeval start_time, end_time;
   MTPTracker *tracker = new MTPTracker();
 
-  if(verbose) { cout << "Reading the tracking parameters." << endl; }
+  if(global.verbose) { cout << "Reading the tracking parameters." << endl; }
   tracker->read(in_tracker);
 
-  if(verbose) { cout << "Building the graph ... "; cout.flush(); }
-  gettimeofday(&start_time, 0);
+  if(global.verbose) {
+    cout << "Building the graph ... "; cout.flush();
+    gettimeofday(&start_time, 0);
+  }
   tracker->build_graph();
-  gettimeofday(&end_time, 0);
-  if(verbose) { cout << "done (" << diff_in_second(&start_time, &end_time) << "s)." << endl; }
+  if(global.verbose) {
+    gettimeofday(&end_time, 0);
+    cout << "done (" << diff_in_second(&start_time, &end_time) << "s)." << endl;
+  }
 
-  if(verbose) { cout << "Tracking ... "; cout.flush(); }
-  gettimeofday(&start_time, 0);
+  if(global.verbose) {
+    cout << "Tracking ... "; cout.flush();
+    gettimeofday(&start_time, 0);
+  }
   tracker->track();
-  gettimeofday(&end_time, 0);
-  if(verbose) { cout << "done (" << diff_in_second(&start_time, &end_time) << "s)." << endl; }
+  if(global.verbose) {
+    gettimeofday(&end_time, 0);
+    cout << "done (" << diff_in_second(&start_time, &end_time) << "s)." << endl;
+  }
 
-  if(strcmp(trajectory_filename, "")) {
-    ofstream out_traj(trajectory_filename);
+  if(global.trajectory_filename[0]) {
+    ofstream out_traj(global.trajectory_filename);
     tracker->write_trajectories(&out_traj);
-    if(verbose) { cout << "Wrote " << trajectory_filename << "." << endl; }
+    if(global.verbose) { cout << "Wrote " << global.trajectory_filename << "." << endl; }
   } else {
     tracker->write_trajectories(&cout);
   }
 
-  if(strcmp(graph_filename, "") != 0) {
-    ofstream out_dot(graph_filename);
+  if(global.graph_filename[0]) {
+    ofstream out_dot(global.graph_filename);
     tracker->print_graph_dot(&out_dot);
-    if(verbose) { cout << "Wrote " << graph_filename << "." << endl; }
+    if(global.verbose) { cout << "Wrote " << global.graph_filename << "." << endl; }
   }
 
   delete tracker;
 }
 
+enum
+{
+  OPT_HELP_FORMATS = CHAR_MAX + 1
+};
+
 static struct option long_options[] = {
   { "trajectory-file", 1, 0, 't' },
   { "graph-file", 1, 0, 'g' },
   { "help", no_argument, 0, 'h' },
   { "verbose", no_argument, 0, 'v' },
+  { "help-formats", no_argument, 0, OPT_HELP_FORMATS },
   { 0, 0, 0, 0 }
 };
 
@@ -96,30 +155,33 @@ int main(int argc, char **argv) {
   int c;
   int error = 0, show_help = 0;
 
-  // strncpy(trajectory_filename, "result.trj", FILENAME_SIZE);
-  strncpy(trajectory_filename, "", FILENAME_SIZE);
-  strncpy(graph_filename, "", FILENAME_SIZE);
-  verbose = 0;
+  strncpy(global.trajectory_filename, "", FILENAME_SIZE);
+  strncpy(global.graph_filename, "", FILENAME_SIZE);
+  global.verbose = 0;
 
-  while ((c = getopt_long(argc, argv, "t:g:hv",
-                          long_options, NULL)) != -1) {
+  while ((c = getopt_long(argc, argv, "t:g:hv", long_options, NULL)) != -1) {
 
     switch(c) {
 
     case 't':
-      strncpy(trajectory_filename, optarg, FILENAME_SIZE);
+      strncpy(global.trajectory_filename, optarg, FILENAME_SIZE);
       break;
 
     case 'g':
-      strncpy(graph_filename, optarg, FILENAME_SIZE);
+      strncpy(global.graph_filename, optarg, FILENAME_SIZE);
       break;
 
     case 'h':
       show_help = 1;
       break;
 
+    case OPT_HELP_FORMATS:
+      print_help_formats();
+      exit(EXIT_SUCCESS);
+      break;
+
     case 'v':
-      verbose = 1;
+      global.verbose = 1;
       break;
 
     default: