Skip to content
github-actions[bot] edited this page Jul 20, 2026 · 3 revisions

Project Structure

β”œβ”€β”€ main.py                        # Guided terminal UI
β”œβ”€β”€ fit_cli.py                     # FLIM fitting CLI
β”œβ”€β”€ phasor_cli.py                  # Phasor analysis CLI
β”œβ”€β”€ synth_cli.py                   # Synthetic known-truth PTU/SDT generator
β”œβ”€β”€ build_and_sign.py              # PyInstaller build + codesign
β”œβ”€β”€ validate_installation.py       # Installation sanity check (10 checks)
β”œβ”€β”€ hardware_limits.py             # Hardware stress test - throughput & RAM headroom
β”œβ”€β”€ requirements.txt
β”‚
β”œβ”€β”€ flimkit/
β”‚   β”œβ”€β”€ configs.py                 # Default fitting parameters
β”‚   β”œβ”€β”€ interactive.py             # Guided fitting launcher
β”‚   β”œβ”€β”€ phasor_launcher.py         # Guided phasor launcher
β”‚   β”œβ”€β”€ machine_irf/               # Machine IRF files - generated per system
β”‚   β”‚
β”‚   β”œβ”€β”€ UI/
β”‚   β”‚   β”œβ”€β”€ gui.py                 # Tkinter desktop GUI
β”‚   β”‚   β”œβ”€β”€ roi_tools.py           # ROI drawing panel, RoiManager, per-ROI decay fitting
β”‚   β”‚   └── phasor_panel.py        # Embedded phasor view panel
β”‚   β”‚
β”‚   β”œβ”€β”€ synth.py                   # Synthetic known-truth data generation
β”‚   β”‚
β”‚   β”œβ”€β”€ formats/
β”‚   β”‚   β”œβ”€β”€ flim_file.py           # FLIMFile, detect_format - format dispatch
β”‚   β”‚   β”œβ”€β”€ PTU/
β”‚   β”‚   β”‚   β”œβ”€β”€ reader.py          # PTUFile (wraps ptufile), read_pck
β”‚   β”‚   β”‚   β”œβ”€β”€ decode.py          # Histogram extraction for tile stitching
β”‚   β”‚   β”‚   β”œβ”€β”€ tools.py           # signal_from_PTUFile (xarray)
β”‚   β”‚   β”‚   └── stitch.py          # Multi-tile stitching + registration
β”‚   β”‚   β”œβ”€β”€ BH/
β”‚   β”‚   β”‚   β”œβ”€β”€ reader.py          # BHFile (wraps sdtfile)
β”‚   β”‚   β”‚   └── writer.py          # .sdt writer, used by synth
β”‚   β”‚   β”œβ”€β”€ PS/
β”‚   β”‚   β”‚   └── reader.py          # PSFile (wraps photonsfile)
β”‚   β”‚   └── ISS/
β”‚   β”‚       β”œβ”€β”€ reader.py          # ISSFile - TD triplet (experimental)
β”‚   β”‚       β”œβ”€β”€ fdflim.py          # .ifli FD-FLIM phasor (experimental)
β”‚   β”‚       └── image.py           # .ifi intensity image (experimental)
β”‚   β”‚
β”‚   β”œβ”€β”€ FLIM/
β”‚   β”‚   β”œβ”€β”€ models.py              # Decay models + DE cost functions
β”‚   β”‚   β”œβ”€β”€ fitters.py             # fit_summed / fit_per_pixel (NNLS)
β”‚   β”‚   β”œβ”€β”€ fit_tools.py           # IRF alignment, bin utilities
β”‚   β”‚   β”œβ”€β”€ assemble.py            # Tile map assembly + global tau stats
β”‚   β”‚   └── irf_tools.py           # IRF estimation + machine IRF builder
β”‚   β”‚
β”‚   β”œβ”€β”€ phasor/
β”‚   β”‚   β”œβ”€β”€ signal.py              # Phasor computation & calibration
β”‚   β”‚   β”œβ”€β”€ interactive.py         # Interactive cursor tool
β”‚   β”‚   β”œβ”€β”€ peaks.py               # Automatic peak detection
β”‚   β”‚   └── filters.py             # Spatial phasor filtering (gaussian/median/wavelet)
β”‚   β”‚
β”‚   β”œβ”€β”€ image/
β”‚   β”‚   └── tools.py               # Intensity images, cell masking
β”‚   β”‚
β”‚   └── utils/
β”‚       β”œβ”€β”€ plotting.py            # Decay + pixel map plots
β”‚       β”œβ”€β”€ enhanced_outputs.py    # TIFF exports, summary text
β”‚       β”œβ”€β”€ lifetime_image.py      # Colourised lifetime images
β”‚       β”œβ”€β”€ xlsx_tools.py          # FLIM microscope software Excel parsing
β”‚       β”œβ”€β”€ xml_utils.py           # XLIF tile-position parsing
β”‚       β”œβ”€β”€ misc.py                # Logging helpers
β”‚       └── fancy.py               # Terminal banners
β”‚
└── flimkit_tests/
    β”œβ”€β”€ run_tests.py
    β”œβ”€β”€ mock_data.py
    β”œβ”€β”€ conftest.py
    β”œβ”€β”€ test_complete_pipeline.py
β”‚       β”œβ”€β”€ test_roi_decay_fit.py
        └── tests/
        β”œβ”€β”€ test_decode.py
        β”œβ”€β”€ test_integration.py
        └── test_xml_utils.py

Clone this wiki locally