diff README @ 81:895807396119

updated readme
author Nicolas Saunier <nicolas.saunier@polymtl.ca>
date Mon, 14 Mar 2011 00:37:10 -0400
parents 9a51372607d6
children 76735aeab807
line wrap: on
line diff
--- a/README	Sun Mar 13 17:18:17 2011 -0400
+++ b/README	Mon Mar 14 00:37:10 2011 -0400
@@ -4,16 +4,20 @@
 
 - pieces of C++ code under the c directory, mostly examples related to the use of computer vision libraries, namely OpenCV and KLT (http://www.ces.clemson.edu/~stb/klt)
 
-- python modules that provide classes for trajectories and moving objects (objects with some characteristics and a trajectory)
+- python modules that provide classes for trajectories and moving objects (objects with some characteristics and a trajectory), as well as some basic code for simple traffic engineering problems (fundamental diagram and traffic signal timing). 
 
-Example:
+An Example:
 
 The main use case and example for now is to load and analyze trajectory data from the NGSIM project (ngsim-community.org). In a ipython shell with the pylab option, you can try the following (once the python modules are in your python path). 
 
-import storage
-objects = storage.loadNgsimFile('./trajectories-0400-0415.txt',100)
-for o in objects: o.draw()
+$ import storage
+$ objects = storage.loadNgsimFile('./trajectories-0400-0415.txt',100)
+$ for o in objects: o.draw()
+
+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: 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
+
 Contact me at nicolas.saunier@polymtl.ca and learn more about my work at http://nicolas.saunier.confins.net.
\ No newline at end of file