Skip to content

Commit a77c835

Browse files
Update: README.md with component diagram
1 parent e8f6cd7 commit a77c835

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,41 @@ To prototype:
7373

7474
See the [CONTRIBUTING.md](https://github.com/diffCheckOrg/diffCheck/blob/main/CONTRIBUTING.md) for more information on how to prototype with diffCheck (code guidelines, visualizer, utilities, etc).
7575

76+
## Component roadmap
77+
From the 3/5/2024 meeting, the architecture of the different grasshopper components was discussed as following:
78+
[] PLY loader : loads the ply files and converts them in RhinoCommon objects
79+
[] Global registration & refined registration to align the scan to the reference model
80+
[] Semantic segmentation to identify the pieces or joints in the point cloud
81+
[] Per-joint refinement to refine the global registration to each joints (only in the "substractive" case)
82+
[] Error estimation to evaluate the error for each piece or joint
83+
[] Error visualisation to visualise the error, only converts the data from error estimation, no calculation.
84+
The brep element in the graph is only here to visualize the fact that we need the breps as data, but it is not a diffCheck component.
85+
86+
87+
```mermaid
88+
stateDiagram
89+
90+
classDef notAComponent fill:green
91+
(brep):::notAComponent --> global_registration&ICP : [brep]
92+
State diffCheck{
93+
State for_additive_and_substractive {
94+
PLY_loader --> global_registration&ICP : pointcloud
95+
global_registration&ICP --> semantic_segmentation : pointcloud
96+
global_registration&ICP --> semantic_segmentation : [brep]
97+
semantic_segmentation --> error_estimation : [pointcloud]
98+
semantic_segmentation --> error_estimation : [brep]
99+
semantic_segmentation --> error_visualisation : [pointcloud]
100+
semantic_segmentation --> error_visualisation : [brep]
101+
semantic_segmentation --> per_joint_refinement : [pointcloud]
102+
semantic_segmentation --> per_joint_refinement : [brep]
103+
error_estimation --> error_visualisation : csv
104+
per_joint_refinement --> error_estimation : [[pointcloud]]
105+
per_joint_refinement --> error_estimation : [brep]
106+
}
107+
State for_substractive {
108+
per_joint_refinement
109+
}
110+
}
111+
112+
```
113+
Note : `[]` = list

0 commit comments

Comments
 (0)