evaluation - parameterized scripts for managing and processing logs

- Aim is to avoid copying each script to log directories. Instead, all logs now take parameters that define where are the logs etc.
- Deleted `evaluate_newest` as its functionality would be the same as `evaluate_from_dir`'s after parameterization

Author: rayvburn

srpb_evaluation/scripts/copy_logs.sh

@@ -1,24 +1,45 @@
 #!/usr/bin/env bash
 #
-# Copies 3 newest files from this directory to the directory given by argument.
-# It is handy to put that script into the logs directory.
+# Copies 3 newest log files (robot/people/groups) from the one directory to the directory given by argument.
 #
-if [ "$#" -ne 1 ]; then
-    echo "What's the target directory?"
+# Usage looks like:
+#
+#   rosrun srpb_evaluation copy_logs.sh  <path_to_the_main_directory_with_logs>  <path_to_the_target_directory>
+#
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then
+    echo "Wrong usage. Script args:"
+    echo "  (1) [required] path to the source directory with logs ('*_robot.txt', '*_people.txt', and '*_groups.txt')"
+    echo "  (2) [required] path to the target directory with copied logs; relative paths will be considered as relative to the source directory"
     exit 0
 fi
 
-SCRIPT_DIR=$(realpath $(dirname $0))
-TARGET_DIR="$SCRIPT_DIR/$1"
-LOGS_DIR=$SCRIPT_DIR
-mkdir -p $TARGET_DIR
+logs_dir="$1"
+# trim trailing / (if exists)
+logs_dir="${logs_dir%/}"
+
+target_dir="$2"
+# trim trailing / (if exists)
+target_dir="${target_dir%/}"
+
+if [[ ! $target_dir == /* ]]; then
+    echo "Relative path"
+    target_dir=$logs_dir/$target_dir
+fi
+
+# create a new directory for the copied logs
+mkdir -p $target_dir
 
 # https://stackoverflow.com/a/54910963
-files_to_copy=$(ls -t $LOGS_DIR/log_*.txt | head -3)
-cp $files_to_copy $TARGET_DIR
+newest_robot=$(ls -t $logs_dir/log_*_robot.txt | head -1)
+newest_people=$(ls -t $logs_dir/log_*_people.txt | head -1)
+newest_groups=$(ls -t $logs_dir/log_*_groups.txt | head -1)
+
+# added an escape sequence for newline (file paths are printed in separate lines)
+files_to_copy="$newest_robot"$'\n'"$newest_people"$'\n'"$newest_groups"
+cp $files_to_copy $target_dir
 
 echo "Copied:"
 echo ""
 echo "$files_to_copy"
 echo ""
-echo "to $TARGET_DIR"
+echo "to $target_dir"

srpb_evaluation/scripts/evaluate_all_dirs.sh

@@ -2,21 +2,50 @@
 #
 # Runs srpb_evaluation node with the newest set of log files from each directory below the script's path
 #
-# It expects that `evaluate_from_dir.sh` script is placed in the same directory
+# It expects that `evaluate_from_dir.sh` script is available using `rosrun srpb_evaluation evaluate_from_dir.sh`
 #
 # Remember to source your ROS workspace before execution
 #
-SCRIPT_DIR=$(realpath $(dirname $0))
+# This script can be executed using:
+#
+#   rosrun srpb_evaluation evaluate_all_dirs.sh  <path>  <safety_distance>
+#
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then
+    echo "Wrong usage. Script args:"
+    echo "  (1) [required] full path to the main directory with grouped logs (3 logs in each separate directory)"
+    echo "  (2) [optional] safety distance for m_obs metric, 0.55 by default"
+    exit 0
+fi
+
+# only the path to logs directory is given
+if [ "$#" -eq 1 ]; then
+    logs_dir="$1"
+    # trim trailing / (if exists)
+    logs_dir="${logs_dir%/}"
+    safety_dist=0.55
+    echo "Using logs main directory: '$logs_dir' and default safety distance of '$safety_dist' m"
+fi
+
+if [ "$#" -eq 2 ]; then
+    logs_dir="$1"
+    # trim trailing / (if exists)
+    logs_dir="${logs_dir%/}"
+    safety_dist=$2
+    echo "Using logs main directory: '$logs_dir' and custom safety distance of '$safety_dist' m"
+fi
+
+# exclude main directory from the search below
+logs_basename=$(basename $logs_dir)
 
 # - ignore directories starting with the underscore
 # - for each directory, run the `evaluate_from_dir` script, passing each found directory as an argument
 # Ref:
 # * https://stackoverflow.com/a/20292636
 # * https://stackoverflow.com/a/15736463
-find . -maxdepth 1 -type d -not -path "./_*" \( ! -name . \) -exec bash -c "$SCRIPT_DIR/evaluate_from_dir.sh '{}'" \;
+find $logs_dir -maxdepth 1 -type d -not -path "$logs_dir/_*" \( ! -name $logs_basename \) -exec bash -c "rosrun srpb_evaluation evaluate_from_dir.sh '{}'" \;
 
 # first part of command above to save number of evaluated dirs, ref: https://stackoverflow.com/a/15663664
-count=$(find . -maxdepth 1 -type d -not -path "./_*" \( ! -name . \) | wc -l)
+count=$(find $logs_dir -maxdepth 1 -type d -not -path "$logs_dir/_*" \( ! -name $logs_basename \) | wc -l)
 
 echo
 echo "Evaluated $count directories"

srpb_evaluation/scripts/evaluate_from_dir.sh

@@ -4,19 +4,34 @@
 #
 # Remember to source your ROS workspace before execution
 #
-if [ "$#" -ne 1 ]; then
-    echo "What's the target directory?"
+# This script can be executed using:
+#
+#   rosrun srpb_evaluation evaluate_from_dir.sh  <path>  <safety_distance>
+#
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then
+    echo "Wrong usage. Script args:"
+    echo "  (1) [required] full path to the directory with logs ('*_robot.txt', '*_people.txt', and '*_groups.txt')"
+    echo "  (2) [optional] safety distance for m_obs metric, 0.55 by default"
     exit 0
 fi
 
-SCRIPT_DIR=$(realpath $(dirname $0))
-LOGS_DIR="$1"
-SAFETY_DIST=0.55
+# only the path to logs directory is given
+if [ "$#" -eq 1 ]; then
+    logs_dir="$1"
+    safety_dist=0.55
+    echo "Using logs directory: '$logs_dir' and default safety distance of '$safety_dist' m"
+fi
+
+if [ "$#" -eq 2 ]; then
+    logs_dir="$1"
+    safety_dist=$2
+    echo "Using logs directory: '$logs_dir' and custom safety distance of '$safety_dist' m"
+fi
 
 # https://stackoverflow.com/a/54910963
-newest_robot=$(ls -t $LOGS_DIR/log_*_robot.txt | head -1)
-newest_people=$(ls -t $LOGS_DIR/log_*_people.txt | head -1)
-newest_groups=$(ls -t $LOGS_DIR/log_*_groups.txt | head -1)
+newest_robot=$(ls -t $logs_dir/log_*_robot.txt | head -1)
+newest_people=$(ls -t $logs_dir/log_*_people.txt | head -1)
+newest_groups=$(ls -t $logs_dir/log_*_groups.txt | head -1)
 
 echo "Evaluating:"
 echo ""
@@ -25,4 +40,4 @@ echo "people data: $newest_people"
 echo "groups data: $newest_groups"
 echo ""
 
-rosrun srpb_evaluation srpb_evaluation $newest_robot $newest_people $newest_groups $SAFETY_DIST
+rosrun srpb_evaluation srpb_evaluation $newest_robot $newest_people $newest_groups $safety_dist