--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/nomad/README.md	Tue Jun 21 17:06:06 2022 -0400
@@ -0,0 +1,38 @@
+# Optimization tool
+
+----
+## usage
+1. Make sure your data is structured like so:
+```
+    Data                        # Folder containing all the data
+    └── <Intersection name>     # Intersection (e.g. montcalm-chartwell)
+        ├── <tracking configuration file>.cfg
+        ├── <Date 1>
+        │   ├── <Other subdirectories>    # There can be as many subdirectories as you want
+        │       ├── <Video 1>
+        │       ├── <Ground truth database 1>_gt.sqlite
+        │       ├── homography.txt
+        │       ├── image.pg
+        │       ├── mask.png
+        │       └── point-correspondences.txt
+        ├── <Date 2>
+        └── <Date 3>
+             .
+             .
+             .
+```
+
+> Please note : You should have at least one ground truth database (with a name ending with "_gt.sqlite") for each date of the intersection.
+
+2. Select an intersection or several intersections for which you wish to find optimal tracking parameters, for instance:
+
+        $ python3 optimize-with-nomad.py -t /media/disk2/etienne/Data/montcalm-chartwell/ /media/disk2/etienne/Data/montcalm-victorin/ --optimize-grouping-only
+
+> Please note : You cannot find the optimal parameters only for the grouping algorithm if there is not a database already created. You should first execute the tracking algorithm with basic parameters.
+
+3. Once the optimal parameters are found, tracking may be launched:
+
+        $ cd $HOME/Data/montcalm-chartwell
+        $ feature-based-tracking tracking-visible.cfg --tf --video-filename 2019-11-27/Visible/2019-11-27T12\:20-05\:00.MP4 --database-filename 2019-11-27/Visible/2019-11-27T12\:20-05\:00.sqlite --homography-filename 2019-11-27/Visible/homography.txt --mask-filename 2019-11-27/Visible/mask.png --feature-quality 0.1 --min-feature-distanceklt 3.54964337411 --window-size 6 --min-tracking-error 0.01 --min-feature-time 15
+        $ feature-based-tracking tracking-visible.cfg --gf --video-filename 2019-11-27/Visible/2019-11-27T12\:20-05\:00.MP4 --database-filename 2019-11-27/Visible/2019-11-27T12\:20-05\:00.sqlite --homography-filename 2019-11-27/Visible/homography.txt --mask-filename 2019-11-27/Visible/mask.png --mm-connection-distance 2 --mm-segmentation-distance 1.9 --min-nfeatures-group 4
+