Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IPC diagram #43

Open
ziw-liu opened this issue May 22, 2023 · 1 comment
Open

IPC diagram #43

ziw-liu opened this issue May 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation meta

Comments

@ziw-liu
Copy link
Contributor

ziw-liu commented May 22, 2023

I made this mermaid diagram (click the copy button or 'edit' on this message for source code) to explain how information flows between softwares in future mantis acquisitions:

sequenceDiagram
    %% this section is for defining sequence, the diagram will still render without these
    participant Micro-Manager
    participant mantis
    participant recOrder
    participant ONNX
    loop every FOV
        mantis->>Micro-Manager: hardware event queue
        Micro-Manager->>mantis: raw BF
        mantis->>recOrder: BF and metadata
        Note over recOrder: waveorder reconstruction algorithms
        recOrder->>mantis: reconstructed phase
        mantis->>ONNX: reconstructed phase
        Note over ONNX: run microDL model
        ONNX->>mantis: nuclei prediction
        Note over mantis: FOV scoring
    end
    mantis->>Micro-Manager: new hardware event queue
Loading

This text-based approach can be versioned and is potentially useful for documenting the inter-thread/process communication architecture in this project. E.g. for #27.

@ziw-liu ziw-liu added the documentation Improvements or additions to documentation label May 22, 2023
@mattersoflight
Copy link
Collaborator

nice!

@ieivanov ieivanov added the meta label Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation meta
Projects
None yet
Development

No branches or pull requests

3 participants