Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ar-Ray-code committed Nov 19, 2023
1 parent 6335681 commit c0e4a4f
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,40 @@
# PanelDetector
Panel detection node for CoRE-1 2024

## Node Structure

### Topic (Subscribe)

| Topic Name | Type | Description |
| --- | --- | --- |
| image_raw | sensor_msgs/msg/Image | Raw image from camera |

### Topic (Publish)

| Topic Name | Type | Description |
| --- | --- | --- |
| positions | geometry_msgs/msg/Detection2DArray | Detected panel poses |

### Class Diagram

```mermaid
---
title: Panel Detector Plugin hierarchy
---
classDiagram
PanelDetectorNode <-- DetectorA : load as dll
PanelDetectorNode <-- DetectorB : load as dll
DetectorA <|-- DetectorBase : include
DetectorB <|-- DetectorBase : include
PanelDetectorNode <-- DetectorPluginA : load as dll
PanelDetectorNode <-- DetectorPluginB : load as dll
DetectorPluginA <|-- DetectorBase : include
DetectorPluginB <|-- DetectorBase : include
PanelDetectorNode <|-- DetectorBase : include
PanelDetectorNode: params
PanelDetectorNode: image_callback(Image)
class DetectorA{
class DetectorPluginA{
filter_kernel_param_a
init(params)
processing(cv::Mat)
}
class DetectorB{
class DetectorPluginB{
filter_kernel_param_b
init(params)
processing(cv::Mat)
Expand Down

0 comments on commit c0e4a4f

Please sign in to comment.