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] 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