Merge pull request #4 from ErikMaris/develop

Develop

docs/manuscript/res/trackProperties.rst

@@ -29,6 +29,8 @@ Number of points
 
 **Units:** -.
 
+**Supported dimensions:** 2/3.
+
 Length
 ++++++++++++++++++++++
 
@@ -41,6 +43,8 @@ Length
 
 **Units:** length.
 
+**Supported dimensions:** 2/3.
+
 MinBoundCircleRadius
 ++++++++++++++++++++++
 
@@ -52,6 +56,8 @@ MinBoundCircleRadius
 
 **Units:** length.
 
+**Supported dimensions:** 2/(3 is converted to XY plane).
+
 
 MBC minus CoM
 ++++++++++++++++++++++
@@ -64,6 +70,8 @@ MBC minus CoM
 
 **Units:** -.
 
+**Supported dimensions:** 2/(3 is converted to XY plane).
+
 
 Entropy
 ++++++++++++++++++++++
@@ -76,6 +84,7 @@ Entropy
 
 **Units:** -.
 
+**Supported dimensions:** 2/(3 is converted to XY plane).
 
 Tortuosity
 ++++++++++++++++++++++
@@ -88,6 +97,8 @@ Tortuosity
 
 **Units:** -.
 
+**Supported dimensions:** 2/3.
+
 Elongation
 ++++++++++++++++++++++
 
@@ -99,6 +110,8 @@ Elongation
 
 **Units:** -.
 
+**Supported dimensions:** 2/(3 is converted to XY plane).
+
 Elongation angle
 ++++++++++++++++++++++
 
@@ -110,6 +123,8 @@ Elongation angle
 
 **Units:** -.
 
+**Supported dimensions:** 2/(3 is converted to XY plane).
+
 Other Track Properties
 ---------------------------
 
@@ -128,9 +143,10 @@ Localization error
 
 **Description:** imprecision in the localization. The deviation of a localization  estimate from its true position is ideally normally distributed in one dimension. The localization error is defined as the standard deviation of this normal distribution.
 
-
 **Units:** length.
 
+**Supported dimensions:** 2/3.
+
 Diffusion SNR
 ++++++++++++++++++++++
 
@@ -142,6 +158,7 @@ Diffusion SNR
 
 **Units:** -.
 
+**Supported dimensions:** 2/3.
 
 Underlying Descriptors
 ----------------------------

docs/manuscript/usage/GUI.rst

@@ -34,7 +34,7 @@ The :ref:`standard track properties <ch-trackProperties-standard>` of the loaded
 The Population is a group of tracks with similar motion characteristics. Populations can be managed in the `Segmentation` panel. The current Population can be selected in the first dropdown menu :guilabel:`Population #` in the `Selection` panel. Each Population has a number of Tracks, which can be selected based on the Track ID in the second dropdown menu :guilabel:`Track #`. The computed track properties can be selected in the bottom two menu’s, which are respectively the :guilabel:`Track property 1` and :guilabel:`Track property 2`.
 
 Custom features
------------------
+++++++++++++++++
 Custom features can be added to DiffusionLab. These features are coded in separate files (scripts) by the user. Instructions to code the features can be found in a template located at src/classes/@tracks/feature_template/featureTemplate.m in the GitHub repository.  One or more of these 'feature scripts' can be loaded in the DiffusionLab GUI via :guilabel:`File` > :guilabel:`Load feature script`. The selected scripts are automatically executed and the features appear in the software and can be used like any of the build-in features. These features are also automatically computed for the training set in the Classification Trainer App (see below). The features have to be removed from the loaded feature scripts list before the Classification Trainer App is opened, if they should not be computed for the training set. This can be done by opening the file selection dialog via :guilabel:`File` > :guilabel:`Load feature script` and pressing :guilabel:`Cancel`.
 
 Property table