From dbe23314b24b33623e3f4e254cbefc2e21b72657 Mon Sep 17 00:00:00 2001
From: Christian <s224389@dtu.dk>
Date: Tue, 7 Jan 2025 13:17:19 +0100
Subject: [PATCH 1/2] Created functions.md with an overview of the functions
 needed

---
 functions.md      | 67 +++++++++++++++++++++++++++++++++++++++++++++++
 functions.md.save |  2 ++
 2 files changed, 69 insertions(+)
 create mode 100644 functions.md
 create mode 100644 functions.md.save

diff --git a/functions.md b/functions.md
new file mode 100644
index 0000000..b9d7829
--- /dev/null
+++ b/functions.md
@@ -0,0 +1,67 @@
+# Function Overview
+
+## **Tracing Sutures (Interactive Path Tracing in 2D Images)**
+_This project seeks to develop a GUI enabling users to interactively create and extract paths in 2D images._
+
+---
+
+## **Functions List**
+
+- 'set_img_path'
+    - Takes the path to the image as input.
+    - Sets self.path.
+    - Is triggered on button click.
+
+- 'load_img'
+    - Takes self.path as input.
+    - Displays the input image on the GUI.
+    - Is triggered on button click.
+
+- 'start_edit'
+    - Takes no input.
+    - Sets self.editEnabled to true.
+    - Is triggered on button click.
+
+- 'calc_gradients'
+    - Takes self.path as input.
+    - Calculates gradients in input image and saves as self.gradient
+    - Is triggered by 'load_img'.
+
+- 'set_point'
+    - Takes no input.
+    - Creates a point of the spline on the image when the users clicks left clicks.
+    - Adds the point to self.points.
+
+- 'remove_point'
+    - Takes no input.
+    - Removes the point the user is hovering over when the user right clicks.
+    - Removes the point from self.points.
+
+- 'update_alpha'
+    - Updates self.alpha.
+    - Is triggered by slider.
+
+- 'update_beta'
+    - Updates self.beta.
+    - Is triggered by slider.
+
+- 'active_contour'
+    - Takes self.points, self.gradient, self.alpha and self.beta as inputs.
+    - Performs active contour for finding the curve.
+    - Displays the found _snake_.
+
+- 'set_export_path'
+    - Sets self.exportPath to the path chosen (by GUI-popup?) by the user.
+
+- 'export_line'
+    - Takes self.exportPath as input.
+    - Creats a new np-array file on the chosen path containing the found snake.
+
+
+## 📎 **Notes**
+_This is only a rough first draft/overview of the functions needed for the project._
+
+---
+
+**Author:** Christian Bjerregaard
+**Date:** 07-01-2025
diff --git a/functions.md.save b/functions.md.save
new file mode 100644
index 0000000..1c06696
--- /dev/null
+++ b/functions.md.save
@@ -0,0 +1,2 @@
+
+e
-- 
GitLab


From 6357a515ef98096ec5f5f48f681b772656315428 Mon Sep 17 00:00:00 2001
From: s224389 <s224389@student.dtu.dk>
Date: Tue, 7 Jan 2025 13:18:38 +0100
Subject: [PATCH 2/2] Updated functions.md

---
 functions.md | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/functions.md b/functions.md
index b9d7829..99f1d38 100644
--- a/functions.md
+++ b/functions.md
@@ -7,58 +7,58 @@ _This project seeks to develop a GUI enabling users to interactively create and
 
 ## **Functions List**
 
-- 'set_img_path'
+- `set_img_path`
     - Takes the path to the image as input.
     - Sets self.path.
     - Is triggered on button click.
 
-- 'load_img'
+- `load_img`
     - Takes self.path as input.
     - Displays the input image on the GUI.
     - Is triggered on button click.
 
-- 'start_edit'
+- `start_edit`
     - Takes no input.
     - Sets self.editEnabled to true.
     - Is triggered on button click.
 
-- 'calc_gradients'
+- `calc_gradients`
     - Takes self.path as input.
     - Calculates gradients in input image and saves as self.gradient
-    - Is triggered by 'load_img'.
+    - Is triggered by `load_img`.
 
-- 'set_point'
+- `set_point`
     - Takes no input.
     - Creates a point of the spline on the image when the users clicks left clicks.
     - Adds the point to self.points.
 
-- 'remove_point'
+- `remove_point`
     - Takes no input.
     - Removes the point the user is hovering over when the user right clicks.
     - Removes the point from self.points.
 
-- 'update_alpha'
+- `update_alpha`
     - Updates self.alpha.
     - Is triggered by slider.
 
-- 'update_beta'
+- `update_beta`
     - Updates self.beta.
     - Is triggered by slider.
 
-- 'active_contour'
+- `active_contour`
     - Takes self.points, self.gradient, self.alpha and self.beta as inputs.
     - Performs active contour for finding the curve.
     - Displays the found _snake_.
 
-- 'set_export_path'
+- `set_export_path`
     - Sets self.exportPath to the path chosen (by GUI-popup?) by the user.
 
-- 'export_line'
+- `export_line`
     - Takes self.exportPath as input.
     - Creats a new np-array file on the chosen path containing the found snake.
 
 
-## 📎 **Notes**
+## **Notes**
 _This is only a rough first draft/overview of the functions needed for the project._
 
 ---
-- 
GitLab