|
2 | 2 |
|
3 | 3 | `sleap-io` implements the core data structures used in SLEAP for storing data related to multi-instance pose tracking, including for annotation, training and inference. |
4 | 4 |
|
| 5 | +## Class Relationships |
| 6 | + |
| 7 | +The following diagram shows the relationships between the main classes in the `sleap-io` data model: |
| 8 | + |
| 9 | +``` mermaid |
| 10 | +classDiagram |
| 11 | + class Labels { |
| 12 | + +List~LabeledFrame~ labeled_frames |
| 13 | + +List~Video~ videos |
| 14 | + +List~Skeleton~ skeletons |
| 15 | + +List~Track~ tracks |
| 16 | + } |
| 17 | + |
| 18 | + class LabeledFrame { |
| 19 | + +Video video |
| 20 | + +int frame_idx |
| 21 | + +List~Instance~ instances |
| 22 | + } |
| 23 | + |
| 24 | + class Instance { |
| 25 | + +Skeleton skeleton |
| 26 | + +Track track |
| 27 | + +PointsArray points |
| 28 | + } |
| 29 | + |
| 30 | + class PredictedInstance { |
| 31 | + +float score |
| 32 | + +int tracking_score |
| 33 | + } |
| 34 | + |
| 35 | + class Skeleton { |
| 36 | + +List~Node~ nodes |
| 37 | + +List~Edge~ edges |
| 38 | + +List~Symmetry~ symmetries |
| 39 | + } |
| 40 | + |
| 41 | + class Node { |
| 42 | + +str name |
| 43 | + } |
| 44 | + |
| 45 | + class Edge { |
| 46 | + +Node source |
| 47 | + +Node destination |
| 48 | + } |
| 49 | + |
| 50 | + class Symmetry { |
| 51 | + +Set~Node~ nodes |
| 52 | + } |
| 53 | + |
| 54 | + class Track { |
| 55 | + +str name |
| 56 | + } |
| 57 | + |
| 58 | + class Video { |
| 59 | + +str filename |
| 60 | + +VideoBackend backend |
| 61 | + } |
| 62 | + |
| 63 | + class LabelsSet { |
| 64 | + +List~Labels~ labels |
| 65 | + } |
| 66 | + |
| 67 | + Labels "1" *-- "0..*" LabeledFrame : contains |
| 68 | + Labels "1" *-- "0..*" Video : contains |
| 69 | + Labels "1" *-- "0..*" Skeleton : contains |
| 70 | + Labels "1" *-- "0..*" Track : contains |
| 71 | + |
| 72 | + LabeledFrame "0..*" --> "1" Video : references |
| 73 | + LabeledFrame "1" *-- "0..*" Instance : contains |
| 74 | + |
| 75 | + Instance "0..*" --> "1" Skeleton : uses |
| 76 | + Instance "0..*" --> "0..1" Track : belongs to |
| 77 | + Instance <|-- PredictedInstance : inherits |
| 78 | + |
| 79 | + Skeleton "1" *-- "1..*" Node : contains |
| 80 | + Skeleton "1" *-- "0..*" Edge : contains |
| 81 | + Skeleton "1" *-- "0..*" Symmetry : contains |
| 82 | + |
| 83 | + Edge "0..*" --> "2" Node : connects |
| 84 | + Symmetry "0..*" --> "2" Node : pairs |
| 85 | + |
| 86 | + LabelsSet "1" *-- "1..*" Labels : contains |
| 87 | +``` |
5 | 88 |
|
6 | 89 |
|
7 | | -::: sleap_io.Labels |
8 | 90 |
|
9 | | -::: sleap_io.LabelsSet |
| 91 | +::: sleap_io.Labels |
10 | 92 |
|
11 | 93 | ::: sleap_io.LabeledFrame |
12 | 94 |
|
|
37 | 119 | ::: sleap_io.InstanceGroup |
38 | 120 |
|
39 | 121 | ::: sleap_io.RecordingSession |
| 122 | + |
| 123 | +::: sleap_io.LabelsSet |
0 commit comments