Skip to content
Snippets Groups Projects
willap's avatar
willap authored
691d8ad6
History

Segmentation via Layered Surface Detection

  1. Description of Repository Content
  2. Set-up to run tutorials
  3. Resources and inspiration
  4. Contributions

1. Description of Repository Content

This repository contains tutorials for the using the layered surface detection tool. Included is a few Jupyter notebook tutorials that are designed to give you an idea on how to use the layered surface tool. You should start with the LayeredSurfaceDetection_tutorial.ipynb notebook which discuss the basics of the layered surface tool and applies it to some synthetic data as well as a relatively simple example dataset. More complex examples are provided in the NerveSegmentation2D_example.ipynb and NerveSegmentation3D_example.ipynb notebooks which describe how to apply the layered surface tool to circular regions via radial unwrapping. A Python file containing some helper functions that are used in the tutorials is also included in utilsLS.py_. Some visualization functions are included in the utilsVisualizationLS.py.

These tutorials will give you an understanding of how to apply the Layered Surface tool to image data so that you can use the tool on your own datasets. You can open the the tutorials at Binder.

2. Set-up to run tutorials

For running the tool locally on your computer, you need to install the slgbuilder Python package using pip install slgbuilder.

If you are using Anaconda, you can automatically install the required packages using the included environment file:

Mac/Linux:

  1. Navigate to the folder containing these tutorials and the environment.yml file.
  2. To open the terminal, right click on the folder and navigate to
    • Mac: Services/New Terminal at Folder
    • Linux: Open in Terminal
  3. Type conda env create -f environment.yml and press enter.
  4. Type conda activate qim-LS and press enter.

Windows:

  1. Open Anaconda Prompt.
  2. cd <tutorials_path>, where tutorials_path is the absolute (full) path to the folder containing these tutorials.
  3. Type conda env create -f environment.yml and press enter.
  4. Type conda activate qim-LS and press enter.

3. Resources and inspiration

For inspiration, check out the following papers on user cases we have solved with the layered surfaces tool:

4. Contributions

The development of the tutorials is a combined effort from several researchers in the QIM team. The collection of scripts and exercises is in constant development, and actively used to demonstrate the tool and teach at workshops. We would therefore very much appreciate to hear about your experience.

Please contact William Laprade wl@di.ku.dk with issues and feedback.

If you use the tool for research, please cite the developers' original paper: Sparse layered graphs for multi-object segmentation..