Merge pull request #205 from MihaMi27/TCX-GPX-Refactoring

TCX/GPX Manipulation Refactorings
firefly-cpp · Dec 15, 2024 · aaf0228 · aaf0228
2 parents c1c96ba + 2f5bc2e
commit aaf0228
Show file tree

Hide file tree

Showing 33 changed files with 309 additions and 114 deletions.
diff --git a/README.md b/README.md
@@ -154,10 +154,11 @@ from sport_activities_features.tcx_manipulation import TCXFile
 
 # Class for reading TCX files
 tcx_file=TCXFile()
-data = tcx_file.read_one_file("path_to_the_file") # Represents data as dictionary of lists
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+data = tcx_file.extract_activity_data(tcx_exercise) # Represents data as dictionary of lists
 
 # Alternative choice
-data = tcx_file.read_one_file("path_to_the_file", numpy_array= True) # Represents data as dictionary of numpy.arrays
+data = tcx_file.extract_activity_data(tcx_exercise, numpy_array= True) # Represents data as dictionary of numpy.arrays
 
 ```
 
@@ -169,10 +170,11 @@ from sport_activities_features.gpx_manipulation import GPXFile
 gpx_file=GPXFile()
 
 # Read the file and generate a dictionary with 
-data = gpx_file.read_one_file("path_to_the_file") # Represents data as dictionary of lists
+gpx_exercise = gpx_file.read_one_file("path_to_the_file")
+data = gpx_file.extract_activity_data(gpx_exercise) # Represents data as dictionary of lists
 
 # Alternative choice
-data = gpx_file.read_one_file("path_to_the_file", numpy_array= True) # Represents data as dictionary of numpy.arrays
+data = gpx_file.extract_activity_data(gpx_exercise, numpy_array= True) # Represents data as dictionary of numpy.arrays
 
 ```
 
@@ -185,7 +187,8 @@ from sport_activities_features.plot_data import PlotData
 
 # Read TCX file
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file("path_to_the_file")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # Detect hills in data
 Hill = HillIdentification(activity['altitudes'], 30)
@@ -211,7 +214,8 @@ from sport_activities_features.tcx_manipulation import TCXFile
 
 # Reading the TCX file
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file("path_to_the_data")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # Identifying the intervals in the activity by power
 Intervals = IntervalIdentificationByPower(activity["distances"], activity["timestamps"], activity["altitudes"], 70)
@@ -231,7 +235,8 @@ from sport_activities_features import TCXFile
 
 # Read TCX file
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file("path_to_file")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 # Configure visual crossing api key
 visual_crossing_api_key = "weather_api_key" # https://www.visualcrossing.com/weather-api
@@ -285,8 +290,8 @@ from sport_activities_features.tcx_manipulation import TCXFile
 
 # Read TCX file
 tcx_file = TCXFile()
-
-integral_metrics = tcx_file.extract_integral_metrics("path_to_the_file")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+integral_metrics = tcx_file.extract_integral_metrics(tcx_exercise)
 
 print(integral_metrics)
 
@@ -299,7 +304,9 @@ from sport_activities_features.tcx_manipulation import TCXFile
 
 #read TCX file
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file("path_to_the_file")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
+
 
 #configure visual crossing api key
 visual_crossing_api_key = "API_KEY" # https://www.visualcrossing.com/weather-api
@@ -351,7 +358,8 @@ from sport_activities_features.tcx_manipulation import TCXFile
 
 # Reading the TCX file.
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # Converting the read data to arrays.
 positions = np.array([*activity['positions']])
@@ -381,7 +389,8 @@ Identify interruption events from a TCX or GPX file.
 
 # read TCX file (also works with GPX files)
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file("path_to_the_data")
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 """
 Time interval = time before and after the start of an event
@@ -434,7 +443,8 @@ from sport_activities_features import ElevationIdentification
 from sport_activities_features import TCXFile
 
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file('path_to_file')
+tcx_exercise = tcx_file.read_one_file("path_to_the_file")
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 elevations = ElevationIdentification(tcx_data['positions'])
 """Adds tcx_data['elevation'] = eg. [124, 21, 412] for each position"""

diff --git a/examples/calculate_training_load.py b/examples/calculate_training_load.py
@@ -11,7 +11,8 @@
 
 # Reading a TCX file.
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file('../datasets/15.tcx')
+tcx_exercise = tcx_file.read_one_file('../datasets/15.tcx')
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 timestamps = activity['timestamps']
 heart_rates = activity['heartrates']

diff --git a/examples/convert_gpx_to_csv.py b/examples/convert_gpx_to_csv.py
@@ -12,8 +12,9 @@
 output_file = 'path_to_output_file'
 
 # Read GPX file
-data = gpx_file.read_one_file(
-    input_file,
+gpx_exercise = gpx_file.read_one_file(input_file)
+data = gpx_file.extract_activity_data(
+    gpx_exercise,
 )  # Represents data as dictionary of lists
 
 # Convert dictionary of lists to pandas DataFrame

diff --git a/examples/convert_tcx_to_csv.py b/examples/convert_tcx_to_csv.py
@@ -12,8 +12,9 @@
 output_file = 'path_to_output_file'
 
 # Read TCX file
-data = tcx_file.read_one_file(
-    input_file,
+tcx_exercise = tcx_file.read_one_file(input_file)
+data = tcx_file.extract_activity_data(
+    tcx_exercise,
 )  # Represents data as dictionary of lists
 
 # Convert dictionary of lists to pandas DataFrame

diff --git a/examples/dead_end_extraction.py b/examples/dead_end_extraction.py
@@ -8,7 +8,8 @@
 
 # Reading the TCX file.
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file('path_to_the_file')
+tcx_exercise = tcx_file.read_one_file('path_to_the_file')
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # Converting the read data to the array.
 positions = np.array([*activity['positions']])

diff --git a/examples/draw_map_with_identified_hills.py b/examples/draw_map_with_identified_hills.py
@@ -6,7 +6,8 @@
 # read TCX file
 tcx_file = TCXFile()
 
-data = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
+data = tcx_file.extract_activity_data(tcx_exercise)
 
 # detect hills in data
 Hill = HillIdentification(data['altitudes'], 30)

diff --git a/examples/draw_map_with_identified_intervals.py b/examples/draw_map_with_identified_intervals.py
@@ -8,6 +8,7 @@
 
 # Reading the TCX file
 tcx_file = TCXFile()
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
 (
     activity_type,
     positions,
@@ -17,7 +18,7 @@
     timestamps,
     heartrates,
     speeds,
-) = tcx_file.read_one_file('path_to_the_data').values()
+) = tcx_file.extract_activity_data(tcx_exercise).values()
 
 # Identifying the intervals in the activity by power and drawing the map
 Intervals = IntervalIdentificationByPower(distances, timestamps, altitudes, 70)

diff --git a/examples/extract_data_inside_area.py b/examples/extract_data_inside_area.py
@@ -16,7 +16,8 @@
 # Reading all files in filder.
 for file in all_files:
     print('\rProgress: ', int(progress), '%', end='')
-    activity = tcx_file.read_one_file(file)
+    tcx_exercise = tcx_file.read_one_file(file)
+    activity = tcx_file.extract_activity_data(tcx_exercise)
 
     # Converting the read data to arrays.
     positions = np.array([*activity['positions']])

diff --git a/examples/hill_data_extraction.py b/examples/hill_data_extraction.py
@@ -4,7 +4,8 @@
 
 # read TCX file
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # detect hills in data
 Hill = HillIdentification(activity['altitudes'], 30)

diff --git a/examples/identify_interruptions.py b/examples/identify_interruptions.py
@@ -9,7 +9,8 @@
 
 # read TCX file (also works with GPX files)
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 """
 Time interval = time before and after the start of an event

diff --git a/examples/integral_metrics_extraction.py b/examples/integral_metrics_extraction.py
@@ -3,6 +3,7 @@
 # read TCX file
 tcx_file = TCXFile()
 # extract integral metrics ans store it in dictionary
-integral_metrics = tcx_file.extract_integral_metrics('path_to_the_file')
+tcx_exercise = tcx_file.read_one_file('path_to_the_file')
+integral_metrics = tcx_file.extract_integral_metrics(tcx_exercise)
 
 print(integral_metrics)
diff --git a/examples/interval_data_extraction.py b/examples/interval_data_extraction.py
@@ -9,7 +9,8 @@
 
 # Reading the TCX file
 tcx_file = TCXFile()
-activity = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
+activity = tcx_file.extract_activity_data(tcx_exercise)
 
 # Identifying the intervals in the activity by power
 Intervals = IntervalIdentificationByPower(

diff --git a/examples/missing_elevation_data_extraction.py b/examples/missing_elevation_data_extraction.py
@@ -1,7 +1,8 @@
 from sport_activities_features import ElevationIdentification, TCXFile
 
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file('path_to_the_data')
+tcx_exercise = tcx_file.read_one_file('path_to_the_data')
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 elevations = ElevationIdentification(tcx_data['positions'])
 """Adds tcx_data['elevation'] = eg. [124, 21, 412] for each position"""

diff --git a/examples/read_all_files.py b/examples/read_all_files.py
@@ -15,9 +15,10 @@
 # Extracting the data of all files
 activities = []
 for file in all_files:
+    tcx_exercise = tcx_file.read_one_file(file)
     activity = {'ID': os.path.splitext(os.path.split(file)[-1])[0]}
-    activity.update(tcx_file.read_one_file(file))
-    activity.update(tcx_file.extract_integral_metrics(file))
+    activity.update(tcx_file.extract_activity_data(tcx_exercise))
+    activity.update(tcx_file.extract_integral_metrics(tcx_exercise))
 
     # Hills
     Hill = HillIdentification(activity['altitudes'], 30)

diff --git a/examples/read_folder.py b/examples/read_folder.py
@@ -6,5 +6,6 @@
 
 # iterate through files and print total distance of activities
 for i in range(len(all_files)):
-    activity = tcx_file.read_one_file(all_files[i])
+    tcx_exercise = tcx_file.read_one_file(all_files[i])
+    activity = tcx_file.extract_activity_data(tcx_exercise)
     print('total distance: ', activity['total_distance'] / 1000)
diff --git a/examples/read_gpx_file.py b/examples/read_gpx_file.py
@@ -2,4 +2,5 @@
 
 # read GPX file
 gpx_file = GPXFile()
-data = gpx_file.read_one_file('path_to_the_file')
+gpx_exercise = gpx_file.read_one_file('path_to_the_file')
+data = gpx_file.extract_activity_data(gpx_exercise)
diff --git a/examples/read_tcx_file.py b/examples/read_tcx_file.py
@@ -2,4 +2,5 @@
 
 # read TCX file
 tcx_file = TCXFile()
-data = tcx_file.read_one_file('path_to_the_file')
+tcx_exercise = tcx_file.read_one_file('path_to_the_file')
+data = tcx_file.extract_activity_data(tcx_exercise)
diff --git a/examples/weather_data_extraction.py b/examples/weather_data_extraction.py
@@ -2,7 +2,8 @@
 
 # Read TCX file
 tcx_file = TCXFile()
-tcx_data = tcx_file.read_one_file('path_to_the_file')
+tcx_exercise = tcx_file.read_one_file('path_to_the_file')
+tcx_data = tcx_file.extract_activity_data(tcx_exercise)
 
 # Configure visual crossing api key
 # https://www.visualcrossing.com/weather-api