diff --git a/README.md b/README.md index 66b54b08e418a96563e875d4155c50b2f8444955..f3919a2867d1324be76e3377669a301743f7481a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## pt2d (Path Tracing in 2D images) -_This repository is no longer being updated._ +_This repository is no longer being updated as of January 23rd 2025._ ### Description @@ -10,6 +10,8 @@ The user places a start and end point between which the program automatically fi The points making up the final path can be exported to a `.csv` file. +Below is a short demonstration of the basic usage of the GUI. +  ### Installation @@ -26,24 +28,20 @@ To open the program type out `pt2d` in a terminal. The GUI looks the following:  -The functionality of the program extends to the following: - -* Main window: - * Start/end point of the path - * Add new points (left click) - * Drag points (hold left click on point and drag)S - * Drag image (hold left click and drag) - * Remove points (right click on point) - * Zoom (mouse wheel) - * Export as `.csv` file -* Advanced window: - * Rainbow toggle (displays a color gradient showing the order of points) - * Calibration of filter - * Resize dot (mouse wheel on dot) - * Line smoothing - * Contrast - * Displays contrasted blurred image - * Displays cost image +#### General usage +The user can add in an image by pressing `Load Image`. +After loading in an image, two anchor points are loaded in intially: start (S) and end (E). The user places these at the start and end point of the path they wish to extract by dragging them. +The user can add more anchor points by left-clicking anywhere on the image. Anchor points (except from start and end) can be removed by right-clicking on them. The user can also press `Clear Points` to remove all at once. + +The program will try to find the path live as points are placed and dragged. +Once the desired path has been found it can be extracted by pressing `Export Path`. + +#### Advanced usage +The GUI has a set of advanced settings that can be acessed by pressing `Advanced Settings`. These include: +* By pressing `Toggle Rainbow`, the path is colored with a gradient that transitions smoothly through a spectrum of colors, creating a rainbow effect. This allows the user to verify that the path is in correct order. +* The smoothness of the path can be adjusted using the `Line smoothing` slider. A higher value results in a smoother line. +* The applied contrasting can be adjusted using the `Contrast` slider. A higher value results in more contrast in the image. This directly affects the contrasted blurred image and the cost image, which are also displayed in the advanced settings. +* The radius of the disk kernel convolved with the contrasted blurred image can be adjusted interactively by pressing `Calibrate Kernel Size`. This opens a new window in which the user is prompted to adjust the size of a dot (by using a slider of the mouse wheel while hovering over the dot) to the size of the path they're trying to extract. A small extra buffer in size is added. This can be used to adjust the cost image until the desired path becomes clear and well defined. ### Methodology @@ -67,7 +65,7 @@ The project follows a simple methodology somewhat similar to that of the livewir ### Authors and acknowledgment -This project is developed by Aske T. Rove, Christian L. Bjerregaard & Mikkel W. Breinstrup under the supervision of Hans M. Kjer & Felipe D. Matos at DTU Compute. +This project is developed by Aske T. Rove, Christian L. Bjerregaard & Mikkel W. Breinstrup under the supervision of Hans M. Kjer & Felipe D. Matos at DTU Compute, Department of Applied Mathematics and Computer Science. ### License