WIP FIX first round of corrections based on PR

Author: eleniv3d

src/gh/components/DF_cloud_cloud_distance/code.py

@@ -29,7 +29,7 @@ def RunScript(self,
             :param i_cloud_target: a list of target point cloud to calculate distances to
 
             :return o_distances : list of calculated distances for each point
-            :return o_mse: the average squared difference between corresponding points of source and target
+            :return o_rmse: the root mean squared error between corresponding points of source and target
             :return o_max_deviation: the max deviation between source and target
             :return o_min_deviation: the min deviation between source and target
             :return o_std_deviation: the standard deviation between source and target
@@ -53,12 +53,12 @@ def RunScript(self,
         # calculate distances
         o_results = df_error_estimation.cloud_2_cloud_comparison(df_cloud_source_list, df_cloud_target_list)
 
-        return o_results.distances, o_results.distances_mse, o_results.distances_max_deviation, o_results.distances_min_deviation, o_results.distances_sd_deviation, o_results
+        return o_results.distances, o_results.distances_rmse, o_results.distances_max_deviation, o_results.distances_min_deviation, o_results.distances_sd_deviation, o_results
 
 
 # if __name__ == "__main__":
 #     com = CloudCloudDistance()
-#     o_distances, o_mse, o_max_deviation, o_min_deviation, o_std_deviation, o_results = com.RunScript(
+#     o_distances, o_rmse, o_max_deviation, o_min_deviation, o_std_deviation, o_results = com.RunScript(
 #         i_cloud_source,
 #         i_cloud_target,
 #         i_swap

src/gh/components/DF_cloud_cloud_distance/metadata.json

@@ -60,9 +60,9 @@
                 "graft": false
             },
             {
-                "name": "o_mse",
-                "nickname": "o_mse",
-                "description": "average squared difference between source and target.",
+                "name": "o_rmse",
+                "nickname": "o_rmse",
+                "description": "root mean squared error between source and target.",
                 "optional": false,
                 "sourceCount": 0,
                 "graft": false

src/gh/components/DF_cloud_mesh_distance/code.py

@@ -19,44 +19,44 @@
 class CloudMeshDistance(component):
     def RunScript(self,
         i_cloud_source: typing.List[rg.PointCloud],
-        i_beam: typing.List[DFBeam],
+        i_beams: typing.List[DFBeam],
         i_signed_flag: bool,
         i_swap: bool,
         i_analysis_resolution):
 
         """
-            The cloud-to-cloud component computes the distance between each point in the source point cloud and its nearest neighbour in thr target point cloud.
+            The cloud-to-mesh component computes the distance between a point cloud and a mesh
 
             :param i_cloud_source: a list of point clouds
-            :param i_beam: a list of DF beams
+            :param i_beams: a list of DF beams
             :param i_signed_flag: calculate the sign of the distances
             :param i_swap: swap source and target
 
             :return o_distances : list of calculated distances for each point
-            :return o_mse: the average squared difference between corresponding points of source and target
+            :return o_rmse: the root mean square error between corresponding points of source and target
             :return o_max_deviation: the max deviation between source and target
             :return o_min_deviation: the min deviation between source and target
-            :returns o_resluts: the results of the comparison all in one object
+            :returns o_results: the results of the comparison all in one object
         """
         if i_analysis_resolution is None:
             scalef = diffCheck.df_util.get_doc_2_meters_unitf()
             i_analysis_resolution = 0.1 / scalef
 
         # conversion
         df_cloud_source_list = [df_cvt_bindings.cvt_rhcloud_2_dfcloud(i_cl_s) for i_cl_s in i_cloud_source]
-        df_mesh_target_list = [beam.to_mesh(i_analysis_resolution) for beam in i_beam]
+        df_mesh_target_list = [beam.to_mesh(i_analysis_resolution) for beam in i_beams]
 
         # calculate distances
-        o_results = df_error_estimation.cloud_2_rhino_mesh_comparison(df_cloud_source_list, df_mesh_target_list, i_signed_flag, i_swap)
+        o_result = df_error_estimation.cloud_2_rhino_mesh_comparison(df_cloud_source_list, df_mesh_target_list, i_signed_flag, i_swap)
 
-        return o_results.distances, o_results.distances_mse, o_results.distances_max_deviation, o_results.distances_min_deviation, o_results.distances_sd_deviation, o_results
+        return o_result.distances, o_result.distances_mse, o_result.distances_max_deviation, o_result.distances_min_deviation, o_result.distances_sd_deviation, o_result
 
 
 # if __name__ == "__main__":
 #     com = CloudMeshDistance()
 #     o_distances, o_mse, o_max_deviation, o_min_deviation, o_std_deviation, o_results = com.RunScript(
 #         i_cloud_source,
-#         i_beam,
+#         i_beams,
 #         i_signed_flag,
 #         i_swap,
 #         i_analysis_resolution

src/gh/components/DF_cloud_mesh_distance/metadata.json

@@ -26,9 +26,9 @@
                 "typeHintID": "pointcloud"
             },
             {
-                "name": "i_beam",
-                "nickname": "i_beam",
-                "description": "The target DFbeam",
+                "name": "i_beams",
+                "nickname": "i_beams",
+                "description": "The target DFbeams",
                 "optional": false,
                 "allowTreeAccess": true,
                 "showTypeHints": true,
@@ -84,8 +84,8 @@
                 "graft": false
             },
             {
-                "name": "o_mse",
-                "nickname": "o_mse",
+                "name": "o_rmse",
+                "nickname": "o_rmse",
                 "description": "average squared difference between source and target.",
                 "optional": false,
                 "sourceCount": 0,
@@ -116,8 +116,8 @@
                 "graft": false
             },
             {
-                "name": "o_results",
-                "nickname": "o_results",
+                "name": "o_result",
+                "nickname": "o_result",
                 "description": "The result of the distance calculation.",
                 "optional": false,
                 "sourceCount": 0,

…c/gh/components/DF_vizualization/code.py …c/gh/components/DF_visualization/code.pysrc/gh/components/DF_vizualization/code.py renamed to src/gh/components/DF_visualization/code.py src/gh/components/DF_vizualization/code.py renamed to src/gh/components/DF_visualization/code.py

@@ -10,47 +10,55 @@
 import Grasshopper as gh
 from Grasshopper.Kernel import GH_RuntimeMessageLevel as RML
 
-from diffCheck import diffcheck_bindings
 from diffCheck import df_cvt_bindings
-from diffCheck import df_vizualization
+from diffCheck import df_visualization
+from diffCheck.df_visualization import DFVizSettings
+from diffCheck.df_error_estimation import DFVizResults
 
-
-class Vizualization(component):
+class Visualization(component):
     def RunScript(self,
-                  i_results,
-                  i_viz_settings):
+                  i_result: DFVizResults,
+                  i_viz_settings: DFVizSettings):
+
         """
-        Adds color to the mesh or point cloud
-        and generates a corresponding legend and histogram
+            Adds color to the mesh or point cloud
+            and generates a corresponding legend and histogram
+
+            :param i_result: a list of point clouds
+            :param i_viz_settings: a list of DF beams
+
+            :return o_colored_geo: the colored mesh or point cloud
+            :return o_legend : the correesponding legend of the coloring
+            :return o_histogram : a histogram that represents the frequency of the values
         """
 
-        values, min_value, max_value = df_vizualization.filter_values_based_on_valuetype(i_results, i_viz_settings)
+        values, min_value, max_value = i_result.filter_values_based_on_valuetype(i_viz_settings)
 
-        # check if i_results.source is a list of pointclouds or a mesh
-        if type(i_results.source[0]) is diffcheck_bindings.dfb_geometry.DFPointCloud:
+        # check if i_result.source is a list of pointclouds or a mesh
+        if type(i_result.source[0]) is diffcheck_bindings.dfb_geometry.DFPointCloud:
 
             # convert to Rhino PCD
-            o_source = [df_cvt_bindings.cvt_dfcloud_2_rhcloud(src) for src in i_results.source]
+            o_source = [df_cvt_bindings.cvt_dfcloud_2_rhcloud(src) for src in i_result.source]
 
             # color geometry
-            o_colored_geo = [df_vizualization.color_pcd(src, dist, min_value, max_value, i_viz_settings.palette) for src, dist in zip(o_source, values)]
+            o_colored_geo = [df_visualization.color_rh_pcd(src, dist, min_value, max_value, i_viz_settings.palette) for src, dist in zip(o_source, values)]
 
-        elif type(i_results.source[0]) is rg.Mesh:
+        elif type(i_result.source[0]) is rg.Mesh:
             # convert to Rhino Mesh
-            o_source = i_results.source
+            o_source = i_result.source
 
             # color geometry
-            o_colored_geo = [df_vizualization.color_mesh(src, dist, min_value, max_value, i_viz_settings.palette) for src, dist in zip(o_source, values)]
+            o_colored_geo = [df_visualization.color_rh_mesh(src, dist, min_value, max_value, i_viz_settings.palette) for src, dist in zip(o_source, values)]
 
-        o_legend = df_vizualization.create_legend(min_value,
+        o_legend = df_visualization.create_legend(min_value,
                                                   max_value,
                                                   i_viz_settings.palette,
                                                   steps=10,
                                                   plane=i_viz_settings.legend_plane,
                                                   width=i_viz_settings.legend_width,
                                                   total_height=i_viz_settings.legend_height)
 
-        o_histogram = df_vizualization.create_histogram(values,
+        o_histogram = df_visualization.create_histogram(values,
                                                         min_value,
                                                         max_value,
                                                         steps=100,
@@ -62,8 +70,8 @@ def RunScript(self,
 
 
 # if __name__ == "__main__":
-#     com = Vizualization()
+#     com = Visualization()
 #     o_colored_geo, o_legend, o_histogram  = com.RunScript(
-#         i_results,
+#         i_result,
 #         i_viz_settings
 #         )

…/gh/components/DF_vizualization/icon.png …/gh/components/DF_visualization/icon.pngsrc/gh/components/DF_vizualization/icon.png renamed to src/gh/components/DF_visualization/icon.png src/gh/components/DF_vizualization/icon.png renamed to src/gh/components/DF_visualization/icon.png

@@ -1,11 +1,11 @@
 {
-    "name": "DFVizualization",
+    "name": "DFVisualization",
     "nickname": "DFViz",
     "category": "diffCheck",
-    "subcategory": "Vizualization",
+    "subcategory": "Visualization",
     "description": "Color input geometry according to the results of the distance calculation and settings",
     "exposure": 4,
-    "instanceGuid": "46b7026f-f453-4f27-979d-916af633b324",
+    "instanceGuid": "3d20b6d2-fc3d-4faf-a554-fa4ae3ddcde9",
     "ghpython": {
         "hideOutput": true,
         "hideInput": true,
@@ -14,8 +14,8 @@
         "iconDisplay": 2,
         "inputParameters": [
             {
-                "name": "i_results",
-                "nickname": "i_results",
+                "name": "i_result",
+                "nickname": "i_result",
                 "description": "The result of the distance calculation",
                 "optional": true,
                 "allowTreeAccess": true,
@@ -28,7 +28,7 @@
             {
                 "name": "i_viz_settings",
                 "nickname": "i_viz_settings",
-                "description": "The settings of the vizualization",
+                "description": "The settings of the visualization",
                 "optional": false,
                 "allowTreeAccess": true,
                 "showTypeHints": true,
@@ -50,7 +50,7 @@
             {
                 "name": "o_legend",
                 "nickname": "_legend",
-                "description": "The legend of the vizualization",
+                "description": "The legend of the visualization",
                 "optional": false,
                 "sourceCount": 0,
                 "graft": false

…omponents/DF_vizualization/metadata.json …omponents/DF_visualization/metadata.jsonsrc/gh/components/DF_vizualization/metadata.json renamed to src/gh/components/DF_visualization/metadata.json src/gh/components/DF_vizualization/metadata.json renamed to src/gh/components/DF_visualization/metadata.json

@@ -10,21 +10,32 @@
 import Grasshopper as gh
 from Grasshopper.Kernel import GH_RuntimeMessageLevel as RML
 
-from diffCheck import df_vizualization
+from diffCheck import df_visualization
 
 class VisualizationSettings(component):
     def RunScript(self,
-        i_value_type,
-        i_upper_threshold,
-        i_lower_threshold,
-        i_palette,
-        i_legend_height,
-        i_legend_width,
-        i_legend_plane,
-        i_histogram_scale_factor):
+        i_value_type: str,
+        i_upper_threshold: float,
+        i_lower_threshold: float,
+        i_palette: str,
+        i_legend_height: float,
+        i_legend_width: float,
+        i_legend_plane: rg.Plane,
+        i_histogram_scale_factor: float):
 
         """
-        Compiles all the vizualization settings to feed to the vizualization component
+        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_upper_threshold: Thresholds the values with a maximum value
+        :param i_lower_threshold: Thresholds the values with a minimum value
+        :param i_palette: Select a color palette to map the values to. Possible values: "Jet", "Rainbow", "RdPu", "Viridis"
+        :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
@@ -35,7 +46,7 @@ def RunScript(self,
         if i_histogram_scale_factor is None: i_histogram_scale_factor = 0.01
 
         # pack settings
-        o_viz_settings = df_vizualization.DFVizSettings(i_value_type,
+        o_viz_settings = df_visualization.DFVizSettings(i_value_type,
                                                         i_upper_threshold,
                                                         i_lower_threshold,
                                                         i_palette,

…onents/DF_vizualization_settings/code.py …onents/DF_visualization_settings/code.pysrc/gh/components/DF_vizualization_settings/code.py renamed to src/gh/components/DF_visualization_settings/code.py src/gh/components/DF_vizualization_settings/code.py renamed to src/gh/components/DF_visualization_settings/code.py

@@ -1,9 +1,9 @@
 {
-    "name": "DFVizualizationSettings",
+    "name": "DFVisualizationSettings",
     "nickname": "DFVizSettings",
     "category": "diffCheck",
-    "subcategory": "Vizualization",
-    "description": "Compiles all the settings to feed to the vizualization component.",
+    "subcategory": "Visualization",
+    "description": "Compiles all the settings to feed to the visualization component.",
     "exposure": 4,
     "instanceGuid": "22325eeb-07ec-4f15-a1e0-dc01741d5464",
     "ghpython": {
@@ -114,7 +114,7 @@
             {
                 "name": "o_viz_settings",
                 "nickname": "o_viz_settings",
-                "description": "Settings to be passed to the Vizualization component",
+                "description": "Settings to be passed to the Visualization component",
                 "optional": false,
                 "sourceCount": 0,
                 "graft": false