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

fix(perception): fix perception docs #9766

Merged
merged 9 commits into from
Dec 25, 2024
8 changes: 8 additions & 0 deletions perception/autoware_object_merger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,16 @@ The successive shortest path algorithm is used to solve the data association pro

## Parameters

- object association merger

{{ json_to_markdown("perception/autoware_object_merger/schema/object_association_merger.schema.json") }}

- data association matrix

{{ json_to_markdown("perception/autoware_object_merger/schema/data_association_matrix.schema.json") }}

- overlapped judge

{{ json_to_markdown("perception/autoware_object_merger/schema/overlapped_judge.schema.json") }}

## Tips
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,81 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Data Association Matrix Parameters",
"type": "object",
"properties": {
"ros__parameters": {
"definitions": {
"data_association_matrix": {
"type": "object",
"properties": {
"can_assign_matrix": {
"type": "array",
"items": {
"type": "number"
},
"description": "Assignment table for data association"
"description": "Assignment table for data association.",
"default": [
0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1,
0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0,
0, 0, 0, 1, 1, 1
]
},
"max_dist_matrix": {
"type": "array",
"items": {
"type": "number"
},
"description": "Maximum distance table for data association"
"description": "Maximum distance table for data association.",
"default": [
4.0, 4.0, 5.0, 5.0, 5.0, 2.0, 2.0, 2.0, 4.0, 2.0, 5.0, 5.0, 5.0, 1.0, 1.0, 1.0, 5.0,
5.0, 5.0, 5.0, 5.0, 1.0, 1.0, 1.0, 5.0, 5.0, 5.0, 5.0, 5.0, 1.0, 1.0, 1.0, 5.0, 5.0,
5.0, 5.0, 5.0, 1.0, 1.0, 1.0, 2.0, 1.0, 1.0, 1.0, 1.0, 3.0, 3.0, 3.0, 2.0, 1.0, 1.0,
1.0, 1.0, 3.0, 3.0, 3.0, 2.0, 1.0, 1.0, 1.0, 1.0, 3.0, 3.0, 2.0
]
},
"max_rad_matrix": {
"type": "array",
"items": {
"type": "number"
"type": "number",
"minimum": 0.0
},
"description": "Maximum angle table for data association. If value is greater than pi, it will be ignored."
"description": "Maximum angle table for data association. If value is greater than pi, it will be ignored.",
"default": [
3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 1.047, 1.047, 1.047, 1.047, 3.15,
3.15, 3.15, 3.15, 1.047, 1.047, 1.047, 1.047, 3.15, 3.15, 3.15, 3.15, 1.047, 1.047,
1.047, 1.047, 3.15, 3.15, 3.15, 3.15, 1.047, 1.047, 1.047, 1.047, 3.15, 3.15, 3.15,
3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15,
3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15, 3.15
]
},
"min_iou_matrix": {
"type": "array",
"items": {
"type": "number"
"type": "number",
"minimum": 0.0
},
"description": "Minimum IoU threshold matrix for data association. If value is negative, it will be ignored."
"description": "Minimum IoU threshold matrix for data association. If value is negative, it will be ignored.",
"default": [
0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.3, 0.2, 0.2, 0.2, 0.1, 0.1, 0.1, 0.1,
0.2, 0.3, 0.3, 0.3, 0.1, 0.1, 0.1, 0.1, 0.2, 0.3, 0.3, 0.3, 0.1, 0.1, 0.1, 0.1, 0.2,
0.3, 0.3, 0.3, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1,
0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1
]
}
},
"required": ["can_assign_matrix", "max_dist_matrix", "max_rad_matrix", "min_iou_matrix"],
"additionalProperties": false
}
},
"properties": {
"/**": {
"type": "object",
"properties": {
"ros__parameters": {
"$ref": "#/definitions/data_association_matrix"
}
},
"required": ["can_assign_matrix", "max_dist_matrix", "max_rad_matrix", "min_iou_matrix"]
"required": ["ros__parameters"],
"additionalProperties": false
}
}
},
"required": ["/**"],
"additionalProperties": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"remove_overlapped_unknown_objects",
"base_link_frame_id",
"priority_mode"
]
],
"additionalProperties": false
}
},
"properties": {
Expand All @@ -56,8 +57,10 @@
"$ref": "#/definitions/object_association_merger"
}
},
"required": ["ros__parameters"]
"required": ["ros__parameters"],
"additionalProperties": false
}
},
"required": ["/**"]
"required": ["/**"],
"additionalProperties": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,45 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Overlapped Judge Parameters",
"type": "object",
"properties": {
"ros__parameters": {
"definitions": {
"overlapped_judge": {
"type": "object",
"properties": {
"distance_threshold_list": {
"type": "array",
"items": {
"type": "number"
},
"description": "Distance threshold for each class used in judging overlap."
"description": "Distance threshold for each class used in judging overlap.",
"default": [9.0, 9.0, 9.0, 9.0, 9.0, 9.0, 9.0, 9.0]
},
"generalized_iou_threshold": {
"type": "array",
"items": {
"type": "number"
"type": "number",
"minimum": -1.0,
"maximum": 1.0
},
"description": "Generalized IoU threshold for each class."
"description": "Generalized IoU threshold for each class.",
"default": [-0.1, -0.1, -0.1, -0.6, -0.6, -0.1, -0.1, -0.1]
}
},
"required": ["distance_threshold_list", "generalized_iou_threshold"],
"additionalProperties": false
}
},
"properties": {
"/**": {
"type": "object",
"properties": {
"ros__parameters": {
"$ref": "#/definitions/overlapped_judge"
}
},
"required": ["distance_threshold_list", "generalized_iou_threshold"]
"required": ["ros__parameters"],
"additionalProperties": false
}
}
},
"required": ["/**"],
"additionalProperties": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following video is a sample. Yellow points are high occupancy probability, g

## Parameters

{{ json_to_markdown("perception/occupancy_grid_map_outlier_filter/schema/occupancy_grid_map_outlier_filter.schema.json") }}
{{ json_to_markdown("perception/autoware_occupancy_grid_map_outlier_filter/schema/occupancy_grid_map_outlier_filter.schema.json") }}

## Assumptions / Known limits

Expand Down
29 changes: 23 additions & 6 deletions perception/autoware_probabilistic_occupancy_grid_map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,29 @@ You may need to choose `scan_origin_frame` and `gridmap_origin_frame` which mean

### Parameters

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/binary_bayes_filter_updater.schema.json") }}
{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/grid_map.schema.json") }}
{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/laserscan_based_occupancy_grid_map.schema.json") }}
{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/multi_lidar_pointcloud_based_occupancy_grid_map.schema.json") }}
{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/pointcloud_based_occupancy_grid_map.schema.json") }}
{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/synchronized_grid_map_fusion_node.schema.json") }}
- binary bayes filter updater

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/binary_bayes_filter_updater.schema.json") }}

- grid map

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/grid_map.schema.json") }}

- laserscan based occupancy grid map

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/laserscan_based_occupancy_grid_map.schema.json") }}

- multi lidar pointcloud based occupancy grid map

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/multi_lidar_pointcloud_based_occupancy_grid_map.schema.json") }}

- pointcloud based occupancy grid map

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/pointcloud_based_occupancy_grid_map.schema.json") }}

- synchronized grid map fusion

{{ json_to_markdown("perception/autoware_probabilistic_occupancy_grid_map/schema/synchronized_grid_map_fusion_node.schema.json") }}

### Downsample input pointcloud(Optional)

Expand Down
Loading
Loading