diff README @ 80:9a51372607d6

added MIT license to the project
author Nicolas Saunier <nicolas.saunier@polymtl.ca>
date Sun, 13 Mar 2011 17:18:17 -0400
parents
children 895807396119
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Mar 13 17:18:17 2011 -0400
@@ -0,0 +1,19 @@
+This work is a set of tools developed by Nicolas Saunier for transportation analysis, in particular road traffic. The tool resolves around the most typical transportation data type, trajectories, i.e. temporal series of positions. The original work targeted automated road safety analysis using video sensors. 
+
+This piece of software is at a very early stage and does not really provide any finished tool. It contains:
+
+- 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)
+
+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()
+
+The code is licensed under the MIT open source license (http://www.opensource.org/licenses/mit-license).
+
+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