Skip to content

docs(autoware_traffic_light_visualization): correct the ROI inputs and the missing parameter - #13474

Merged
kentdotn merged 2 commits into
autowarefoundation:mainfrom
kentdotn:docs/traffic-light-roi-visualizer-inputs-and-parameters
Oct 13, 2026
Merged

kentdotn merged 2 commits into
autowarefoundation:mainfrom
kentdotn:docs/traffic-light-roi-visualizer-inputs-and-parameters

Conversation

@kentdotn

@kentdotn kentdotn commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Description

Purpose

Three corrections found while separating the drawing from the node, kept out of that PR because none of them had to happen before the move. Nothing observable changes, and the whole diff is 14 lines, so it reads in one go rather than commit by commit.

What is corrected

The README named the wrong source for ~/input/rois. It said autoware_traffic_light_fine_detector, which is right in one of the three detection chains autoware_launch ships. traffic_light_detector_rough.launch.xml feeds that topic from the map based detector, and traffic_light_detector_whole_image.launch.xml from the selector. What is constant is the shape of the wiring: ~/input/rois is the last stage of the chain and ~/input/rough/rois the stage before it, connected only when there is one - which is also when use_high_accuracy_detection is true.

use_high_accuracy_detection was missing from the parameter file and the schema. It is declared without a default, so the node refuses to start unless it is given, yet only the launch file mentioned it. Both now list it, with the value the launch file already defaults to.

image_roi_callback() had a [[maybe_unused]] on an argument it does use. Dropped.

Related links

Parent Issue:

  • None

Builds on #13454, now merged, so this sits on main.

How was this PR tested?

From the CI-equivalent dev container (ghcr.io/autowarefoundation/autoware:universe-dependencies-jazzy):

colcon build --packages-select autoware_traffic_light_visualization \
  --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo
colcon test --packages-select autoware_traffic_light_visualization \
  --event-handlers console_direct+
  • 126 tests, 0 failures, at each commit.
  • pre-commit passes, including the JSON schema validation the schema change touches.

Notes for reviewers

  • The parameter file is not loaded by this package's own launch file; it is the file the node's system design format entry points at. Adding the parameter there changes nothing at runtime, because the launch file passes the same value explicitly.

Interface changes

None. The parameter was already required; it is now documented.

Effects on system behavior

None.

🤖 Generated with Claude Code

kentdotn and others added 2 commits October 9, 2026 11:09
…ly feeds each ROI input

The README named the fine detector as the source of ~/input/rois, but that is true in only one of
the three detection chains autoware_launch ships. traffic_light_detector_rough.launch.xml feeds the
map based detector's ROIs straight into ~/input/rois, and traffic_light_detector_whole_image.launch
.xml feeds the selector's. What is actually constant is the shape of the wiring: ~/input/rois is
the last stage of the chain and ~/input/rough/rois is the stage before it, connected only when
there is one - which is also when use_high_accuracy_detection is true.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Kentaro NAGATOMO <kentaro.nagatomo@tier4.jp>
…er parameters that were missing

use_high_accuracy_detection is declared without a default, so the node refuses to start unless it
is given, yet neither the parameter file nor the schema mentioned it - only the launch file did.
List it in both, with the value the launch file already defaults to, and drop the [[maybe_unused]]
on image_roi_callback's traffic signal argument, which the callback does use.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Kentaro NAGATOMO <kentaro.nagatomo@tier4.jp>
@github-actions github-actions Bot added type:documentation Creating or refining documentation. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) labels Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@kentdotn kentdotn added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Oct 9, 2026
@codecov

codecov Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.56%. Comparing base (dc1fcea) to head (5f4951b).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13474      +/-   ##
==========================================
- Coverage   37.57%   37.56%   -0.01%     
==========================================
  Files        2025     2025              
  Lines      141921   141921              
==========================================
- Hits        53320    53319       -1     
- Misses      88601    88602       +1     
Flag Coverage Δ *Carryforward flag
daily ?
full-suite 37.56% <ø> (ø) Carriedforward from dc1fcea

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sasakisasaki sasakisasaki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you for updating the document. Let me approve this PR 👍

@kentdotn
kentdotn marked this pull request as ready for review October 13, 2026 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:perception Advanced sensor data processing and environment understanding. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants