add comment for stopping the simulation

AerialNavigation/drone_3d_trajectory_following/Quadrotor.py

@@ -23,6 +23,7 @@ class Quadrotor():
         if self.show_animation:
             plt.ion()
             fig = plt.figure()
+            # for stopping simulation with the esc key.
             fig.canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
 

AerialNavigation/rocket_powered_landing/rocket_powered_landing.py

@@ -567,6 +567,7 @@ def plot_animation(X, U):  # pragma: no cover
 
     fig = plt.figure()
     ax = fig.gca(projection='3d')
+    # for stopping simulation with the esc key.
     fig.canvas.mpl_connect('key_release_event',
             lambda event: [exit(0) if event.key == 'escape' else None])
 

ArmNavigation/arm_obstacle_navigation/arm_obstacle_navigation.py

@@ -162,6 +162,7 @@ def astar_torus(grid, start_node, goal_node):
         for i in range(1, len(route)):
             grid[route[i]] = 6
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.imshow(grid, cmap=cmap, norm=norm, interpolation=None)

ArmNavigation/arm_obstacle_navigation/arm_obstacle_navigation_2.py

@@ -193,6 +193,7 @@ def astar_torus(grid, start_node, goal_node):
         for i in range(1, len(route)):
             grid[route[i]] = 6
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.imshow(grid, cmap=cmap, norm=norm, interpolation=None)

ArmNavigation/n_joint_arm_to_point_control/NLinkArm.py

@@ -51,6 +51,7 @@ class NLinkArm(object):
 
     def plot(self):  # pragma: no cover
         plt.cla()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
 

ArmNavigation/two_joint_arm_to_point_control/two_joint_arm_to_point_control.py

@@ -114,6 +114,7 @@ def animation():
 def main():  # pragma: no cover
     fig = plt.figure()
     fig.canvas.mpl_connect("button_press_event", click)
+    # for stopping simulation with the esc key.
     fig.canvas.mpl_connect('key_release_event',
             lambda event: [exit(0) if event.key == 'escape' else None])
     two_joint_arm()

Bipedal/bipedal_planner/bipedal_planner.py

@@ -111,6 +111,7 @@ class BipedalPlanner(object):
                     if c > len(com_trajectory_for_plot):
                         # set up plotter
                         plt.cla()
+                        # for stopping simulation with the esc key.
                         plt.gcf().canvas.mpl_connect('key_release_event',
                                 lambda event: [exit(0) if event.key == 'escape' else None])
                         ax.set_zlim(0, z_c * 2)

Localization/ensemble_kalman_filter/ensemble_kalman_filter.py

@@ -213,6 +213,7 @@ def main():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
 

Localization/extended_kalman_filter/extended_kalman_filter.py

@@ -191,6 +191,7 @@ def main():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(hz[0, :], hz[1, :], ".g")

Localization/histogram_filter/histogram_filter.py

@@ -233,6 +233,7 @@ def main():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             draw_heat_map(grid_map.data, mx, my)

Localization/particle_filter/particle_filter.py

@@ -230,6 +230,7 @@ def main():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
 

Localization/unscented_kalman_filter/unscented_kalman_filter.py

@@ -240,6 +240,7 @@ def main():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(hz[0, :], hz[1, :], ".g")

Mapping/circle_fitting/circle_fitting.py

@@ -124,6 +124,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.axis("equal")

Mapping/gaussian_grid_map/gaussian_grid_map.py

@@ -73,6 +73,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             draw_heatmap(gmap, minx, maxx, miny, maxy, xyreso)

Mapping/kmeans_clustering/kmeans_clustering.py

@@ -133,6 +133,7 @@ def main():
         # for animation
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             clusters.plot_cluster()

Mapping/raycasting_grid_map/raycasting_grid_map.py

@@ -124,6 +124,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             draw_heatmap(pmap, minx, maxx, miny, maxy, xyreso)

Mapping/rectangle_fitting/rectangle_fitting.py

@@ -242,6 +242,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.axis("equal")

PathPlanning/AStar/a_star.py

@@ -79,6 +79,7 @@ class AStarPlanner:
             if show_animation:  # pragma: no cover
                 plt.plot(self.calc_grid_position(current.x, self.minx),
                          self.calc_grid_position(current.y, self.miny), "xc")
+                # for stopping simulation with the esc key.
                 plt.gcf().canvas.mpl_connect('key_release_event',
                         lambda event: [exit(0) if event.key == 'escape' else None])
                 if len(closed_set.keys()) % 10 == 0:

PathPlanning/BatchInformedRRTStar/batch_informed_rrtstar.py

@@ -534,6 +534,7 @@ class BITStar(object):
     def draw_graph(self, xCenter=None, cBest=None, cMin=None, etheta=None,
                    samples=None, start=None, end=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         for rnd in samples:

PathPlanning/ClosedLoopRRTStar/pure_pursuit.py

@@ -135,6 +135,7 @@ def closed_loop_prediction(cx, cy, cyaw, speed_profile, goal):
 
         if target_ind % 1 == 0 and animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(cx, cy, "-r", label="course")

PathPlanning/Dijkstra/dijkstra.py

@@ -69,6 +69,7 @@ class Dijkstra:
             if show_animation:  # pragma: no cover
                 plt.plot(self.calc_position(current.x, self.minx),
                          self.calc_position(current.y, self.miny), "xc")
+                # for stopping simulation with the esc key.
                 plt.gcf().canvas.mpl_connect('key_release_event',
                         lambda event: [exit(0) if event.key == 'escape' else None])
                 if len(closedset.keys()) % 10 == 0:

PathPlanning/DubinsPath/dubins_path_planning.py

@@ -318,6 +318,7 @@ def test():
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(px, py, label="final course " + str(mode))

PathPlanning/DynamicWindowApproach/dynamic_window_approach.py

@@ -268,6 +268,7 @@ def main(gx=10.0, gy=10.0, robot_type=RobotType.circle):
 
         if show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(predicted_trajectory[:, 0], predicted_trajectory[:, 1], "-g")

PathPlanning/Eta3SplinePath/eta3_spline_path.py

@@ -213,6 +213,7 @@ def test1():
         if show_animation:
             # plot the path
             plt.plot(pos[0, :], pos[1, :])
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.pause(1.0)

PathPlanning/FrenetOptimalTrajectory/frenet_optimal_trajectory.py

@@ -347,6 +347,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(tx, ty)

PathPlanning/GridBasedSweepCPP/grid_based_sweep_coverage_path_planner.py

@@ -213,6 +213,7 @@ def sweep_path_search(sweep_searcher, gmap, grid_search_animation=False):
 
     if grid_search_animation:
         fig, ax = plt.subplots()
+        # for stopping simulation with the esc key.
         fig.canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
 
@@ -268,6 +269,7 @@ def planning_animation(ox, oy, reso):  # pragma: no cover
     if do_animation:
         for ipx, ipy in zip(px, py):
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(ox, oy, "-xb")

PathPlanning/HybridAStar/a_star.py

@@ -78,6 +78,7 @@ def dp_planning(sx, sy, gx, gy, ox, oy, reso, rr):
         # show graph
         if show_animation:  # pragma: no cover
             plt.plot(current.x * reso, current.y * reso, "xc")
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             if len(closedset.keys()) % 10 == 0:

PathPlanning/HybridAStar/hybrid_a_star.py

@@ -327,6 +327,7 @@ def hybrid_a_star_planning(start, goal, ox, oy, xyreso, yawreso):
 
         if show_animation:  # pragma: no cover
             plt.plot(current.xlist[-1], current.ylist[-1], "xc")
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             if len(closedList.keys()) % 10 == 0:

PathPlanning/InformedRRTStar/informed_rrt_star.py

@@ -267,6 +267,7 @@ class InformedRRTStar:
 
     def draw_graph(self, xCenter=None, cBest=None, cMin=None, etheta=None, rnd=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/LQRPlanner/LQRplanner.py

@@ -54,6 +54,7 @@ class LQRPlanner:
 
             # animation
             if show_animation:  # pragma: no cover
+                # for stopping simulation with the esc key.
                 plt.gcf().canvas.mpl_connect('key_release_event',
                         lambda event: [exit(0) if event.key == 'escape' else None])
                 plt.plot(sx, sy, "or")

PathPlanning/LQRRRTStar/lqr_rrt_star.py

@@ -102,6 +102,7 @@ class LQRRRTStar(RRTStar):
 
     def draw_graph(self, rnd=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/PotentialFieldPlanning/potential_field_planning.py

@@ -98,6 +98,7 @@ def potential_field_planning(sx, sy, gx, gy, ox, oy, reso, rr):
 
     if show_animation:
         draw_heatmap(pmap)
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         plt.plot(ix, iy, "*k")

PathPlanning/ProbabilisticRoadMap/probabilistic_road_map.py

@@ -194,6 +194,7 @@ def dijkstra_planning(sx, sy, gx, gy, ox, oy, rr, road_map, sample_x, sample_y):
 
         # show graph
         if show_animation and len(closedset.keys()) % 2 == 0:
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(current.x, current.y, "xg")

PathPlanning/QuinticPolynomialsPlanner/quintic_polynomials_planner.py

@@ -151,6 +151,7 @@ def quintic_polynomials_planner(sx, sy, syaw, sv, sa, gx, gy, gyaw, gv, ga, max_
     if show_animation:  # pragma: no cover
         for i, _ in enumerate(time):
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.grid(True)

PathPlanning/RRT/rrt.py

@@ -138,6 +138,7 @@ class RRT:
 
     def draw_graph(self, rnd=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/RRTDubins/rrt_dubins.py

@@ -106,6 +106,7 @@ class RRTDubins(RRT):
 
     def draw_graph(self, rnd=None):  # pragma: no cover
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/RRTStarDubins/rrt_star_dubins.py

@@ -112,6 +112,7 @@ class RRTStarDubins(RRTStar):
 
     def draw_graph(self, rnd=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/RRTStarReedsShepp/rrt_star_reeds_shepp.py

@@ -122,6 +122,7 @@ class RRTStarReedsShepp(RRTStar):
 
     def draw_graph(self, rnd=None):
         plt.clf()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         if rnd is not None:

PathPlanning/ReedsSheppPath/reeds_shepp_path_planning.py

@@ -395,6 +395,7 @@ def test():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(px, py, label="final course " + str(mode))

PathPlanning/VoronoiRoadMap/voronoi_road_map.py

@@ -185,6 +185,7 @@ def dijkstra_planning(sx, sy, gx, gy, ox, oy, rr, road_map, sample_x, sample_y):
         # show graph
         if show_animation and len(closedset.keys()) % 2 == 0:  # pragma: no cover
             plt.plot(current.x, current.y, "xg")
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.pause(0.001)

PathTracking/cgmres_nmpc/cgmres_nmpc.py

@@ -546,6 +546,7 @@ def animation(plant, controller, dt):
             steer = math.atan2(controller.history_u_2[t] * WB / v, 1.0)
 
         plt.cla()
+        # for stopping simulation with the esc key.
         plt.gcf().canvas.mpl_connect('key_release_event',
                 lambda event: [exit(0) if event.key == 'escape' else None])
         plt.plot(plant.history_x, plant.history_y, "-r", label="trajectory")

PathTracking/lqr_speed_steer_control/lqr_speed_steer_control.py

@@ -224,6 +224,7 @@ def do_simulation(cx, cy, cyaw, ck, speed_profile, goal):
 
         if target_ind % 1 == 0 and show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(cx, cy, "-r", label="course")

PathTracking/lqr_steer_control/lqr_steer_control.py

@@ -203,6 +203,7 @@ def closed_loop_prediction(cx, cy, cyaw, ck, speed_profile, goal):
 
         if target_ind % 1 == 0 and show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(cx, cy, "-r", label="course")

PathTracking/model_predictive_speed_and_steer_control/model_predictive_speed_and_steer_control.py

@@ -429,6 +429,7 @@ def do_simulation(cx, cy, cyaw, ck, sp, dl, initial_state):
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             if ox is not None:

PathTracking/move_to_pose/move_to_pose.py

@@ -93,6 +93,7 @@ def plot_vehicle(x, y, theta, x_traj, y_traj):  # pragma: no cover
 
     plt.plot(x_traj, y_traj, 'b--')
 
+    # for stopping simulation with the esc key.
     plt.gcf().canvas.mpl_connect('key_release_event',
             lambda event: [exit(0) if event.key == 'escape' else None])
 

PathTracking/pure_pursuit/pure_pursuit.py

@@ -166,6 +166,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plot_arrow(state.x, state.y, state.yaw)

PathTracking/rear_wheel_feedback/rear_wheel_feedback.py

@@ -149,6 +149,7 @@ def closed_loop_prediction(cx, cy, cyaw, ck, speed_profile, goal):
 
         if target_ind % 1 == 0 and show_animation:
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(cx, cy, "-r", label="course")

PathTracking/stanley_controller/stanley_controller.py

@@ -186,6 +186,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(cx, cy, ".r", label="course")

SLAM/EKFSLAM/ekf_slam.py

@@ -235,6 +235,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
 

SLAM/FastSLAM1/fast_slam1.py

@@ -365,6 +365,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(RFID[:, 0], RFID[:, 1], "*k")

SLAM/FastSLAM2/fast_slam2.py

@@ -390,6 +390,7 @@ def main():
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(RFID[:, 0], RFID[:, 1], "*k")

SLAM/GraphBasedSLAM/graph_based_slam.py

@@ -303,6 +303,7 @@ def main():
 
             if show_animation:  # pragma: no cover
                 plt.cla()
+                # for stopping simulation with the esc key.
                 plt.gcf().canvas.mpl_connect('key_release_event',
                         lambda event: [exit(0) if event.key == 'escape' else None])
                 plt.plot(RFID[:, 0], RFID[:, 1], "*k")

SLAM/iterative_closest_point/iterative_closest_point.py

@@ -36,6 +36,7 @@ def icp_matching(previous_points, current_points):
 
         if show_animation:  # pragma: no cover
             plt.cla()
+            # for stopping simulation with the esc key.
             plt.gcf().canvas.mpl_connect('key_release_event',
                     lambda event: [exit(0) if event.key == 'escape' else None])
             plt.plot(previous_points[0, :], previous_points[1, :], ".r")