Skip to content

Metadata

kloppy.domain.Metadata dataclass

Metadata(periods, teams, coordinate_system, pitch_dimensions, orientation, flags, provider, score=None, frame_rate=None, date=None, game_week=None, game_id=None, officials=list(), attributes=dict())

Metadata for a dataset.

Metadata is additional information about the dataset that is not part of the actual data. It includes information about the teams, the pitch dimensions, the orientation, the provider, and more.

ATTRIBUTE DESCRIPTION
game_id

Game id of the game from the provider.

TYPE: Optional[str]

date

Date of the game.

TYPE: Optional[datetime]

game_week

Game week (or match day) of the game. It can also be the stage (ex: "8th Finals"), if the game is happening during a cup or a play-off.

TYPE: Optional[str]

periods

List of Period entities.

TYPE: list[Period]

teams

[home_team, away_team].

TYPE: list[Team]

coordinate_system

The coordinate system in which the data is provided.

TYPE: CoordinateSystem

pitch_dimensions

The dimensions of the pitch.

TYPE: PitchDimensions

orientation

The attacking direction of each team.

TYPE: Orientation

flags

Flags describing what optional data is available in the dataset.

TYPE: DatasetFlag

provider

The provider of the dataset.

TYPE: Provider

score

The final score of the match.

TYPE: Optional[Score]

frame_rate

The frame rate (in Hertz) at which the data was recorded. Only for tracking data.

TYPE: Optional[float]

attributes

Additional metadata.

TYPE: Optional[dict]

periods instance-attribute

periods

teams instance-attribute

teams

coordinate_system instance-attribute

coordinate_system

pitch_dimensions instance-attribute

pitch_dimensions

orientation instance-attribute

orientation

flags instance-attribute

flags

provider instance-attribute

provider

score class-attribute instance-attribute

score = None

frame_rate class-attribute instance-attribute

frame_rate = None

date class-attribute instance-attribute

date = None

game_week class-attribute instance-attribute

game_week = None

game_id class-attribute instance-attribute

game_id = None

officials class-attribute instance-attribute

officials = field(default_factory=list)

attributes class-attribute instance-attribute

attributes = field(default_factory=dict, compare=False)

home_coach property

home_coach

away_coach property

away_coach