Skip to content
Snippets Groups Projects
Commit 5d6d63cf authored by monj's avatar monj
Browse files

Structured readme with table of contents

parent a1ee1b44
Branches
No related tags found
No related merge requests found
**Structure tensor tutorials** for the implementation in https://github.com/Skielex/structure-tensor. This implementation is compatible with the python package `cupy`. Therefore, if you have large volumes to process and a graphical processing unit (GPU), you can speed up your computations simply by having a working installation of [cupy](https://docs.cupy.dev/en/stable/install.html).
## Table of Content
- [1 - Description of Repository Content](#1)
- [2 - Set-up to run tutorials](#2)
- [3 - Resources and inspiration](#3)
- [4 - Contributions](#4)
<a name='1'></a>
### 1 - Description of Repository Content
The tutorials demonstrate the use of the structure tensor tool for the analysis of 2D and 3D data. The tutorials come with a set of utils (helper functions), named _utilsST_2D.py_- and _utilsST_3D.py_, to inspect the structure tensor output in various ways. The 2D and 3D example tutorials (_ST2D_examples_ and _ST3D_examples_) come as python scripts (.py) and Jupyter Notebooks (.ipynb). While the 2D script covers many examples, the 3D script dives into one example and thus comes with more details. You can also find a set of guided exercises with solution, names _ST2D_exercise_withSolutions.ipynb_. With these tutorials we would like you to 1) learn how to choose the parameters to obtain desirable results, 2) see different options for visualising the output of the structure tensor, and 3) get inspiration for scientific questions that you could answer with the structure tensor tool.
<a name='2'></a>
### 2 - Set-up to run tutorials
Run the tutorials online on [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Flab.compute.dtu.dk%2FQIM%2Ftutorials%2Fstructuretensor/HEAD) by pressing on the binder icon. If you want to run the tutorials locally, check our instructions for [installing Jupyter Notebooks](https://lab.compute.dtu.dk/QIM/tutorials/getting-started) and then follow the instructions below to install the tool.
**Option 1: pip install**
......@@ -27,20 +37,20 @@ Windows:
3. Type `conda env create -f environment.yml` and press enter.
4. Type `conda activate qim-ST` and press enter.
<a name='3'></a>
### 3 - Resources and inspiration
To learn more about the computation of structure tensor, the visualisation of orientation analysis and other examples of using orientation analysis in volumetric data analysis, we recommend you take a look at the [notes](http://people.compute.dtu.dk/vand/notes/ST_intro.pdf) by Vedrana A. Dahl vand@dtu.dk
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 Monica J. Emerson monj@dtu.dk with issues and feedback.
For inspiration, check out the following papers on user cases we have solved with the structure tensor tool:
- Hofstätter, Baier, Trinderup, Gundlach, Pedersen, Tosello, Hanseen. [Internal fiber structure of a high-performing, additively manufactured injection molding insert.](https://aip.scitation.org/doi/abs/10.1063/1.5088312) International Conference of the Polymer Processing Society, 2018.
- Saxena, Bissacco, Gundlach, Dahl, Trinderup, Dahl. [Process characterization for molding of paper bottles I using computed tomography and structure tensor analysis.](https://backend.orbit.dtu.dk/ws/portalfiles/portal/168934040/iCT2019_Full_paper_99.pdf) Nondestructive Testing & Ultrasonics, 2019.
- Jeppesen, Dahl, Christensen, Dahl, Mikkelsen. [Characterization of the fiber orientations in non-crimp glass fiber reinforced composites using structure tensor.](https://iopscience.iop.org/article/10.1088/1757-899X/942/1/012037) Materials Science and Engineering, 2020.
- Jeppesen, Mikkelsen, Dahl, Nymark, Dahl. [Quantifying effects of manufacturing methods on fiber orientation in unidirectional composites using structure tensor analysis.](https://www.sciencedirect.com/science/article/pii/S1359835X21002633?via%3Dihub) Composites Part A: Applied Science and Manufacturing, 2021
<a name='4'></a>
### 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 Monica J. Emerson monj@dtu.dk with issues and feedback.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment