Enhancements error viz (#115)

eleniv3d · 9and3 · web-flow · commit f205939f1e1a · 2024-09-24T12:21:43.000+02:00
* ADD units in legend and decimals according to document units

* ADD x axis to histogram

* FIX metadata o_legend in DF_visualization

* FIX remove o_success form cvs exporter

* ADD Allow Viz component to show graphs per item

* FIX distances output of CloudMeshDistance to Tree

* FIX add Rhino import to resolve error when updating to 8.11.24254.15001

* FIX undo changes ro DF_Tester component

* FIX test pre-commits

* FIX cloudmeshdistance works for Faces, input can be tree or list

* ADD meshcloud distance calculation now handles non valid point clouds

* FIX: quick cleaning

---------

Co-authored-by: Andrea Settimi &lt;andreasettimi39@gmail.com&gt;
Co-authored-by: Andrea Settimi &lt;andrea.settimi@epfl.ch&gt;
diff --git a/src/gh/components/DF_cloud_mesh_distance/code.py b/src/gh/components/DF_cloud_mesh_distance/code.py
@@ -1,8 +1,7 @@
 #! python3
 
-import System
-
 import Rhino
+import Grasshopper
 from ghpythonlib.componentbase import executingcomponent as component
 from Grasshopper.Kernel import GH_RuntimeMessageLevel as RML
 
@@ -12,38 +11,52 @@
 
 
 class DFCloudMeshDistance(component):
+
     def RunScript(self,
-            i_cloud_source: System.Collections.Generic.List[Rhino.Geometry.PointCloud],
+            i_cloud_source: Grasshopper.DataTree[Rhino.Geometry.PointCloud],
             i_assembly,
             i_signed_flag: bool,
             i_swap: bool,
             i_analysis_resolution: float):
 
+        if i_cloud_source is None or i_assembly is None:
+            return None, None, None, None, None, None
+
         if i_analysis_resolution is None:
             scalef = diffCheck.df_util.get_doc_2_meters_unitf()
             i_analysis_resolution = 0.1 / scalef
 
+        # if the input is Gh tree, flatten it
+        flat_list = []
+        for branch in i_cloud_source.Branches:
+            flat_list.extend(list(branch))
+        i_cloud_list = flat_list
+
         # Based on cloud source input + beam size, decide whether to calculate joints or entire assembly and output respective message
-        if len(i_assembly.beams) == len(i_cloud_source):
+        if len(i_assembly.beams) == len(i_cloud_list):
             ghenv.Component.Message = "Per Beam"  # noqa: F821
             rh_mesh_target_list = [beam.to_mesh(i_analysis_resolution) for beam in i_assembly.beams]
-        elif len(i_assembly.all_joints) == len(i_cloud_source):
+        elif len(i_assembly.all_joints) == len(i_cloud_list):
             ghenv.Component.Message = "Per Joint"  # noqa: F821
             rh_mesh_target_list = [joint.to_mesh(i_analysis_resolution) for joint in i_assembly._all_joints]
+        elif len(i_assembly.all_joint_faces) == len(i_cloud_list):
+            ghenv.Component.Message = "Per Joint Face"  # noqa: F821
+            rh_mesh_target_list = [joint_face.to_mesh() for joint_face in i_assembly.all_joint_faces]
         else:
             ghenv.Component.AddRuntimeMessage(RML.Warning, "The input number of objects to compare matches neither the number of beams nor the number of joints")  # noqa: F821
             return None, None, None, None, None, None
 
         # conversion
-        siffed_df_cloud_source_list = []
-        siffed_rh_mesh_target_list = []
-        for i in range(len(i_cloud_source)):
-            if i_cloud_source[i] is not None:
-                siffed_df_cloud_source_list.append(df_cvt_bindings.cvt_rhcloud_2_dfcloud(i_cloud_source[i]))
-                siffed_rh_mesh_target_list.append(rh_mesh_target_list[i])
-
+        df_cloud_source_list = [df_cvt_bindings.cvt_rhcloud_2_dfcloud(i_cl_s) for i_cl_s in i_cloud_list]
 
         # calculate distances
         o_result = df_error_estimation.df_cloud_2_rh_mesh_comparison(siffed_df_cloud_source_list, siffed_rh_mesh_target_list, i_signed_flag, i_swap)
 
-        return o_result.distances, o_result.distances_rmse, o_result.distances_max_deviation, o_result.distances_min_deviation, o_result.distances_sd_deviation, o_result
+        # distances to tree
+        distances_tree = Grasshopper.DataTree[object]()
+        for i, sublist in enumerate(o_result.distances):
+            for j, item in enumerate(sublist):
+                path = Grasshopper.Kernel.Data.GH_Path(i)
+                distances_tree.Add(item, path)
+
+        return distances_tree, o_result.distances_rmse, o_result.distances_max_deviation, o_result.distances_min_deviation, o_result.distances_sd_deviation, o_result
diff --git a/src/gh/components/DF_cloud_mesh_distance/metadata.json b/src/gh/components/DF_cloud_mesh_distance/metadata.json
@@ -5,7 +5,7 @@
     "subcategory": "Analysis",
     "description": "Computes the distance between a point cloud and a mesh",
     "exposure": 4,
-    "instanceGuid": "eda01e34-b89b-4e3c-a9b6-0178a05ae81b",
+    "instanceGuid": "99422b2f-c143-43d8-a4b7-0a5fc803bffe",
     "ghpython": {
         "hideOutput": true,
         "hideInput": true,
diff --git a/src/gh/components/DF_csv_exporter/code.py b/src/gh/components/DF_csv_exporter/code.py
@@ -10,11 +10,12 @@
 
 class DFCsvExporter(component):
     def RunScript(self,
-        i_dump: bool,
-        i_export_dir: str,
-        i_file_name: str,
-        i_export_seperate_files: bool,
-        i_result: DFVizResults):
+                  i_dump: bool,
+                  i_export_dir: str,
+                  i_file_name: str,
+                  i_export_seperate_files: bool,
+                  i_result: DFVizResults):
+
         if i_dump:
             # Ensure the export directory exists
             os.makedirs(i_export_dir, exist_ok=True)
@@ -35,6 +36,12 @@ def RunScript(self,
                     for list_of_values in i_result.distances:
                         writer.writerow([list_of_values])
 
-            o_success = "Successfully exported the values"
-
-            return o_success
+# if __name__ == "__main__":
+#     com = DFCsvExporter()
+#     o_viz_settings = com.RunScript(
+#         i_dump,
+#         i_export_dir,
+#         i_file_name,
+#         i_export_seperate_files,
+#         i_result
+#         )
diff --git a/src/gh/components/DF_csv_exporter/metadata.json b/src/gh/components/DF_csv_exporter/metadata.json
@@ -74,15 +74,6 @@
                 "typeHintID": "ghdoc"
             }
         ],
-        "outputParameters": [
-            {
-                "name": "o_success",
-                "nickname": "o_success",
-                "description": "Whether the values exported successfully",
-                "optional": false,
-                "sourceCount": 0,
-                "graft": false
-            }
-        ]
+        "outputParameters": []
     }
 }
diff --git a/src/gh/components/DF_tester/metadata.json b/src/gh/components/DF_tester/metadata.json
@@ -5,7 +5,7 @@
     "subcategory": "Utility",
     "description": "This component is testing diffCheck imports and bindings.",
     "exposure": 4,
-    "instanceGuid": "7a600924-29bb-4682-8b95-a37752cefdbc",
+    "instanceGuid": "d0dcb2e4-a801-4c2d-9bd4-f2b03f3feb50",
     "ghpython": {
         "hideOutput": true,
         "hideInput": true,
diff --git a/src/gh/components/DF_visualization/code.py b/src/gh/components/DF_visualization/code.py
@@ -1,20 +1,23 @@
 #! python3
 
-
 import Rhino.Geometry as rg
 from ghpythonlib.componentbase import executingcomponent as component
 
-
 from diffCheck import df_cvt_bindings
 from diffCheck import df_visualization
 from diffCheck.df_visualization import DFVizSettings
 from diffCheck.df_error_estimation import DFVizResults
 from diffCheck import diffcheck_bindings
 
+
 class DFVisualization(component):
     def RunScript(self,
                   i_result: DFVizResults,
                   i_viz_settings: DFVizSettings):
+
+        if i_result is None or i_viz_settings is None:
+            return None, None, None
+
         values, min_value, max_value = i_result.filter_values_based_on_valuetype(i_viz_settings)
 
         # check if i_result.source is a list of pointclouds or a mesh
@@ -41,12 +44,21 @@ def RunScript(self,
                                                   width=i_viz_settings.legend_width,
                                                   total_height=i_viz_settings.legend_height)
 
+        # add option to create a histogram for each item
+
+        if len(i_result.source) > 1 and i_viz_settings.one_histogram_per_item:
+            multiple_curves = True
+        else:
+            multiple_curves = False
+
         o_histogram = df_visualization.create_histogram(values,
                                                         min_value,
                                                         max_value,
-                                                        steps=100,
+                                                        res=100,
+                                                        steps=10,
                                                         plane=i_viz_settings.legend_plane,
                                                         total_height=i_viz_settings.legend_height,
-                                                        scaling_factor=i_viz_settings.histogram_scale_factor)
+                                                        scaling_factor=i_viz_settings.histogram_scale_factor,
+                                                        multiple_curves = multiple_curves)
 
         return o_colored_geo, o_legend, o_histogram
diff --git a/src/gh/components/DF_visualization/metadata.json b/src/gh/components/DF_visualization/metadata.json
@@ -49,7 +49,7 @@
             },
             {
                 "name": "o_legend",
-                "nickname": "_legend",
+                "nickname": "o_legend",
                 "description": "The legend of the visualization",
                 "optional": false,
                 "sourceCount": 0,
diff --git a/src/gh/components/DF_visualization_settings/code.py b/src/gh/components/DF_visualization_settings/code.py
@@ -2,9 +2,7 @@
 
 import System
 import typing
-
 import Rhino
-
 from ghpythonlib.componentbase import executingcomponent as component
 import Grasshopper as gh
 from Grasshopper import Instances
@@ -182,7 +180,23 @@ def RunScript(self,
         i_legend_height: float,
         i_legend_width: float,
         i_legend_plane: Rhino.Geometry.Plane,
-        i_histogram_scale_factor: float):
+        i_histogram_scale_factor: float,
+        i_one_histogram_per_item: bool):
+
+        """
+        Compiles all the visualization settings to feed to the visualization component
+
+        :param i_value_type: selected type indicates Which values to display. Possible values: "dist", "RMSE", "MAX", "MIN", "STD"
+        :param i_palette: Select a color palette to map the values to. Possible values: "Jet", "Rainbow", "RdPu", "Viridis"
+        :param i_upper_threshold: Thresholds the values with a maximum value
+        :param i_lower_threshold: Thresholds the values with a minimum value
+        :param i_legend_height: the total height of the legend
+        :param i_legend_width: the total width of the legend
+        :param i_legend_plane: the construction plane of the legend
+        :param i_histogram_scale_factor: Scales the height of the histogram with a factor
+
+        :returns o_viz_settings: the results of the comparison all in one object
+        """
         # set default values
         if i_value_type is not None:
             if i_value_type not in self.poss_value_types:
@@ -204,6 +218,8 @@ def RunScript(self,
             i_legend_plane = Rhino.Geometry.Plane.WorldXY
         if i_histogram_scale_factor is None:
             i_histogram_scale_factor = 0.01
+        if i_one_histogram_per_item is None:
+            i_one_histogram_per_item = False
 
         # pack settings
         o_viz_settings = df_visualization.DFVizSettings(i_value_type,
@@ -213,6 +229,21 @@ def RunScript(self,
                                                         i_legend_height,
                                                         i_legend_width,
                                                         i_legend_plane,
-                                                        i_histogram_scale_factor)
+                                                        i_histogram_scale_factor,
+                                                        i_one_histogram_per_item)
 
         return o_viz_settings
+
+# if __name__ == "__main__":
+#     com = DFVisualizationSettings()
+#     o_viz_settings = com.RunScript(
+#         i_value_type,
+#         i_palette,
+#         i_upper_threshold,
+#         i_lower_threshold,
+#         i_legend_height,
+#         i_legend_width,
+#         i_legend_plane,
+#         i_histogram_scale_factor,
+#         i_one_histogram_per_item
+#         )
diff --git a/src/gh/components/DF_visualization_settings/metadata.json b/src/gh/components/DF_visualization_settings/metadata.json
@@ -108,6 +108,18 @@
                 "wireDisplay": "default",
                 "sourceCount": 0,
                 "typeHintID": "float"
+            },
+            {
+                "name": "i_one_histogram_per_item",
+                "nickname": "i_one_histogram_per_item",
+                "description": "make one curve per item",
+                "optional": false,
+                "allowTreeAccess": false,
+                "showTypeHints": true,
+                "scriptParamAccess": "item",
+                "wireDisplay": "default",
+                "sourceCount": 0,
+                "typeHintID": "float"
             }
         ],
         "outputParameters": [
diff --git a/src/gh/diffCheck/diffCheck.egg-info/PKG-INFO b/src/gh/diffCheck/diffCheck.egg-info/PKG-INFO
@@ -1,24 +1,25 @@
 Metadata-Version: 2.1
 Name: diffCheck
-Version: 0.0.36
+Version: 0.0.37
 Summary: DiffCheck is a package to check the differences between two timber structures
 Home-page: https://github.com/diffCheckOrg/diffCheck
 Author: Andrea Settimi, Damien Gilliard, Eleni Skevaki, Marirena Kladeftira, Julien Gamerro, Stefana Parascho, and Yves Weinand
 Author-email: andrea.settimi@epfl.ch
-License: UNKNOWN
-Description: # DiffCheck: CAD-Scan comparison
-        
-        diffCheck(DF) allows to identify discrepancies across point clouds and 3D models of both individually machined timber pieces featuring various joints as well as fully assembled timber structures. It can help you quantify the differences between the CAD and scanned fabricated structure, providing a comprehensive report that highlights the discrepancies.
-        
-        The software is designed to be user-friendly and can be used either via a Grasshopper plug-in or its Python API.
-        
-        Visit the [DiffCheck website](https://diffcheckorg.github.io/diffCheck/) for more information and documentation.
-        
-        ![alt text](demo.png)
-        
-        The software is developed by the [Laboratory of Timber Construction (IBOIS)](https://www.epfl.ch/labs/ibois/) and the [Laboratory for Creative Computation (CRCL)](https://www.epfl.ch/labs/crcl/) at [Polytechnique FÃ©dÃ©rale de Lausanne (EPFL)](https://www.epfl.ch/en/).
-Platform: UNKNOWN
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: pybind11>=2.5.0
+
+# DiffCheck: CAD-Scan comparison
+
+diffCheck(DF) allows to identify discrepancies across point clouds and 3D models of both individually machined timber pieces featuring various joints as well as fully assembled timber structures. It can help you quantify the differences between the CAD and scanned fabricated structure, providing a comprehensive report that highlights the discrepancies.
+
+The software is designed to be user-friendly and can be used either via a Grasshopper plug-in or its Python API.
+
+Visit the [DiffCheck website](https://diffcheckorg.github.io/diffCheck/) for more information and documentation.
+
+![alt text](demo.png)
+
+The software is developed by the [Laboratory of Timber Construction (IBOIS)](https://www.epfl.ch/labs/ibois/) and the [Laboratory for Creative Computation (CRCL)](https://www.epfl.ch/labs/crcl/) at [Polytechnique FÃ©dÃ©rale de Lausanne (EPFL)](https://www.epfl.ch/en/).
diff --git a/src/gh/diffCheck/diffCheck/df_error_estimation.py b/src/gh/diffCheck/diffCheck/df_error_estimation.py
@@ -28,12 +28,16 @@ def df_cloud_2_rh_mesh_comparison(cloud_source_list, rhino_mesh_target_list, sig
     results = DFVizResults()
 
     for source, target in zip(cloud_source_list, rhino_mesh_target_list):
-        if swap:
-            # this mean we want to visualize the result on the target mesh
-            distances = rh_mesh_2_df_cloud_distance(target, source, signed_flag)
+
+        if len(source.points) == 0:
+            distances = np.empty(0)
         else:
-            # this means we want to visualize the result on the source pcd
-            distances = df_cloud_2_rh_mesh_distance(source, target, signed_flag)
+            if swap:
+                # this mean we want to visualize the result on the target mesh
+                distances = rh_mesh_2_df_cloud_distance(target, source, signed_flag)
+            else:
+                # this means we want to visualize the result on the source pcd
+                distances = df_cloud_2_rh_mesh_distance(source, target, signed_flag)
 
         if swap:
             results.add(target, source, distances)
@@ -135,18 +139,27 @@ def add(self, source, target, distances):
         self.source.append(source)
         self.target.append(target)
 
-        self.distances_rmse.append(np.sqrt(np.mean(distances ** 2)))
-        self.distances_max_deviation.append(np.max(distances))
-        self.distances_min_deviation.append(np.min(distances))
-        self.distances_sd_deviation.append(np.std(distances))
-        self.distances.append(distances.tolist())
+        if distances.size == 0:
+            self.distances_rmse.append(None)
+            self.distances_max_deviation.append(None)
+            self.distances_min_deviation.append(None)
+            self.distances_sd_deviation.append(None)
+            self.distances.append(np.empty(0))
+        else:
+            self.distances_rmse.append(np.sqrt(np.mean(distances ** 2)))
+            self.distances_max_deviation.append(np.max(distances))
+            self.distances_min_deviation.append(np.min(distances))
+            self.distances_sd_deviation.append(np.std(distances))
+            self.distances.append(distances.tolist())
 
     def filter_values_based_on_valuetype(self, settings):
 
         if settings.valueType == "Dist":
 
-            min_value = min(min(sublist) for sublist in self.distances)
-            max_value = max(max(sublist) for sublist in self.distances)
+            valid_sublists = [sublist for sublist in self.distances if len(sublist) > 0]
+
+            min_value = min(min(sublist) for sublist in valid_sublists)
+            max_value = max(max(sublist) for sublist in valid_sublists)
             values = self.distances
 
         elif settings.valueType == "RMSE":
diff --git a/src/gh/diffCheck/diffCheck/df_visualization.py b/src/gh/diffCheck/diffCheck/df_visualization.py
diff --git a/src/gh/examples/error_viz_tester_components.ghx b/src/gh/examples/error_viz_tester_components.ghx

Original file line number	Diff line number	Diff line change
`@@ -74,15 +74,6 @@`
`74`	`74`	`"typeHintID": "ghdoc"`
`75`	`75`	`}`
`76`	`76`	`],`
`77`		`- "outputParameters": [`
`78`		`- {`
`79`		`- "name": "o_success",`
`80`		`- "nickname": "o_success",`
`81`		`- "description": "Whether the values exported successfully",`
`82`		`- "optional": false,`
`83`		`- "sourceCount": 0,`
`84`		`- "graft": false`
`85`		`- }`
`86`		`- ]`
	`77`	`+ "outputParameters": []`
`87`	`78`	`}`
`88`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@`
`49`	`49`	`},`
`50`	`50`	`{`
`51`	`51`	`"name": "o_legend",`
`52`		`- "nickname": "_legend",`
	`52`	`+ "nickname": "o_legend",`
`53`	`53`	`"description": "The legend of the visualization",`
`54`	`54`	`"optional": false,`
`55`	`55`	`"sourceCount": 0,`