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.

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

Improve the package quality of copied scan_ground_filter (from autoware.universe) package #321

Open
3 of 6 tasks
sasakisasaki opened this issue Mar 26, 2025 · 0 comments
Open
3 of 6 tasks
Assignees
Labels
type:documentation Creating or refining documentation. (auto-assigned) type:improvement Proposed enhancement

Comments

@sasakisasaki
Copy link
Contributor

sasakisasaki commented Mar 26, 2025

Checklist

  • I've read the contribution guidelines.
  • I've searched other issues and no duplicate issues were found.
  • I've agreed with the maintainers that I can plan this task.

Description

This PR provides a feature that of scan_ground_filter in autoware.universe. But the PR contains files that of just a copy from the autoware.universe side. So, let me plan for refactoring.

Goals of Refactoring

  • Improve overall code readability and maintainability.
  • Enrich documentation to aid future development and understanding
    • This is also for defining the logic and behavior so all the developers can have the same understanding.
  • Validate functionality and performance through systematic testing.

Current Issues

Functional Issues

  • Lack of test coverage for certain edge cases.
    • e.g. Empty pointcloud
  • Difficult to verify correctness of existing logic due to lack of documentation.
    • e.g. What kind of pointcloud is valid and not for input

Refactoring Actions

  • Improve separation of functionalities and modularity.
  • Rename variables and functions for easy-to-understand.
  • Remove dead code and reduce duplication.

Documentation Improvements

  • Create or update the following documentation:
    • Specification: Describe the expected behavior and data flow.
    • Tested Cases: List the scenarios that have been tested.
    • Limitations: Note known limitations and non-supported scenarios.
    • Design Rationale: Explain key architectural decisions, if applicable.

Testing Strategy

  • Unit Tests

    • Run all implemented tests in CI as we are doing.
  • Real Vehicle Testing

    • Conduct tests in real vehicle conditions.
    • Evaluate and record:
      • Ground removal results
      • Inference time
      • Memory usage
    • Summarize these findings and include them in the final PR.

Purpose

Package quality improvement as above

Possible approaches

Described in "Plan for Refactoring" in "Description" above

Definition of done

All the "Goals of Refactoring" are achieved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Creating or refining documentation. (auto-assigned) type:improvement Proposed enhancement
Projects
Development

No branches or pull requests

1 participant