Merge pull request #204 from MihaMi27/main

Issue #202: Fix naming of methods in PlotData, DeadEndIdentification

examples/dead_end_extraction.py

@@ -21,4 +21,4 @@
                                   tolerance_position=2,
                                   minimum_distance=500)
 Dead_ends.identify_dead_ends()
-Dead_ends.draw_map()
+Dead_ends.show_map()

examples/draw_map_with_identified_hills.py

@@ -16,4 +16,4 @@
 # draw detected hills
 Map = PlotData()
 
-Map.draw_hills_in_map(data['altitudes'], data['distances'], all_hills)
+Map.show_hills_on_map(data['altitudes'], data['distances'], all_hills)

examples/draw_map_with_identified_intervals.py

@@ -24,7 +24,7 @@
 Intervals.identify_intervals()
 all_intervals = Intervals.return_intervals()
 Map = PlotData()
-Map.draw_intervals_in_map(timestamps, distances, all_intervals)
+Map.show_intervals_on_map(timestamps, distances, all_intervals)
 
 # Identifying the intervals in the activity by heart rate and drawing the map
 Intervals = IntervalIdentificationByHeartRate(
@@ -33,4 +33,4 @@
 Intervals.identify_intervals()
 all_intervals = Intervals.return_intervals()
 Map = PlotData()
-Map.draw_intervals_in_map(timestamps, distances, all_intervals)
+Map.show_intervals_on_map(timestamps, distances, all_intervals)

sport_activities_features/dead_end_identification.py

@@ -288,12 +288,12 @@ def identify_dead_ends(self) -> None:
 
         print('\rProgress: 100 %')
 
-    def draw_map(self) -> None:
+    def show_map(self) -> None:
         """Method for visualisation of the exercise with identified dead ends."""
-        plot = self.show_map()
+        plot = self.plot_map()
         plot.show()
 
-    def show_map(self) -> plt:
+    def plot_map(self) -> plt:
         """Method for plotting the exercise with dead ends.
 
         Returns:        

sport_activities_features/plot_data.py

@@ -35,14 +35,14 @@ def get_positions_of_intervals(self, identified_intervals: list) -> list:
                 points.append(identified_intervals[i][j])
         return points
 
-    def draw_hills_in_map(
+    def show_hills_on_map(
         self,
         altitude: list,
         distance: list,
         identified_hills: list,
     ) -> None:
-        """Method for plotting all hills identified in data
-        on topographic map and rendering the plot.\n
+        """Method for rendering all hills identified in data
+        on topographic map plot.\n
         Args:
             altitude (list):
                 list of altitudes
@@ -54,14 +54,14 @@ def draw_hills_in_map(
         plt = self.plot_hills_on_map(altitude, distance, identified_hills)
         plt.show()
 
-    def draw_intervals_in_map(
+    def show_intervals_on_map(
         self,
         timestamp: list,
         distance: list,
         identified_intervals: list,
     ) -> None:
-        """Method for plotting all intervals identified in data
-        on topographic map and rendering the plot.\n
+        """Method for rendering all intervals identified in data
+        on topographic map plot.\n
         Args:
             timestamp (datetime):
                 list of timestamps
@@ -73,8 +73,8 @@ def draw_intervals_in_map(
         plt = self.plot_intervals_in_map(timestamp, identified_intervals)
         plt.show()
 
-    def draw_basic_map(self) -> None:
-        """Method for plotting the whole topographic map and rendering the plot."""
+    def show_basic_map(self) -> None:
+        """Method for rendering the whole topographic map plot."""
         plt = self.plot_basic_map()
         plt.show()