diff c/feature-based-tracking.cpp @ 117:fea680fb03ee

created main feature based tracking file and minimum doxygen documentation
author Nicolas Saunier <nicolas.saunier@polymtl.ca>
date Tue, 09 Aug 2011 15:10:31 -0400
parents
children 45a426552aaa
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/c/feature-based-tracking.cpp	Tue Aug 09 15:10:31 2011 -0400
@@ -0,0 +1,38 @@
+
+
+using namespace std;
+
+int main(int argc, char *argv[]) {
+
+  return 0;
+}
+
+
+/* ------------------ DOCUMENTATION ------------------ */
+
+
+/*! \mainpage 
+
+This project is a collection of software tools for transportation called Traffic Intelligence. Other documents are:
+
+- \ref feature_based_tracking
+
+The code is partially self-described using the doxygen tool and comment formatting. The documentation can be extracted using doxygen, typing \c doxygen in the main directory (or <tt>make doc</tt> on a system with the Makefile tool installed). 
+
+*/
+
+/*! \page feature_based_tracking Feature-based Tracking: User Manual
+
+This document describes a software tool for object tracking in video data, developed for road traffic monitoring and safety diagnosis. It is part of a larger collection of software tools for transportation called Traffic Intelligence. 
+
+The tool relies on feature-based tracking, a robust object tracking methods, particularly suited for the extraction of traffic data such as trajectories and speeds. The best description of this method is given in <a href="http://nicolas.saunier.confins.net/data/saunier06crv.html">this paper</a>. The program has a command line interface and this document will shortly explain how to use the tool. Keep in mind this is a work in progress and major changes are continuously being made. 
+
+\section License
+
+The code is licensed under the MIT open source license (http://www.opensource.org/licenses/mit-license).
+
+If you make use of this piece of software, please cite one of my paper, e.g. N. Saunier, T. Sayed and K. Ismail. Large Scale Automated Analysis of Vehicle Interactions and Collisions. Transportation Research Record: Journal of the Transportation Research Board, 2147:42-50, 2010. I would be very happy in any case to know about any use of the code, and to discuss any opportunity for collaboration. 
+
+Contact me at nicolas.saunier@polymtl.ca and learn more about my work at http://nicolas.saunier.confins.net.
+
+*/