From 280a0eff9a6d2a28f60f6d912a6ac3552d37e36b Mon Sep 17 00:00:00 2001
From: "Oliver K. Ernst" <oliver.k.ernst@gmail.com>
Date: Fri, 15 Dec 2023 12:40:26 -0800
Subject: [PATCH] Updated readme, docstrings

---
 README.md     | 19 ++++++++++++++++---
 js/app.js     | 13 ++++++++++++-
 js/index.html |  2 +-
 3 files changed, 29 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index aea4c25..66051c8 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,27 @@
 # Chamfer distance visualization
 
-Visualization of the Chamfer distance between two point clouds using `dash` app.
+Visualization of the Chamfer distance between two point clouds using `dash` app in **both** Python and Javascript.
 
 ## Running
 
-Insttall the requirements:
+### Javascript
+
+Navigate to the `js` directory and run using VSCode's Live Server extension or any other web server of your choice. For example:
+
+```bash
+cd js
+python -m http.server
+```
+
+### Python
+
+Navigate to the `python` directory and install the requirements:
 
 ```bash
 pip install -r requirements.txt
 ```
 
-Run the app:
+Then run the app:
 
 ```bash
 python app.py
@@ -48,6 +59,8 @@ It's important to note that while KD-Trees offer efficient nearest neighbor and
 
 ## References
 
+* [KDtree in JS](https://github.com/ubilabs/kd-tree-javascript)
+
 * [Basic Chamfer distance implementation](https://medium.com/@sim30217/chamfer-distance-4207955e8612)
 
     ```python
diff --git a/js/app.js b/js/app.js
index 036a19a..7a7aa54 100644
--- a/js/app.js
+++ b/js/app.js
@@ -53,8 +53,10 @@ function initializeApp() {
     createScatterPlot();
 }
 
+// Initialize app
 document.addEventListener('DOMContentLoaded', initializeApp);
 
+// Function to generate a batch of random normal numbers
 function randomNormalBatch(size) {
     let normals = [];
     for (let i = 0; i < size; i += 2) {
@@ -70,6 +72,7 @@ function randomNormalBatch(size) {
     return normals;
 }
 
+// Function to update data based on data mode
 function updateDataMode(mode) {
     let dataNew = [];
     let batchSize = 100;
@@ -115,6 +118,7 @@ function updateDataMode(mode) {
     data = dataNew.map(p => ({ x: p.x - meanX, y: p.y - meanY }));
 }
 
+// Function to create scatter plot
 function createScatterPlot() {
     let trace1 = {
         x: data.map(d => d.x),
@@ -209,7 +213,7 @@ function createScatterPlot() {
     });
 }
 
-
+// Event listeners for edit mode
 document.getElementById('edit-dropdown').addEventListener('change', function(event) {
     // Log
     console.log('Edit dropdown changed to ' + event.target.value);
@@ -218,6 +222,7 @@ document.getElementById('edit-dropdown').addEventListener('change', function(eve
     // Update plot or other elements based on edit mode
 });
 
+// Event listeners for data mode
 document.getElementById('data-dropdown').addEventListener('change', function(event) {
     // Log new value
     console.log('Data dropdown changed to ' + event.target.value);
@@ -227,6 +232,7 @@ document.getElementById('data-dropdown').addEventListener('change', function(eve
     createScatterPlot();
 });
 
+// Event listeners for randomize button
 document.getElementById('randomize-button').addEventListener('click', function() {
     // Log
     console.log('Randomize button clicked');
@@ -236,6 +242,7 @@ document.getElementById('randomize-button').addEventListener('click', function()
     createScatterPlot();
 });
 
+// Transform data by offset and rotation
 function dataTransform(data, offsetX, offsetY, rotateAngle) {
     // Applying the offset
     let transformedData = data.map(p => ({ x: p.x + offsetX, y: p.y + offsetY }));
@@ -255,6 +262,7 @@ function dataTransform(data, offsetX, offsetY, rotateAngle) {
     return transformedData;
 }
 
+// Transform data by offset and rotation and return x and y separately
 function dataTransformXY(data, offsetX, offsetY, rotateAngle) {
     const transformedData = dataTransform(data, offsetX, offsetY, rotateAngle);
     return {
@@ -263,6 +271,7 @@ function dataTransformXY(data, offsetX, offsetY, rotateAngle) {
     };
 }
 
+// Calculate chamfer distance
 function chamferDistance(data, dataOffset) {
     // Assuming 'distance' function and 'dimensions' are defined elsewhere
     // Log
@@ -288,11 +297,13 @@ function chamferDistance(data, dataOffset) {
     return distA + distB;
 }
 
+// Calculate chamfer distance from offset
 function chamferDistanceFromOffset(data, offsetX, offsetY, rotateAngle) {
     const dataOffset = dataTransform(data, offsetX, offsetY, rotateAngle);
     return chamferDistance(data, dataOffset);
 }
 
+// Calculate chamfer distance from offset and return title
 function chamferDistanceTitleFromOffset(data, offsetX, offsetY, rotateAngle) {
     const dist = chamferDistanceFromOffset(data, offsetX, offsetY, rotateAngle);
     return `Chamfer distance: ${dist.toFixed(2)}`;
diff --git a/js/index.html b/js/index.html
index eb2a53c..05a4284 100644
--- a/js/index.html
+++ b/js/index.html
@@ -3,7 +3,7 @@
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>My Dash App</title>
+    <title>Chamfer Distance Visualization</title>
     <!-- Bootstrap CSS -->
     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css">
     <script src="kdTree-min.js"></script>