chore(docs): document wedge and edge difference (#214)

chore(docs): document wedge and edge difference Signed-off-by: Jérome Eertmans <[email protected]> Signed-off-by: Fayçal Ait-Aoudia <[email protected]> Co-authored-by: Fayçal Ait-Aoudia <[email protected]>
NVlabs · Nov 27, 2023 · 1c619ac · 1c619ac
1 parent fca9c8c
commit 1c619ac
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/examples/Sionna_Ray_Tracing_Diffraction.ipynb b/examples/Sionna_Ray_Tracing_Diffraction.ipynb
@@ -30,6 +30,7 @@
    "source": [
     "## Table of Contents\n",
     "* [Background Information](#Background-Information)\n",
+    "* [Wedge vs Edge](#Wedge-vs-Edge)\n",
     "* [GPU Configuration and Imports](#GPU-Configuration-and-Imports)\n",
     "* [Experiments with a Simple Wedge](#Experiments-with-a-Simple-Wedge)\n",
     "* [Coverage Maps with Diffraction](#Coverage-Maps-with-Diffraction)\n",
@@ -92,6 +93,22 @@
     "We will explore in this notebook these effects in detail and also validate the UTD implementation in Sionna RT as a by-product."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "318a9c54-4bd1-4bb5-b615-6ab2d8143b21",
+   "metadata": {},
+   "source": [
+    "# Wedge vs Edge\n",
+    "\n",
+    "First, it is important to know the difference between a *wedge* and an *edge*, and why we distinguish between them.\n",
+    "\n",
+    "Sionna defines a *wedge* as the line segment between two primitives, i.e., the common segment of two triangles. For example, a cubic building would have 12 wedges.\n",
+    "\n",
+    "For primitives that have one or more line segments that are not shared with another primitive, Sionna refers to such line segments as *edges*. See [`sionna.rt.scene.floor_wall`](https://nvlabs.github.io/sionna/api/rt.html#sionna.rt.scene.floor_wall) for an example scene.\n",
+    "\n",
+    "By default, Sionna does not simulate diffraction on edges (`edge_diffraction=False`), to avoid problems such as diffraction on the exterior edges of the ground surface (modelled as a rectangular plane)."
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "d77f8e5b-f32c-4752-a0cf-258c69638b28",