Skip to content

Dimension

kloppy.domain.Dimension dataclass 

1
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 

1
min = None

max class-attribute instance-attribute 

1
max = None

to_base 

1
to_base(value)

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

Source code in kloppy/domain/models/pitch.py 
110
111
112
113
114
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 

1
from_base(value)

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

Source code in kloppy/domain/models/pitch.py 
116
117
118
119
120
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