# cardio-ai/endovis-ml architecture

> Architecture diagram of the GitHub repository cardio-ai/endovis-ml, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cardio-ai/endovis-ml
- Repository: https://github.com/cardio-ai/endovis-ml

## Overview

##### Main Components Overview

a. Frontend Components (Angular):
- Data Input Layer
- Visualization Layer
- Data Processing Layer
- State Management Layer

b. Core Services:
- Data Parser Service
- Data Sharing Service
- Data Forward Service
- Form Data Service

##### Detailed Component Breakdown

**[Data Input Layer]**
- Upload Component
- File Drop Directive
**↓**
**[Data Processing Layer]**
- Data Parser Service
- Set Methods Utility
**↓**
**[State Management Layer]**
- Data Sharing Service
- Instrument/Phase Selection Services
**↓**
**[Visualization Layer]**
- Graph View Component
- Set Overview Component
- Train-Test Component
- Instrument Co-occurrence Component

##### Data Flow Representation

- File upload → Data parsing → Data storage → Visualization
- User interactions → State updates → UI updates

##### Component Relationships

Key interactions:
- File upload component → Data parser service
- Parser service → Data sharing service
- Data sharing service → Visualization components
- Selection services → Visualization components

##### Data Model Integration

Data models:
- AnnotationRow
- SurgeryData
- CrossValSplit
- InstCooccurrenceNode

##### Technical Details

Annotations for:
- Angular framework version
- File format support (CSV)
- Supported delimiters
- Data validation rules

##### Component dependencies

Key Guidelines:

##### Validation and guard checkpoints

Remember to include:
- Input validation points
- Error handling flows
- State management patterns
- Service dependencies
- Component communication paths

This will provide a comprehensive view of the application's architecture while maintaining clarity and usefulness for development and maintenance purposes.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        UI[UI Component]:::ui
        SV[Service]:::service
        DM[Data Model]:::datamodel
        UT[Utility]:::utility
    end

    subgraph "Data Input Layer"
        Upload["Upload Component"]:::ui
        FileDrop["File Drop Directive"]:::ui
    end

    subgraph "Data Processing Layer"
        DataParser["Data Parser Service"]:::service
        LabelData["Label Data Service"]:::service
        SetMethods["Set Methods Utility"]:::utility
    end

    subgraph "State Management Layer"
        DataSharing["Data Sharing Service"]:::service
        InstrumentSelection["Instrument Selection Service"]:::service
        PhaseSelection["Phase Selection Service"]:::service
        DataForward["Data Forward Service"]:::service
        FormData["Form Data Service"]:::service
    end

    subgraph "Data Models"
        AnnotationRow["AnnotationRow"]:::datamodel
        SurgeryData["SurgeryData"]:::datamodel
        CrossValSplit["CrossValSplit"]:::datamodel
        InstCooccurrenceNode["InstCooccurrenceNode"]:::datamodel
    end

    subgraph "Visualization Layer"
        GraphView["Graph View Component"]:::ui
        SetOverview["Set Overview Component"]:::ui
        TrainTest["Train-Test Component"]:::ui
        InstCoocurrence["Instrument Co-occurrence Component"]:::ui
    end

    Upload --> DataParser
    FileDrop --> Upload
    DataParser --> DataSharing
    DataParser --> AnnotationRow
    DataSharing --> SurgeryData
    DataSharing --> CrossValSplit
    DataSharing --> InstCooccurrenceNode
    DataSharing --> GraphView
    DataSharing --> SetOverview
    DataSharing --> TrainTest
    DataSharing --> InstCoocurrence
    InstrumentSelection --> GraphView
    PhaseSelection --> GraphView
    SetMethods --> DataParser
    LabelData --> DataParser
    DataForward --> DataSharing
    FormData --> DataSharing

    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef datamodel fill:#f1c40f,stroke:#f39c12,color:black
    classDef utility fill:#95a5a6,stroke:#7f8c8d,color:white

    click Upload "https://github.com/Cardio-AI/endovis-ml/tree/main/src/app/upload"
    click FileDrop "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/directives/file-drop.directive.ts"
    click DataParser "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/data-parser.service.ts"
    click DataSharing "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/data-sharing.service.ts"
    click DataForward "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/data-forward.service.ts"
    click FormData "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/form-data.service.ts"
    click LabelData "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/label-data.service.ts"
    click GraphView "https://github.com/Cardio-AI/endovis-ml/tree/main/src/app/graph-view"
    click SetOverview "https://github.com/Cardio-AI/endovis-ml/tree/main/src/app/set-overview"
    click TrainTest "https://github.com/Cardio-AI/endovis-ml/tree/main/src/app/train-test"
    click InstCoocurrence "https://github.com/Cardio-AI/endovis-ml/tree/main/src/app/inst-coocurrence"
    click InstrumentSelection "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/instrument-selection.service.ts"
    click PhaseSelection "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/service/phase-selection.service.ts"
    click AnnotationRow "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/model/AnnotationRow.ts"
    click SurgeryData "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/model/SurgeryData.ts"
    click CrossValSplit "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/model/CrossValSplit.ts"
    click InstCooccurrenceNode "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/model/InstCooccurrenceNode.ts"
    click SetMethods "https://github.com/Cardio-AI/endovis-ml/blob/main/src/app/util/SetMethods.ts"
```
