writing explicitly that output is in millimeters to help with documen…

…tation as requested by FORTH-ModelBasedTracker#76

src/python/compareUtility/aT.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 #Written by Ammar Qammaz a.k.a AmmarkoV - 2020
+#  This bash script uses gnuplot and R so make sure to : 
+#          sudo apt-get install gnuplot r-base 
+
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 cd "$DIR"
 

src/python/compareUtility/compareUtility.py

@@ -581,6 +581,10 @@ def readCSVFile(filename,memPercentage,csvDelimiter,useHalfFloats,groupOutput):
 appendRAWResultsForGNUplot("gnuplot.raw",alljointDistances)
 
 #Final results we want is Mean Per Joint Position Error (MPJPE) so we rely on the perJointDisparities etc..
+#The result unit depends on the input to the script but it should be in millimeters for MocapNET output
+#to change units you can use the --ourscale X Y Z commandline parameter, however millimeters of accuracy
+#is the norm for 3D pose estimation work..
+
 print("\nMean Per Joint Error for ",totalSamples," samples is ",totalError/totalSamples)
 median  =  np.median(alljointDistances)
 mean    =  np.mean(alljointDistances)