Skip to content

Signality

kloppy.signality

load 

1
2
3
4
5
6
7
8
load(
    meta_data,
    raw_data_feeds,
    venue_information,
    sample_rate=None,
    limit=None,
    coordinates=None,
)

Load and deserialize tracking data from multiple input files.

PARAMETER DESCRIPTION
meta_data

json feed containing metadata information of the game.

TYPE: FileLike

raw_data_feeds

json feeds containing raw tracking data feeds.

TYPE: Iterable[FileLike]

venue_information

json feed containing venue information where the game was played.

TYPE: FileLike

sample_rate

Sampling rate to be applied during deserialization (default: None).

TYPE: Optional[float] DEFAULT: None

limit

Limit on the number of frames to process (default: None).

TYPE: Optional[int] DEFAULT: None

coordinates

Coordinate system to use for deserialization (default: None).

TYPE: Optional[str] DEFAULT: None

RETURNS DESCRIPTION
TrackingDataset

A deserialized tracking dataset object.

TYPE: TrackingDataset

Source code in kloppy/_providers/signality.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def load(
    meta_data: FileLike,
    raw_data_feeds: Iterable[FileLike],
    venue_information: FileLike,
    sample_rate: Optional[float] = None,
    limit: Optional[int] = None,
    coordinates: Optional[str] = None,
) -> TrackingDataset:
    """
    Load and deserialize tracking data from multiple input files.

    Args:
        meta_data (FileLike): json feed containing metadata information of the game.
        raw_data_feeds (Iterable[FileLike]): json feeds containing raw tracking data feeds.
        venue_information (FileLike): json feed containing venue information where the game was played.
        sample_rate (Optional[float]): Sampling rate to be applied during deserialization (default: None).
        limit (Optional[int]): Limit on the number of frames to process (default: None).
        coordinates (Optional[str]): Coordinate system to use for deserialization (default: None).

    Returns:
        TrackingDataset: A deserialized tracking dataset object.
    """

    raw_data_feeds = expand_inputs(raw_data_feeds)

    deserializer = SignalityDeserializer(
        sample_rate=sample_rate,
        limit=limit,
        coordinate_system=coordinates,
    )

    with open_as_file(meta_data) as meta_data_fp, open_as_file(
        venue_information
    ) as venue_information_fp:
        return deserializer.deserialize(
            inputs=SignalityInputs(
                meta_data=meta_data_fp,
                venue_information=venue_information_fp,
                raw_data_feeds=raw_data_feeds,
            )
        )