Merge pull request #2 from WoutPaepenUcLL/update-secondspectrum-load

Update secondspectrum load function to support current metadata.json format

Author: WoutPaepenUcLL

kloppy/infra/serializers/tracking/secondspectrum.py

@@ -130,13 +130,13 @@ def deserialize(self, inputs: SecondSpectrumInputs) -> TrackingDataset:
                 metadata = json.loads(first_byte + inputs.meta_data.read())
 
                 frame_rate = float(metadata.get("fps", 25.0))
-                pitch_size_height = float(metadata["data"]["pitchLength"])
-                pitch_size_width = float(metadata["data"]["pitchWidth"])
+                pitch_size_height = float(metadata["data"].get("pitchLength", 104.8512))
+                pitch_size_width = float(metadata["data"].get("pitchWidth", 67.9704))
 
                 periods = []
                 for period in metadata["periods"]:
-                    start_frame_id = int(period["startFrameIdx"])
-                    end_frame_id = int(period["endFrameIdx"])
+                    start_frame_id = int(period["startFrameClock"])
+                    end_frame_id = int(period["endFrameClock"])
                     if start_frame_id != 0 or end_frame_id != 0:
                         # Frame IDs are unix timestamps (in milliseconds)
                         periods.append(

kloppy/tests/test_secondspectrum.py

@@ -223,3 +223,111 @@ def test_load_without_fps(self, meta_data: Path, raw_data: Path):
         if game_id:
             assert isinstance(game_id, str)
             assert game_id == "1234456"
+
+    def test_load_with_current_metadata_format(
+        self, meta_data: Path, raw_data: Path, additional_meta_data: Path
+    ):
+        dataset = secondspectrum.load(
+            meta_data=meta_data,
+            raw_data=raw_data,
+            additional_meta_data=additional_meta_data,
+            only_alive=False,
+            coordinates="secondspectrum",
+        )
+
+        # Check provider, type, shape, etc
+        assert dataset.metadata.provider == Provider.SECONDSPECTRUM
+        assert dataset.dataset_type == DatasetType.TRACKING
+        assert len(dataset.records) == 376
+        assert len(dataset.metadata.periods) == 2
+        assert dataset.metadata.orientation == Orientation.AWAY_HOME
+
+        # Check the Periods
+        assert dataset.metadata.periods[0].id == 1
+        assert dataset.metadata.periods[0].start_timestamp == timedelta(
+            seconds=0
+        )
+        assert dataset.metadata.periods[0].end_timestamp == timedelta(
+            seconds=2982240 / 25
+        )
+
+        assert dataset.metadata.periods[1].id == 2
+        assert dataset.metadata.periods[1].start_timestamp == timedelta(
+            seconds=3907360 / 25
+        )
+        assert dataset.metadata.periods[1].end_timestamp == timedelta(
+            seconds=6927840 / 25
+        )
+
+        # Check some timestamps
+        assert dataset.records[0].timestamp == timedelta(
+            seconds=0
+        )  # First frame
+        assert dataset.records[20].timestamp == timedelta(
+            seconds=320.0
+        )  # Later frame
+        assert dataset.records[187].timestamp == timedelta(
+            seconds=9.72
+        )  # Second period
+
+        # Check some players
+        home_player = dataset.metadata.teams[0].players[2]
+        assert home_player.player_id == "8xwx2"
+        assert dataset.records[0].players_coordinates[home_player] == Point(
+            x=-8.943903672572427, y=-28.171654132650365
+        )
+
+        away_player = dataset.metadata.teams[1].players[3]
+        assert away_player.player_id == "2q0uv"
+        assert dataset.records[0].players_coordinates[away_player] == Point(
+            x=-45.11871334915762, y=-20.06459030559596
+        )
+
+        # Check the ball
+        assert dataset.records[1].ball_coordinates == Point3D(
+            x=-23.147073918432426, y=13.69367399756424, z=0.0
+        )
+
+        # Check pitch dimensions
+        pitch_dimensions = dataset.metadata.pitch_dimensions
+        assert pitch_dimensions.x_dim.min == -52.425
+        assert pitch_dimensions.x_dim.max == 52.425
+        assert pitch_dimensions.y_dim.min == -33.985
+        assert pitch_dimensions.y_dim.max == 33.985
+
+        # Check enriched metadata
+        date = dataset.metadata.date
+        if date:
+            assert isinstance(date, datetime)
+            assert date == datetime(1900, 1, 26, 0, 0, tzinfo=timezone.utc)
+
+        game_week = dataset.metadata.game_week
+        if game_week:
+            assert isinstance(game_week, str)
+            assert game_week == "1"
+
+        game_id = dataset.metadata.game_id
+        if game_id:
+            assert isinstance(game_id, str)
+            assert game_id == "1234456"
+
+        # Check team and player information
+        home_team = dataset.metadata.teams[0]
+        assert home_team.team_id == "123"
+        assert home_team.name == "FK1"
+
+        away_team = dataset.metadata.teams[1]
+        assert away_team.team_id == "456"
+        assert away_team.name == "FK2"
+
+        home_player = home_team.players[0]
+        assert home_player.player_id == "0a39g4"
+        assert home_player.name == "y9xrbe545u3h"
+        assert home_player.starting is False
+        assert home_player.starting_position == "SUB"
+
+        away_player = away_team.players[0]
+        assert away_player.player_id == "9bgzhy"
+        assert away_player.name == "c6gupnmywca0"
+        assert away_player.starting is True
+        assert away_player.starting_position == "GK"