# yushiuan9499/michelson-interfer architecture

> Architecture diagram of the GitHub repository yushiuan9499/michelson-interfer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yushiuan9499/michelson-interfer
- Repository: https://github.com/yushiuan9499/michelson-interfer

## Overview

##### Project Type and Purpose
- This is a desktop Qt5 C++ application that automates analysis of Michelson interferometer videos.

##### High-Level Architecture Overview
- Monolithic desktop client separated into:
a. User Interface (Qt MainWindow)
b. Core Processing (Analyzer)
c. File I/O and Data Export (FileIo)
d. External Libraries (Qt5 modules, OpenCV)
- Communication is via Qt’s signal-slot mechanism.

##### Main Components
- GUI Module
- src/header/mainWindow.h / src/source/mainWindow.cpp
- Contains controls to load video, select ROI, start analysis, show plots or status.
- Emits signals like “startAnalysis()” or “exportCsv()”.
- File I/O Module
- src/header/fileIo.h / src/source/fileIo.cpp
- Opens video files via OpenCV VideoCapture, reads frames, handles CSV writes.
- Analyzer Module
- src/header/analyzer.h / src/source/analyzer.cpp
- Application Entry Point
- src/main.cpp
- Initializes QApplication, loads the MainWindow, connects signals to slots.
- External Libraries
- Qt5 (Widgets, Core) for GUI, event loop, signals/slots.
- OpenCV for video decoding and image processing.

##### Relationships and Data Flow
1. User clicks “Load Video” in GUI → FileIo opens file via OpenCV → emits frame-ready signals.
2. GUI passes frame and ROI rectangle to Analyzer → Analyzer processes image → emits result data.
3. GUI receives process updates → updates display/progress bar.
4. On “Export CSV” command, GUI calls FileIo to write results to disk.

##### Architectural Patterns and Principles
- Separation of concerns: UI logic (MainWindow) is decoupled from image processing and file handling.
- Event-driven design: Qt signals/slots handle asynchronous processing and UI updates.
- Single responsibility: each module (Analyzer, FileIo, MainWindow) has a focused role.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External user
    User["User"]:::external

    %% Application entry and configuration
    Entry["Application Entry Point\n(src/main.cpp)"]:::config
    Config["Build & Configuration\n(src/src.pro)"]:::config

    %% Main components
    MainWindow["MainWindow (UI Module)"]:::ui
    FileIo["FileIo (I/O & Data Export)"]:::io
    Analyzer["Analyzer (Processing Module)"]:::processing

    %% External libraries
    subgraph "External Libraries"
        External["Qt5 (Widgets, Core)\nOpenCV"]:::ext
    end

    %% Data flow and signals
    User -->|"1. click Load Video"| MainWindow
    MainWindow -->|"2. loadVideo() signal"| FileIo
    FileIo -->|"3. frameReady() signal"| MainWindow
    MainWindow -->|"4. processFrame() signal"| Analyzer
    Analyzer -->|"5. analysisResult() signal"| MainWindow
    MainWindow -->|"6. exportCsv() signal"| FileIo

    %% Dependencies on external libs
    FileIo -->|"uses OpenCV"| External
    Analyzer -->|"uses OpenCV"| External
    MainWindow -->|"uses Qt5 signals/slots"| External

    %% Startup and build
    Entry -->|"initializes QApplication\nloads MainWindow"| MainWindow
    Config -.->|"qmake configuration"| Entry

    %% Click Events
    click MainWindow "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/header/mainWindow.h"
    click MainWindow "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/source/mainWindow.cpp"
    click Analyzer "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/header/analyzer.h"
    click Analyzer "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/source/analyzer.cpp"
    click FileIo "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/header/fileIo.h"
    click FileIo "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/source/fileIo.cpp"
    click Entry "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/main.cpp"
    click Config "https://github.com/yushiuan9499/michelson-interfer/blob/master/src/src.pro"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#004085,color:#004085;
    classDef processing fill:#d4edda,stroke:#155724,color:#155724;
    classDef io fill:#fff3cd,stroke:#856404,color:#856404;
    classDef ext fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef config fill:#f8d7da,stroke:#721c24,color:#721c24;
    classDef external fill:#ffffff,stroke:#000000,color:#000000,stroke-dasharray: 5 5;
```
