annotate README @ 252:933e400ee53b

hgignore mis à jour
author Jeep-Tour@Jeep-Tour-PC
date Mon, 23 Jul 2012 12:30:09 -0400
parents 76735aeab807
children e34698d93b23
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
82
76735aeab807 corrected typo in readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 81
diff changeset
1 This work is a set of tools developed by Nicolas Saunier for transportation analysis, in particular road traffic. The tool revolves 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.
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
2
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
3 This piece of software is at a very early stage and does not really provide any finished tool. It contains:
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
4
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
5 - 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)
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
6
81
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
7 - 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).
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
8
81
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
9 An Example:
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
10
82
76735aeab807 corrected typo in readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 81
diff changeset
11 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 type the following (once the python modules are in your python path).
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
12
81
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
13 $ import storage
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
14 $ objects = storage.loadNgsimFile('./trajectories-0400-0415.txt',100)
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
15 $ for o in objects: o.draw()
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
16
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
17 License:
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
18
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
19 The code is licensed under the MIT open source license (http://www.opensource.org/licenses/mit-license).
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
20
82
76735aeab807 corrected typo in readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 81
diff changeset
21 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. I would be very happy in any case to know about any use of the code, and to discuss any opportunity for collaboration.
81
895807396119 updated readme
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents: 80
diff changeset
22
80
9a51372607d6 added MIT license to the project
Nicolas Saunier <nicolas.saunier@polymtl.ca>
parents:
diff changeset
23 Contact me at nicolas.saunier@polymtl.ca and learn more about my work at http://nicolas.saunier.confins.net.