Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add overview diagram of the perception and rearrange README file #501

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add overview diagram of the perception and rearrange README file #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18318b4
Add overview diagram of the perception and rearrange README file
Nov 13, 2024
b506f0e
Add camera to overview diagram and adjust the vision node summary sen…
Dec 9, 2024
0286e81
Merge branch 'main' into 500-general-add-an-overview-of-the-perceptio…
asamluka Dec 15, 2024
6e2ac95
Merge branch 'main' into 500-general-add-an-overview-of-the-perceptio…
asamluka Dec 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added doc/assets/perception/perception_overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 32 additions & 21 deletions doc/perception/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
# 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
# Documentation of Perception

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 image segmentation on multiple cameras at the same time
(even though only one camera perceiving the front of the car is active at the moment).
- [Distance to Objects](./distance_to_objects.md)
Comment on lines +11 to +13
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Clarify Vision Node capabilities

Based on previous discussions, the description should be more precise about the current capabilities:

-- The Vision Node provides an adaptive interface that is able to perform object detection and image segmentation on multiple cameras at the same time
-  (even though only one camera perceiving the front of the car is active at the moment).
++ The Vision Node provides an adaptive interface that can perform object detection and image segmentation
+  (currently configured for a single front-facing camera).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [Vision Node](./vision_node.md)
- The Vision Node provides an adaptive interface that is able to perform object detection and image segmentation on multiple cameras at the same time
(even though only one camera perceiving the front of the car is active at the moment).
- [Vision Node](./vision_node.md)
- The Vision Node provides an adaptive interface that can perform object detection and image segmentation
(currently configured for a single front-facing camera).
🧰 Tools
🪛 LanguageTool

[style] ~12-~12: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ode provides an adaptive interface that is able to perform object detection and image segm...

(BE_ABLE_TO)

[style] ~13-~13: For conciseness, consider replacing this expression with an adverb.
Context: ...rceiving the front of the car is active at the moment). - [Distance to Objects](./distance_to...

(AT_THE_MOMENT)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You basically just rephrased the sentence. The centrally meaning is the same.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asamluka Understood. Thank you for the feedback.

- [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.
Loading