diffCheckOrg · 9and3 · Nov 6, 2024 · Oct 9, 2024 · Oct 17, 2024 · Oct 17, 2024
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,6 @@
 *.vtk filter=lfs diff=lfs merge=lfs -text
+*.3dm filter=lfs diff=lfs merge=lfs -text
+*.ghx filter=lfs diff=lfs merge=lfs -text
+*.gh filter=lfs diff=lfs merge=lfs -text
 *.ply filter=lfs diff=lfs merge=lfs -text
-
-_build/* linguist-vendored
+_build/* linguist-vendored
diff --git a/doc/_static/example_files/additive_gh_logs_v1.gh b/doc/_static/example_files/additive_gh_logs_v1.gh
diff --git a/...ic/example_files/subtractive_rh_v1.3dmbak → ...c/example_files/additive_gh_robotic_v1.gh b/...ic/example_files/subtractive_rh_v1.3dmbak → ...c/example_files/additive_gh_robotic_v1.gh
diff --git a/doc/_static/example_files/additive_gh_roof_v1.gh b/doc/_static/example_files/additive_gh_roof_v1.gh
diff --git a/doc/_static/example_files/additive_rh_logs_v1.3dm b/doc/_static/example_files/additive_rh_logs_v1.3dm
diff --git a/doc/_static/example_files/additive_rh_robotic_v1.3dm b/doc/_static/example_files/additive_rh_robotic_v1.3dm
diff --git a/doc/_static/example_files/additive_rh_roof_v1.3dm b/doc/_static/example_files/additive_rh_roof_v1.3dm
diff --git a/doc/_static/tutorials/fig_additive_error.png b/doc/_static/tutorials/fig_additive_error.png
diff --git a/doc/_static/tutorials/fig_additive_logs_DFAssembly.png b/doc/_static/tutorials/fig_additive_logs_DFAssembly.png
diff --git a/doc/_static/tutorials/fig_additive_robotic.png b/doc/_static/tutorials/fig_additive_robotic.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_DFassembly.png b/doc/_static/tutorials/fig_additive_robotic_DFassembly.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_Error.png b/doc/_static/tutorials/fig_additive_robotic_Error.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_Seg.png b/doc/_static/tutorials/fig_additive_robotic_Seg.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_Viz.png b/doc/_static/tutorials/fig_additive_robotic_Viz.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_export.png b/doc/_static/tutorials/fig_additive_robotic_export.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_graph_viz.png b/doc/_static/tutorials/fig_additive_robotic_graph_viz.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_prep.png b/doc/_static/tutorials/fig_additive_robotic_prep.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_results1.png b/doc/_static/tutorials/fig_additive_robotic_results1.png
diff --git a/doc/_static/tutorials/fig_additive_robotic_start.png b/doc/_static/tutorials/fig_additive_robotic_start.png
diff --git a/doc/_static/tutorials/fig_additive_roof.png b/doc/_static/tutorials/fig_additive_roof.png
diff --git a/doc/_static/tutorials/fig_additive_roof_DFassembly.png b/doc/_static/tutorials/fig_additive_roof_DFassembly.png
diff --git a/doc/_static/tutorials/fig_additive_roof_VizGH.png b/doc/_static/tutorials/fig_additive_roof_VizGH.png
diff --git a/doc/_static/tutorials/fig_additive_roof_error.png b/doc/_static/tutorials/fig_additive_roof_error.png
diff --git a/doc/_static/tutorials/fig_additive_roof_export.png b/doc/_static/tutorials/fig_additive_roof_export.png
diff --git a/doc/_static/tutorials/fig_additive_roof_inputs.png b/doc/_static/tutorials/fig_additive_roof_inputs.png
diff --git a/doc/_static/tutorials/fig_additive_roof_legend.png b/doc/_static/tutorials/fig_additive_roof_legend.png
diff --git a/doc/_static/tutorials/fig_additive_roof_reg.png b/doc/_static/tutorials/fig_additive_roof_reg.png
diff --git a/doc/_static/tutorials/fig_additive_roof_seg.png b/doc/_static/tutorials/fig_additive_roof_seg.png
diff --git a/doc/_static/tutorials/fig_additive_roof_viz.png b/doc/_static/tutorials/fig_additive_roof_viz.png
diff --git a/doc/_static/tutorials/help.png b/doc/_static/tutorials/help.png
diff --git a/doc/assembly-evaluation.md b/doc/assembly-evaluation.md
diff --git a/doc/assembly-evaluation.rst b/doc/assembly-evaluation.rst
@@ -0,0 +1,33 @@
+.. _df-assembly:
+
+Assembly Evaluation
+===================
+
+Objective
+-------------------
+
+The goal is to quantify deviations between the CAD model and the scanned data for each element of an assembly. These discrepancies may arise from variations in beam dimensions, placement errors, or beams not being straight, among other factors. At this stage of development, DF only reports the deviations without providing further information on the specific error.
+
+Case Studies
+-------------------
+
+The following tutorias will guide you through the evaluation of assemblies in timber construction with DF. We tested three assembly study cases:
+
+1. Roof structure segment crafted by augmented workers and assembled manually.
+2. Frame structure with four wood logs connected by CNC-fabricated half-lap cross joints.
+3. Spatial structure assembled by two robots and a human.
+
+.. .. image:: ../_build/_static/tutorials/fig_additive_all.png
+..    :alt: Alternative text
+..    :width: 800px
+..    :align: center
+
+You can dive deeper into each case by following the respective tutorials:
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   (1), (2) Manual Assembly <manual-assembly>
+
+   (3) Robotic Assembly <robotic-assembly>
diff --git a/doc/documentation.md b/doc/documentation.md
@@ -15,7 +15,7 @@ invoke documentize
 ```
 and to open the documentation in your browser:
 ```console
-start _build/html/index.html
+start _build/index.html
 ```
 If you modify the `doc`s files and refresh the pages updates will be visible.
 
@@ -68,5 +68,4 @@ If you need to add a new page to the [tutorials](tutorials.rst) (e.g. a [new tut
 
 ```{eval-rst}
 .. literalinclude:: tutorials.rst
-   :language: rst
-   :lines: 6-14
+   :language: rst
diff --git a/doc/gh_DFCloudCloudDistance.rst b/doc/gh_DFCloudCloudDistance.rst
diff --git a/doc/gh_components.rst b/doc/gh_components.rst
@@ -41,11 +41,6 @@ DF has a Grasshopper_ plugin with a set of components that allows the user to in
      - .. image:: ../src/gh/components/DF_cloud_uniform_downsample/icon.png
      - `gh_DFCloudUniformDownsample <gh_DFCloudUniformDownsample.html>`_
 
-   * - .. image:: ../src/gh/components/DF_cloud_voxel_downsample/icon.png
-     - `gh_DFCloudVoxelDownsample <gh_DFCloudVoxelDownsample.html>`_
-     - .. image:: ../src/gh/components/DF_cloud_cloud_distance/icon.png
-     - `gh_DFCloudCloudDistance <gh_DFCloudCloudDistance.html>`_
-
    * - .. image:: ../src/gh/components/DF_cloud_mesh_distance/icon.png
      - `gh_DFCloudMeshDistance <gh_DFCloudMeshDistance.html>`_
      - .. image:: ../src/gh/components/DF_csv_exporter/icon.png
@@ -83,8 +78,8 @@ DF has a Grasshopper_ plugin with a set of components that allows the user to in
 
    * - .. image:: ../src/gh/components/DF_merge_assemblies/icon.png
      - `gh_DFMergeAssemblies <gh_DFMergeAssemblies.html>`_
-     - 
-     - 
+     - .. image:: ../src/gh/components/DF_cloud_voxel_downsample/icon.png
+     - `gh_DFCloudVoxelDownsample <gh_DFCloudVoxelDownsample.html>`_
 
 
 .. toctree::
@@ -93,7 +88,6 @@ DF has a Grasshopper_ plugin with a set of components that allows the user to in
 
    gh_DFBuildAssembly
    gh_DFCADSegmentator
-   gh_DFCloudCloudDistance
    gh_DFCloudMeshDistance
    gh_DFCloudNormalEstimator
    gh_DFCloudSizeDownsample

diff --git a/doc/index.rst b/doc/index.rst
@@ -151,7 +151,7 @@ The software is developed by the `Laboratory of Timber Construction (IBOIS)`_ an
 
 .. toctree::
     :hidden:
-    :maxdepth: 2
+    :maxdepth: 4
     :caption: Getting Started
 
     quickstart

diff --git a/doc/manual-assembly.md b/doc/manual-assembly.md
@@ -0,0 +1,170 @@
+# Manual Assembly
+
+As study cases for the manual assembly, we fabricated:
+1. a roof structure detail connected with half-lap scarf joints and half-lap cross joints that were manually fabricated with Augmented Reality (AR) assistance and assembled with the aid of standard construction tools and equipment.
+2. a frame structure with four wood logs connected with half-lap cross joints
+
+<br>
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof.png" width="800">
+</p>
+
+
+```{eval-rst}
+.. raw:: html
+
+    <div style="display: flex; gap: 200px; justify-content: center;">
+
+        <a href="./_static/example_files/additive_gh_roof_v1.gh" download style="display: inline-block; padding: 10px 20px; font-size: 16px; color: white; background-color: #28a745; text-align: center; text-decoration: none; border-radius: 5px;">
+            <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" class="bi bi-arrow-down-circle" viewBox="0 0 16 16">
+                <path fill-rule="evenodd" d="M1 8a7 7 0 1 0 14 0A7 7 0 0 0 1 8m15 0A8 8 0 1 1 0 8a8 8 0 0 1 16 0M8.5 4.5a.5.5 0 0 0-1 0v5.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293z"/>
+            </svg>
+            Download .gh file for (1)
+        </a>
+
+        <a href="./_static/example_files/additive_gh_logs_v1.gh" download style="display: inline-block; padding: 10px 20px; font-size: 16px; color: white; background-color: #28a745; text-align: center; text-decoration: none; border-radius: 5px;">
+            <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" class="bi bi-arrow-down-circle" viewBox="0 0 16 16">
+                <path fill-rule="evenodd" d="M1 8a7 7 0 1 0 14 0A7 7 0 0 0 1 8m15 0A8 8 0 1 1 0 8a8 8 0 0 1 16 0M8.5 4.5a.5.5 0 0 0-1 0v5.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293z"/>
+            </svg>
+            Download .gh file for (2)
+        </a>
+
+    </div>
+```
+---
+
+## Steps
+
+### 1. Input the data
+First things first, let's import your cleaned scan and corresponding polysurface model in Rhino.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_inputs.png" width="600">
+</p>
+
+### 2. Build the DFAssembly
+Here we convert the model of our structure into the internal datatype of diffcheck, DFAssembly.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_DFassembly.png" width="500">
+</p>
+
+```{hint}
+If you are evaluating round sections e.g. logs, you can set the `i_is_roundwood` input to `True` in the `DFBuildAssembly` component.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_logs_DFAssembly.png" width="600">
+</p>
+
+```
+
+> DF's components:
+> * [`DFAssebmly`](gh_DFBuildAssembly)
+
+### 3. Registration of CAD and scan
+The registration is the process of aligning the CAD model with the scan. This is done by selecting corresponding points on the CAD model and the scan and find a transformation that minimizes the distance between them.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_reg.png" width="1000">
+</p>
+
+> DF's components:
+> * [`DFBrepToCloud`](gh_DFBrepToCloud)
+> * [`DFCloudVoxelDownsample`](gh_DFCloudVoxelDownsample)
+> * [`DFCloudNormalEstimator`](gh_DFCloudNormalEstimator)
+> * [`DFRANSACGlobalRegistration`](gh_DFRANSACGlobalRegistration)
+> * [`DFICPRegistration`](gh_DFICPRegistration)
+
+### 4. Segmentation of the scan
+Once the scan and the CAD model are aligned, we can segment the scan to isolate the parts of the raw point cloud of the scan that corresponds tothe joints.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_seg.png" width="1000">
+</p>
+
+> DF's components:
+> * [`DFCloudNormalSegmentator`](gh_DFCloudNormalSegmentator)
+> * [`DFCADSegmentator`](gh_DFCADSegmentator)
+> * [`DFColorizeCloud`](gh_DFColorizeCloud)
+
+### 5. Error computation
+At this point we can compute the error between the CAD model and the scan. The error is computed as the distance between the closest point on the CAD model and the scan. The current DF's output metrics are:
+
+* *distance* : the distance between the closest point on the CAD model and the scan
+* *mean* : the mean distance between the closest point on the CAD model and the scan
+* *max_deviation* : the maximum distance between the closest point on the CAD model and the scan
+* *min_deviation* : the minimum distance between the closest point on the CAD model and the scan
+* *std_deviation* : the standard deviation of the distance between the closest point on the CAD model and the scan
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_error.png" width="500">
+</p>
+
+> DF's components:
+> * [`DFCloudMeshDistance`](gh_DFCloudMeshDistance)
+
+### 6. Error Visualization
+DF allows you to quickly visualize the errors in the Rhino viewport. The color of the points represents the distance between the CAD model and the scan. The color scale can be adjusted to better visualize the error. We also provide a graph that shows the distribution of the errors.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_VizGH.png width="600">
+</p>
+
+<div style="display: flex; justify-content: space-around; align-items: center;">
+    <figure style="margin: 10px;">
+        <img src="./_static/tutorials/fig_additive_roof_viz.png" alt="subtr detail" style="height: 300px; background-color: transparent;">
+        <figcaption>View on the visualization of the analysed clouds on the CAD model itself. </figcaption>
+    </figure>
+    <figure style="margin: 10px;">
+        <img src="./_static/tutorials/fig_additive_roof_legend.png" alt="subtr graph" style="height: 300px; background-color: transparent;">
+        <figcaption>View of the graph of the corresponding distribution of the total error directly in Rhino.</figcaption>
+    </figure>
+</div>
+
+> DF's components:
+> * [`DFVisualizationSettings`](gh_DFVisualizationSettings)
+> * [`DFVisualization`](gh_DFVisualization)
+
+### 7. Export the results
+The results can be also exported in a CSV file for further analysis or documentation.
+
+<p align="center">
+    <img style="background-color: transparent;"
+    src="./_static/tutorials/fig_additive_roof_export.png" width="500">
+</p>
+
+The CSV contains the values per element for the Roof Case Study (1)..
+
+
+| Beam ID | Min Deviation | Max Deviation | Std Deviation | RMSE  | Mean  |
+|---------|---------------|---------------|---------------|-------|-------|
+| 0       | 0.0001        | 0.0899        | 0.0103        | 0.0171| 0.0137|
+| 1       | 0             | 0.0263        | 0.0075        | 0.0134| 0.0112|
+| 2       | 0             | 0.0176        | 0.0044        | 0.0068| 0.0052|
+| 3       | 0             | 0.0258        | 0.0030        | 0.0048| 0.0037|
+| 4       | 0             | 0.0192        | 0.0092        | 0.0072| 0.0057|
+| 5       | 0             | 0.0711        | 0.0046        | 0.0061| 0.0053|
+| ...     | ...           | ...           | ...           | ...   | ...   |
+
+and for the Frame Case Study (2)..
+
+
+| Beam ID | Min Deviation | Max Deviation | Std Deviation | RMSE  | Mean  |
+|---------|---------------|---------------|---------------|-------|-------|
+| 0       | 0             | 0.1066        | 0.0147        | 0.0202| 0.0139|
+| 1       | 0             | 0.1448        | 0.0158        | 0.0214| 0.0144|
+| 2       | 0             | 0.1155        | 0.024         | 0.0402| 0.0323|
+| 3       | 0             | 0.103         | 0.0198        | 0.0333| 0.0267|
+
+
+> DF's components:
+> * [`DFCsvExporter`](gh_DFCsvExporter)