Skip to content

Fix link to license file #23

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

Open
antonellla wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix link to license file #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f4f66a
update license link in readme for doxygen
antonellla Jun 22, 2025
7ba2c50
link to license file in master branch
antonellla Jun 22, 2025
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `radar_grid_map` node listens to radar sector messages, applies optional nea

The `particle_filter` node spawns particles with random position and course angle where radar returns are detected. It iteratively updates particle weights until the filter converges on a stable estimate of position and course for each target. Large blobs (e.g., shorelines) are filtered out based on a configurable `maximum_target_size`. The node continuously spawns new particles so the filter can quickly react to newly detected objects. A set of particle statistics is also published to optimize tracking performance.

Complete API documentation is available at:
Complete API documentation is available at:
👉 [https://seawardscience.github.io/echoflow/](https://seawardscience.github.io/echoflow/)

---
Expand Down Expand Up @@ -304,7 +304,7 @@ The `radar_grid_map` includes the following layers:

- **edt** – Euclidean Distance Transform used to compute proximity to filtered targets.
- **intensity** – Raw radar return intensity.
- **targets** – The grid map filtered by the `maximum_target_size` parameter.
- **targets** – The grid map filtered by the `maximum_target_size` parameter.
- This is the input to the particle filter and the EDT computation.

![Radar grid map EDT visualization](docs/media/rviz/echoflow_rviz_radar_grid_map_edt.png)
Expand All @@ -318,7 +318,7 @@ This display shows an occupancy map of the current grid map, showing where on th

### Particle Cloud

This display shows a `PointCloud2` visualization of the particles spawned on the map.
This display shows a `PointCloud2` visualization of the particles spawned on the map.
You can select different channels as the color transform to visualize various particle metrics:

- **speed** – Particle's estimated speed.
Expand Down Expand Up @@ -379,7 +379,7 @@ All necessary packages can be installed by the following:

## License

This project is licensed under the [LICENSE](LICENSE) provided in this repository.
This project is licensed under the [LICENSE](https://github.com/SeawardScience/echoflow/blob/master/LICENSE) provided in this repository.

---

Expand Down