Quantify Intermediate (#2334)

* added some tests for logging data

* did the stuff

* Fix Code Style On quantify-intermediate (#2335)

automated style fixes

Co-authored-by: sanatd33 <[email protected]>

* removed logs/images

* Rename datavis.py to create_path_visualization.py

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: sanatd33 <[email protected]>

soccer/src/soccer/planning/tests/create_path_test.cpp

@@ -1,10 +1,13 @@
+#include "planning/primitives/create_path.hpp"
+
+#include <fstream>
 #include <iostream>
 #include <random>
 
 #include <gtest/gtest.h>
 
-#include "planning/primitives/create_path.hpp"
 #include "planning/tests/testing_utils.hpp"
+#include "planning/trajectory_utils.hpp"
 
 using namespace rj_geometry;
 
@@ -88,4 +91,72 @@ TEST(CreatePath, success_rate) {
     EXPECT_GT(success_rate, 0.75);
 }
 
+TEST(CreatePath, intermediate_creation_time) {
+    std::mt19937 gen(1337);
+
+    constexpr int kIterations = 10000;
+    RobotConstraints constraints;
+    const FieldDimensions* field_dimensions = &FieldDimensions::current_dimensions;
+
+    double average_time;
+    std::cout << "Saving to intermediate_creation.out and intermediate_traversal.out\n";
+    std::ofstream file("intermediate_creation.out");
+    std::ofstream tfile("intermediate_traversal.out");
+    std::ofstream rfile("rrt_creation.out");
+    std::ofstream rtfile("rrt_traversal.out");
+
+    for (int i = 0; i < kIterations; i++) {
+        Point start_point{TestingUtils::random(&gen, -3.0, 3.0),
+                          TestingUtils::random(&gen, 5.0, 5.5)};
+        Point start_velocity{};
+        LinearMotionInstant start{start_point, start_velocity};
+
+        Point end_point{TestingUtils::random(&gen, -3.0, 3.0),
+                        TestingUtils::random(&gen, 0.5, 1.0)};
+        Point end_velocity{};
+        LinearMotionInstant goal{end_point, end_velocity};
+
+        ShapeSet obstacles;
+        int num_obstacles = 5;
+        double obst_size = 0.2;
+        for (int j = 0; j < num_obstacles; j++) {
+            auto direction = end_point - start_point;
+            auto length = direction.mag();
+            auto t = TestingUtils::random(&gen, 0.4 / length, 1 - 0.4 / length);
+
+            auto base_point = start_point + t * direction.normalized();
+            auto perp_direction = direction.rotate(degrees_to_radians(90.));
+            auto random_distance = TestingUtils::random(&gen, 0., obst_size - 0.01);
+            auto offset = perp_direction.normalized() * random_distance;
+            auto random_sign = TestingUtils::random(&gen, 0., 1.) > 0.5 ? 1 : -1;
+            offset *= random_sign;
+            auto obst_center = base_point + offset;
+
+            obstacles.add(std::make_shared<Circle>(obst_center, obst_size));
+        }
+
+        auto start_time = RJ::now();
+        Trajectory traj = CreatePath::intermediate(start, goal, constraints.mot, RJ::now(),
+                                                   obstacles, {}, field_dimensions, 0);
+        double nanos = (RJ::now() - start_time).count();
+        file << "CreatePath::intermediate() Time: " << nanos / 1e6 << " ms\n";
+        tfile << "CreatePath::intermediate() Time: "
+              << (traj.end_time() - traj.begin_time()).count() / 1e9 << " s\n";
+
+        start_time = RJ::now();
+        traj = CreatePath::rrt(start, goal, constraints.mot, RJ::now(), obstacles);
+        nanos = (RJ::now() - start_time).count();
+        rfile << "CreatePath::rrt() Time: " << nanos / 1e6 << " ms\n";
+        rtfile << "CreatePath::rrt() Time: " << (traj.end_time() - traj.begin_time()).count() / 1e9
+               << " s\n";
+
+        average_time += nanos;
+    }
+    file.close();
+
+    average_time /= kIterations;
+    std::cout << "CreatePath::intermediate() Average Time: " << average_time << " ns\n";
+    EXPECT_GT(average_time, 0);
+}
+
 }  // namespace planning

soccer/src/soccer/planning/tests/create_path_visualization.py

@@ -0,0 +1,136 @@
+import re
+import matplotlib.pyplot as plt
+import numpy as np
+
+def extract_times(file_path):
+    """
+    Extracts time values from a file where each line is in the format:
+    'CreatePath::intermediate() Time: <number> <unit>'
+    Supports both 'ns' and 's' units.
+    """
+    times = []
+    units = []  # List to keep track of units (ns or s)
+
+    with open(file_path, 'r') as f:
+        for line in f:
+            # Use regex to extract the time value and its unit (ns or s)
+            match = re.search(r'Time:\s*([\d\.]+)\s*(ms|s)', line)
+            if match:
+                time_value = float(match.group(1))
+                unit = match.group(2)
+
+                # Store the time and unit in their respective lists
+                times.append(time_value)
+                units.append(unit)
+
+    return times, units
+
+def truncate_times(times, threshold=0.5):
+    """
+    Truncates times that are greater than the specified threshold.
+    Default threshold is set to 400,000.
+    """
+    return [time for time in times if time <= threshold]
+
+def calculate_stats(times):
+    """
+    Calculates and returns basic statistics for the time values:
+    mean, median, standard deviation, minimum, and maximum.
+    """
+    mean = np.mean(times)
+    median = np.median(times)
+    std_dev = np.std(times)
+    min_val = np.min(times)
+    max_val = np.max(times)
+
+    return mean, median, std_dev, min_val, max_val
+
+def plot_distribution(times, units, title, subplot_idx, x_min, x_max):
+    """
+    Plots the distribution of the times using a histogram.
+    Now the x-axis is scaled consistently for both plots.
+    """
+    plt.subplot(1, 2, subplot_idx)  # Create a subplot (1 row, 2 columns)
+
+    # Increase the number of bins for finer granularity
+    bins = 50  # Increase bins to get more granularity in the lower end of the distribution
+
+    # Plot histogram
+    density, bins, _ = plt.hist(times, bins=bins, density=True, color='blue', alpha=0.7, edgecolor='black')
+
+    # Set the x-axis limits to be the same for both plots
+    plt.xlim(x_min, x_max)
+
+    # Determine the unit for x-axis label
+    if units[0] == 'ms':
+        x_label = "Time (ms)"
+    elif units[0] == 's':
+        x_label = "Time (s)"
+
+    plt.title(title)
+    plt.xlabel(x_label)
+    plt.ylabel("Density")
+    plt.legend()
+
+def print_stats(title, times, units):
+    """
+    Prints the statistics for a given dataset.
+    """
+    mean, median, std_dev, min_val, max_val = calculate_stats(times)
+
+    # Display the unit (ns or s) for reference
+    unit_str = "ms" if units[0] == 'ms' else "s"
+
+    print(f"Statistics for {title}:")
+    print(f"  Mean: {mean:.2f} {unit_str}")
+    print(f"  Median: {median:.2f} {unit_str}")
+    print(f"  Standard Deviation: {std_dev:.2f} {unit_str}")
+    print(f"  Min: {min_val} {unit_str}")
+    print(f"  Max: {max_val} {unit_str}")
+    print("-" * 50)
+
+def main():
+    # File paths
+    file_path_intermediate = 'intermediate_creation.out'
+    file_path_rrt = 'rrt_creation.out'
+
+    # Extract times and units from both files
+    times_intermediate, units_intermediate = extract_times(file_path_intermediate)
+    times_rrt, units_rrt = extract_times(file_path_rrt)
+
+    if (units_intermediate[0] == 'ms'):
+    # Truncate times greater than 400000
+        times_intermediate = truncate_times(times_intermediate)
+        times_rrt = truncate_times(times_rrt)
+
+    # If both files have valid times, determine the common x-axis limits
+    if times_intermediate and times_rrt:
+        # Find the global min and max values across both time datasets
+        x_min = min(min(times_intermediate), min(times_rrt))
+        x_max = max(max(times_intermediate), max(times_rrt))
+    else:
+        x_min, x_max = 0, 1  # Default values if no valid data found
+
+    # Create a figure for the two plots
+    plt.figure(figsize=(14, 6))
+
+    # Plot and calculate statistics for intermediate.out
+    if times_intermediate:
+        plot_distribution(times_intermediate, units_intermediate, f"Distribution of {file_path_intermediate}", 1, x_min, x_max)
+        print_stats("intermediate.out", times_intermediate, units_intermediate)
+    else:
+        print(f"No valid times found in {file_path_intermediate}.")
+
+    # Plot and calculate statistics for rrt.out
+    if times_rrt:
+        plot_distribution(times_rrt, units_rrt, f"Distribution of {file_path_rrt}", 2, x_min, x_max)
+        print_stats("rrt.out", times_rrt, units_rrt)
+    else:
+        print(f"No valid times found in {file_path_rrt}.")
+
+    # Show the plots
+    plt.tight_layout()  # Adjust layout to prevent overlap
+    plt.show()
+
+if __name__ == '__main__':
+    main()