Update _metricsMain.py

scripts/_metricsMain.py

@@ -61,10 +61,33 @@ def get_metrics(df_fs,df_points,df_entropy,df_giniT,df_giniSession,df_phases,sel
 	-------
 	Output
 		returns a data frame with the following metrics columns (TBC):
-			group - the cluster id (a self incremental intiger that starts from 1)
-			base_dist - distance from a datapoint to the first datapoint in the cluster
-			intra_dist - distance to the previous data point
-			time_diff - time difference from the previous data point
+			session	 : identifier of the session
+			tracker	 : identifier of the tracker
+			phase	 : the phase for which the metrics are calculated
+			Number_of_stops	 : total number of stops of the tracker during the session/phase
+			Stopping_time_mins	 : total stopping time of the tracker during the session/phase
+			Max_stop_mins	 : longest stop of the tracker during the session/phase
+			Avg_stopping_time	 : average duration of a stop 
+			Median_stopping_time	 : median duration of a stop
+			Std_stopping_time	 : standard deviation for the previous average
+			Number_of_transitions	 :  total number of transitions of the tracker during the session/phase
+			Distance_walked	 : total distance walked
+			Speed_meter_per_sec	 : walking speed
+			Total_attention_time_min	 :  total time dedicated to be in close proximity to fixed points of the obj_type 'student'
+			Total_number_visits	 : total number of stops in close proximity to fixed points of the obj_type 'student' 
+			Average_attention_time_per_visit	 : average attention time per  fixed point of the obj_type 'student' 
+			STD_attention_time_per_visit	 :  standard deviation for the previous average
+			Average_visits_per_student	 : average number of stops per  fixed point of the obj_type 'student' 
+			STD_visits_per_student	 :  standard deviation for the previous average
+			('Total_attention_time_min', 'IDObjet')	 : total  total time dedicated to be in close proximity to fixed points tagged as 'IdObject' of obj_type 'zone'
+			 one per fixed point of the obj_type 'zone' 
+			('Total_number_visits', 'IDObjet')	 : total number of stops in close proximity to fixed points tagged as 'IdObject' of obj_type 'zone'
+			 one per fixed point of the obj_type 'zone' 
+			Entropy	 : entropy of the datapoints for the tracker during the session/phase
+			gini_per_tracker	 : index of dispertion of the tracker with reference to fixed points  of obj_type 'student' during the session/phase
+			gini_per_session	 : index of dispertion of ALL trackers with reference to fixed points  of obj_type 'student' during the session/phase
+              (the same value is repeated for each tracker/row)
+			
 
 	"""
 	print ("Calculating metrics.")