ssscoring.datatypes

 1# See: https://github.com/pr3d4t0r/SSScoring/blob/master/LICENSE.txt
 2
 3
 4"""
 5SSScoring custom type definitions for easier symbolic manipuation.
 6"""
 7
 8from collections import namedtuple
 9from enum import Enum
10
11
12# +++ implementation +++
13
14class FlySightVersion(Enum):
15    """
16    Symbols for handling device version.
17    """
18    V1 = 1000
19    INSIGHT = 1100
20    V2 = 2000
21
22
23class JumpStatus(Enum):
24    OK = 0
25    ALTITUDE_EXCEEDS_MINIMUM = 100
26    ALTITUDE_EXCEEDS_MAXIMUM = 110
27    INVALID_SPEED_FILE = 120
28    SPEED_ACCURACY_EXCEEDS_LIMIT = 200
29    WARM_UP_FILE = 300
30    UNSUPPORTED_PLD_FORMAT = 400
31
32
33JumpResults = namedtuple(
34    'JumpResults',
35    'data maxSpeed score scores table window status backFall backFallOnset forwardReversalM lateralReversalM',
36    defaults=(False, None, 0.0, 0.0),
37)
38"""
39A named tuple containing the score, maximum speed, scores throught the
40performance window, the results table for a jump, the output color for the
41result, and the result information string.
42
43Attributes
44----------
45- `data` - dataframe containing all the data points for plotting and
46           calculations
47- `maxSpeed` - maximum absolute speed registered during a skydive
48- `score` - maximum mean speed during a 3-second window during the skydive
49- `scores` - a dictionary with all the scored ruding the sliding 3-sec window
50             for the speed run
51- `table` - summary table of results of the speed run
52- `window` - the scoring window data, an instance of `PerformanceWindow`
53- `status` - An instance of `ssscoring.datatypes.JumpStatus`
54- `backFall` - `True` if a back-fall was detected within the performance window
55- `backFallOnset` - `plotTime` (seconds from exit) at back-fall onset, or `None`
56- `forwardReversalM` - metres of reversed ground travel along the jump run axis
57- `lateralReversalM` - metres of reversed ground travel on the lateral axis
58"""
59
60
61PerformanceWindow = namedtuple('PerformanceWindow', 'start end validationStart')
62"""
63An object to handle the performance window (as defined in competition rules) as
64a single object with all the properties necessary to interpret it and manipulate
65it across different function or method calls.
66
67Attributes
68----------
69- `start` - beginning or start of the performance window, or exit from the
70            aircraft
71- `end` - end of the performance window, or `start-PERFORMANCE_WINDOW_LENGTH`
72- `validationStart` - end of the performance window - the `VALIDATION_WINDOW_END`
73
74See
75---
76    ssscoring.constants.PERFORMANCE_WINDOW_LENGTH
77    ssscoring.constants.VALIDATION_WINDOW_END
78"""