Dimension

kloppy.domain.Dimension dataclass

Dimension(min=None, max=None)

Limits of pitch boundaries along a single axis.

ATTRIBUTE	DESCRIPTION
min	Minimal possible value within this dimension TYPE: Optional[float]
max	Maximal possible value within this dimension TYPE: Optional[float]

min class-attribute instance-attribute

min = None

max class-attribute instance-attribute

max = None

to_base

to_base(value)

Map a value from this dimension to [0, 1].

Source code in kloppy/domain/models/pitch.py

def to_base(self, value: float) -> float:
    """Map a value from this dimension to [0, 1]."""
    if self.min is None or self.max is None:
        raise MissingDimensionError()
    return (value - self.min) / (self.max - self.min)

from_base

from_base(value)

Map a value from [0, 1] to this dimension.

Source code in kloppy/domain/models/pitch.py

def from_base(self, value: float) -> float:
    """Map a value from [0, 1] to this dimension."""
    if self.min is None or self.max is None:
        raise MissingDimensionError()
    return value * (self.max - self.min) + self.min