Merge pull request #77 from BenjaminLarrousse/add_length_width_to_pit…

…chdim Add length and width to PitchDimensions
PySport · Dec 22, 2020 · 9f659dd · 9f659dd
2 parents 3f541aa + d567d40
commit 9f659dd
Show file tree

Hide file tree

Showing 6 changed files with 93 additions and 4 deletions.
diff --git a/docs/quickstart/event_data.ipynb b/docs/quickstart/event_data.ipynb
@@ -459,7 +459,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.5.2"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/docs/quickstart/examples.ipynb b/docs/quickstart/examples.ipynb
@@ -128,7 +128,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.5.2"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/docs/quickstart/state.ipynb b/docs/quickstart/state.ipynb
@@ -1090,7 +1090,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.5.2"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/docs/quickstart/tracking_data.ipynb b/docs/quickstart/tracking_data.ipynb
@@ -157,7 +157,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.5.2"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/kloppy/domain/models/pitch.py b/kloppy/domain/models/pitch.py
@@ -21,6 +21,22 @@ class PitchDimensions:
     x_per_meter: float = None
     y_per_meter: float = None
 
+    @property
+    def length(self) -> float:
+        return (
+            (self.x_dim.max - self.x_dim.min) / self.x_per_meter
+            if self.x_per_meter
+            else None
+        )
+
+    @property
+    def width(self) -> float:
+        return (
+            (self.y_dim.max - self.y_dim.min) / self.y_per_meter
+            if self.y_per_meter
+            else None
+        )
+
 
 @dataclass(frozen=True)
 class Point:

diff --git a/kloppy/tests/test_metadata.py b/kloppy/tests/test_metadata.py
@@ -0,0 +1,21 @@
+from kloppy.domain import Dimension, PitchDimensions
+
+
+class TestPitchdimensions:
+    def test_pitchdimensions_properties(self):
+        pitch_without_scale = PitchDimensions(
+            x_dim=Dimension(-100, 100), y_dim=Dimension(-50, 50)
+        )
+
+        assert pitch_without_scale.length is None
+        assert pitch_without_scale.width is None
+
+        pitch_with_scale = PitchDimensions(
+            x_dim=Dimension(-100, 100),
+            y_dim=Dimension(-50, 50),
+            x_per_meter=20 / 12,
+            y_per_meter=10 / 8,
+        )
+
+        assert pitch_with_scale.length == 120
+        assert pitch_with_scale.width == 80