Project for the Self-Driving Car Engineer Nanodegree Program
A robot has been kidnapped and transported to a new location! Luckily it has a map of this location, a (noisy) GPS estimate of its initial location, and lots of (noisy) sensor and control data.
In this project, I implemented a 2 dimensional particle filter in C++. The particle filter will be given a map and some initial localization information (analogous to what a GPS would provide). At each time step the filter will also get observation and control data.
Once you have this repository on your machine, cd
into the repository's root directory and run the following commands from the command line:
> ./clean.sh
> ./build.sh
> ./run.sh
NOTE If you get any
command not found
problems, you will have to install the associated dependencies (for example, cmake)
If everything worked you should see something like the following output:
Time step: 2444 Cumulative mean weighted error: x .1 y .1 yaw .02 Runtime (sec): 38.187226 Success! Your particle filter passed!
Otherwise you might get
.
.
.
Time step: 100
Cumulative mean weighted error: x 39.8926 y 9.60949 yaw 0.198841
Your x error, 39.8926 is larger than the maximum allowable error, 1
The directory structure of this repository is as follows:
root
| build.sh
| clean.sh
| CMakeLists.txt
| README.md
| run.sh
|
|___data
| | control_data.txt
| | gt_data.txt
| | map_data.txt
| |
| |___observation
| | observations_000001.txt
| | ...
| | observations_002444.txt
|
|___src
| helper_functions.h
| main.cpp
| map.h
| particle_filter.cpp
| particle_filter.h
The only file I modified is particle_filter.cpp
in the src
directory. The file contains the scaffolding of a ParticleFilter
class and some associated methods.
The src/main.cpp
file contains the code that will actually be running the particle filter and calling the associated methods.
You can find the inputs to the particle filter in the data
directory.
map_data.txt
includes the position of landmarks (in meters) on an arbitrary Cartesian coordinate system. Each row has three columns
- x position
- y position
- landmark id
- Map data provided by 3D Mapping Solutions GmbH.
control_data.txt
contains rows of control data. Each row corresponds to the control data for the corresponding time step. The two columns represent
- vehicle speed (in meters per second)
- vehicle yaw rate (in radians per second)
The observation
directory includes around 2000 files. Each file is numbered according to the timestep in which that observation takes place.
These files contain observation data for all "observable" landmarks. Here observable means the landmark is sufficiently close to the vehicle. Each row in these files corresponds to a single landmark. The two columns represent:
- x distance to the landmark in meters (right is positive) RELATIVE TO THE VEHICLE.
- y distance to the landmark in meters (forward is positive) RELATIVE TO THE VEHICLE.
NOTE The vehicle's coordinate system is NOT the map coordinate system. Your code will have to handle this transformation.
The two things the grading code is looking for are:
- Accuracy: the particle filter should localize vehicle position and yaw to within the values specified in the parameters
max_translation_error
(maximum allowed error in x or y) andmax_yaw_error
insrc/main.cpp
. - Performance: the particle filter should complete execution within the time specified by
max_runtime
insrc/main.cpp
.