Skip to content

Commit

Permalink
Remove template comments from node documents (#608)
Browse files Browse the repository at this point in the history
* rename document file

* remove template comment
  • Loading branch information
satoshi-ota authored and 1222-takeshi committed Nov 30, 2021
1 parent eb9d5b5 commit 127cc61
Showing 1 changed file with 0 additions and 76 deletions.
76 changes: 0 additions & 76 deletions sensing/image_transport_decompressor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,6 @@ The `image_transport_decompressor` is a node that decompresses images.

## Inner-workings / Algorithms

<!-- Write how this package works. Flowcharts and figures are great. Add sub-sections as you like.
Example:
### Flowcharts
...(PlantUML or something)
### State Transitions
...(PlantUML or something)
### How to filter target obstacles
...
### How to optimize trajectory
...
-->

## Inputs / Outputs

### Input
Expand All @@ -42,68 +22,12 @@ Example:

## Parameters

<!-- Write parameters of this package.
Example:
### Node Parameters
| Name | Type | Description |
| ---------------------- | ---- | ------------------------------- |
| `output_debug_markers` | bool | whether to output debug markers |
### Core Parameters
| Name | Type | Description |
| -------------------- | ------ | -------------------------------------------------------------------- |
| `min_object_size_m` | double | minimum object size to be selected as avoidance target obstacles [m] |
| `avoidance_margin_m` | double | avoidance margin to obstacles [m] |
-->

## Assumptions / Known limits

<!-- Write assumptions and limitations of your implementation.
Example:
This algorithm assumes obstacles are not moving, so if they rapidly move after the vehicle started to avoid them, it might collide with them.
Also, this algorithm doesn't care about blind spots. In general, since too close obstacles aren't visible due to the sensing performance limit, please take enough margin to obstacles.
-->

## (Optional) Error detection and handling

<!-- Write how to detect errors and how to recover from them.
Example:
This package can handle up to 20 obstacles. If more obstacles found, this node will give up and raise diagnostic errors.
-->

## (Optional) Performance characterization

<!-- Write performance information like complexity. If it wouldn't be the bottleneck, not necessary.
Example:
### Complexity
This algorithm is O(N).
### Processing time
...
-->

## (Optional) References/External links

<!-- Write links you referred to when you implemented.
Example:
[1] {link_to_a_thesis}
[2] {link_to_an_issue}
-->

## (Optional) Future extensions / Unimplemented parts

<!-- Write future extensions of this package.
Example:
Currently, this package can't handle the chattering obstacles well. We plan to add some probabilistic filters in the perception layer to improve it.
Also, there are some parameters that should be global(e.g. vehicle size, max steering, etc.). These will be refactored and defined as global parameters so that we can share the same parameters between different nodes.
-->

0 comments on commit 127cc61

Please sign in to comment.