Skip to content

Commit

Permalink
Add overview diagram of the perception and rearrange README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Antonia committed Nov 13, 2024
1 parent 92b0377 commit 18318b4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 19 deletions.
Binary file added doc/assets/perception/perception_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 29 additions & 19 deletions doc/perception/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
# Documentation of perception component

This folder contains further documentation of the perception components.

1. [Vision Node](./vision_node.md)
- The Visison Node provides an adaptive interface that is able to perform object-detection and/or image-segmentation on multiple cameras at the same time.
2. [Position Heading Filter Debug Node](./position_heading_filter_debug_node.md)
3. [Kalman Filter](./kalman_filter.md)
4. [Position Heading Publisher Node](./position_heading_publisher_node.md)
5. [Distance to Objects](./distance_to_objects.md)
6. [Traffic Light Detection](./traffic_light_detection.md)
7. [Coordinate Transformation (helper functions)](./coordinate_transformation.md)
8. [Dataset Generator](./dataset_generator.md)
9. [Dataset Structure](./dataset_structure.md)
10. [Lidar Distance Utility](./lidar_distance_utility.md)
1. not used since paf22
11. [Efficient PS](./efficientps.md)
1. not used scince paf22 and never successfully tested

## Overview Localization
This folder contains documentation of the perception components.

In the following diagram you can see all the nodes and topics used in the perception to show how they work together.

![Perception Overview](../../doc/assets/perception/perception_overview.png)

## Object Detection / Distance and Segmentation

- [Vision Node](./vision_node.md)
- The Vision Node provides an adaptive interface that is able to perform object detection and/or image segmentation on multiple cameras at the same time.
- [Distance to Objects](./distance_to_objects.md)
- [Traffic Light Detection](./traffic_light_detection.md)
- [Dataset Generator](./dataset_generator.md)
- [Dataset Structure](./dataset_structure.md)

## Localization

An overview over the different nodes working together to localize the vehicle is provided in the [localization](./localization.md) file.

- [Kalman Filter](./kalman_filter.md)
- [Position Heading Publisher Node](./position_heading_publisher_node.md)
- [Position Heading Filter Debug Node](./position_heading_filter_debug_node.md)
- [Coordinate Transformation](./coordinate_transformation.md) (helper functions)

## Unused files

- [Lidar Distance Utility](./lidar_distance_utility.md)
- Not used since paf22
- [Efficient PS](./efficientps.md)
- Not used scince paf22 and never successfully tested

## Experiments

- The overview of performance evaluations is located in the [experiments](./experiments/README.md) folder.
The overview of performance evaluations is located in the [experiments](./experiments/README.md) folder.

0 comments on commit 18318b4

Please sign in to comment.