microeye 2.3.13__tar.gz → 2.4.0__tar.gz

microeye-2.4.0/PKG-INFO

@@ -0,0 +1,592 @@
+Metadata-Version: 2.4
+Name: microeye
+Version: 2.4.0
+Summary: A python toolkit for fluorescence microscopy         that features hardware control, data analysis and vizualization         for super-resolution single-molecule localization microscopy and         single-partical tracking.
+Home-page: https://github.com/samhitech/microEye
+Author: Mohammad Nour Alsamsam
+Author-email: nour.alsamsam@gmail.com
+Project-URL: miEye Paper, https://doi.org/10.1016/j.ohx.2022.e00368
+Project-URL: miEye OSF, http://doi.org/10.17605/osf.io/j2fqy
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9.4, <3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: autopep8==2.3.2
+Requires-Dist: dask==2025.9.1
+Requires-Dist: h5py==3.15.0
+Requires-Dist: hidapi==0.14.0
+Requires-Dist: ids-peak==1.11.1.0.5
+Requires-Dist: matplotlib==3.10.7
+Requires-Dist: mmpycorex==0.3.16
+Requires-Dist: numba==0.62.1
+Requires-Dist: numpy==2.2.6
+Requires-Dist: ome_types==0.5.2
+Requires-Dist: opencv_python==4.12.0.88
+Requires-Dist: pandas==2.3.3
+Requires-Dist: pco==2.3.0
+Requires-Dist: pycromanager==1.0.2
+Requires-Dist: pyfiglet==1.0.4
+Requires-Dist: pyflakes==3.4.0
+Requires-Dist: pyjokes==0.8.3
+Requires-Dist: PyOpenGL==3.1.10
+Requires-Dist: pypylon==4.2.0
+Requires-Dist: pyqtdarktheme>=2.1.0
+Requires-Dist: pyqtgraph==0.13.7
+Requires-Dist: pyserial==3.5
+Requires-Dist: PySide6==6.7.2
+Requires-Dist: PySide6_Addons==6.7.2
+Requires-Dist: PySide6_Essentials==6.7.2
+Requires-Dist: pystackreg>=0.2.8
+Requires-Dist: pyueye==4.96.952
+Requires-Dist: QDarkStyle==3.2.3
+Requires-Dist: QScintilla==2.14.1
+Requires-Dist: scikit-image==0.25.2
+Requires-Dist: scikit_learn==1.7.2
+Requires-Dist: scipy>=1.16.2
+Requires-Dist: setuptools>=80.9.0
+Requires-Dist: tables==3.10.2
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: tqdm>=4.66.4
+Requires-Dist: tifffile==2025.10.4
+Requires-Dist: zarr>=3.1.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# The microEye
+
+![microEye](https://github.com/samhitech/microEye/assets/89871015/37ca0859-0b4b-402d-8652-9a01d0bf0f29)
+
+The **`microEye`** is a Python toolkit for fluorescence microscopy that supports super-resolution single-molecule localization microscopy and single-particle tracking. It features hardware control, data analysis, and visualization.
+
+This toolkit is compatible with the [hardware](#hardware) used in our microscope. For further details, refer to the [miEye microscope paper](https://doi.org/10.1016/j.ohx.2022.e00368) and [OSF project](http://doi.org/10.17605/osf.io/j2fqy).
+
+```bash
+   __  ____              ____                ___  ____  ___
+  /  |/  (_)__________  / __/_ _____   _  __|_  |/ / / / _ \
+ / /|_/ / / __/ __/ _ \/ _// // / -_) | |/ / __//_  _// // /
+/_/  /_/_/\__/_/  \___/___/\_, /\__/  |___/____(_)_/(_)___/
+                          /___/
+```
+
+<!-- ![Package Health](https://snyk.io/advisor/python/microEye/badge.svg) -->
+
+![Python Version](https://img.shields.io/badge/Python-3.11-blue)
+![Package Version](https://img.shields.io/pypi/v/microEye.svg)
+![Package Version](https://img.shields.io/badge/GUI_Platform-PySide6|PyQt6|PyQt5-navy)
+[![DOI](https://img.shields.io/badge/HardwareX-10.1016/j.ohx.2022.e00368-orange)](https://doi.org/10.1016/j.ohx.2022.e00368)
+![Package Version](https://img.shields.io/badge/Windows-Tested-cyan)
+![Package Version](https://img.shields.io/badge/MacOS-Errors-red)
+![Package Version](https://img.shields.io/badge/Linux-NotTested-lightgray)
+![Downloads](https://img.shields.io/pypi/dm/microEye.svg)
+
+<!-- ![Dependencies](https://img.shields.io/librariesio/release/pypi/microEye) -->
+
+![Contributors](https://img.shields.io/github/contributors/samhitech/microEye.svg)
+![GitHub Last Commit](https://img.shields.io/github/last-commit/samhitech/microEye.svg)
+![Maintenance](https://img.shields.io/maintenance/yes/2026.svg)
+
+![GitHub Issues](https://img.shields.io/github/issues/samhitech/microEye.svg)
+![GitHub Bugs](https://img.shields.io/github/issues/samhitech/microEye/bug.svg)
+![GitHub Feature Requests](https://img.shields.io/github/issues/samhitech/microEye/feature%20request.svg)
+![GitHub Pull Requests](https://img.shields.io/github/issues-pr/samhitech/microEye.svg)
+
+![GitHub Forks](https://img.shields.io/github/forks/samhitech/microEye.svg)
+![GitHub Stars](https://img.shields.io/github/stars/samhitech/microEye.svg)
+
+## What's New in microEye
+
+- **Stage Control Overhaul**
+
+  Stage management has been completely redesigned with a unified controller
+  that handles all stage types through a single, consistent interface. A new
+  Stage Manager lets you add, remove, and assign stages to axes on the fly.
+  Per-axis soft limits, configurable center positions, and a new Calibrate
+  action make setup safer and more repeatable. Dedicated **XY and Z Center
+  buttons** in the Controller dock move stages to their configured center
+  positions in one click.
+
+- **SmarAct MCS2 Support**
+
+  Full support for SmarAct MCS2 multi-channel controllers, including guided
+  setup, calibration, homing, and soft-limit configuration for reliable
+  multi-axis motion.
+
+- **Slides Widget**
+
+  A new Slides dock lets you visualize and navigate multi-channel slide
+  layouts (Sticky-Slide VI, µ-Slide VI, 8/18 Well, and more). Click any
+  channel to move the stage to its center, with live position and delta
+  readouts, position overlays, and context menu options for axis orientation
+  and inversion. Layout settings persist across sessions.
+
+- **Focus Stabilization Improvements**
+
+  The focus stabilizer has been thoroughly refactored. Each axis now has
+  independent PID gains and calibration. New stabilization methods are
+  supported — including Reflection peak fitting, Fiducial/Fourier, and a
+  Hybrid XYZ mode. Frame statistics (count, mean, median) are now tracked
+  and the stabilizer waits for a sufficient number of frames before locking,
+  reducing false engagements. Plots dynamically show only the data relevant
+  to the active method, and all settings persist across sessions.
+
+- **New Analysis & Calibration Tools**
+
+  Three new calibration workflows are available from the Multi-Viewer Tools
+  menu:
+  - **Dark Calibration** — directory-based mean/variance analysis with
+    results cache, import/export, and dataset comparison.
+  - **Photon Transfer Curve (PTC)** — dataset import, run/cache workflows,
+    cache comparison, and Dark-Cal JSON export.
+  - **Sphere Power Calibration** — calibration utilities integrated into
+    the PTC workflow.
+
+  A new **Image Registration** tool for aligning and merging multi-channel
+  stacks (with transformation export/import) is also available in the
+  Multi-Viewer Tools menu.
+
+- **Expanded Camera Support**
+
+  Cameras from Basler, Allied Vision (Vimba X SDK), IDS Peak, Thorlabs,
+  PCO, and PycroManager now share unified ROI, exposure, and framerate
+  handling. Notable additions:
+  - **IDS Peak** is newly supported with binning, flash, and full ROI and
+    acquisition flow.
+  - **Basler** is newly supported.
+  - **Vimba X** gains black level, gain, correction, and binning controls,
+    plus CTI auto-discovery via `VIMBA_X_HOME` / `VIMBA_X_CTI`.
+  - All camera configurations are **automatically saved and restored** on
+    next launch when detected.
+
+- **Laser & Device Controls**
+
+  The Controller dock now shows color-coded, wavelength-aware indicators
+  for each laser and relay. Clicking an indicator toggles the laser state
+  directly from the main UI. Relay mode labels (ON/F1/F2) are shown
+  alongside each laser.
+
+- **Experiment Protocol Designer**
+
+  The protocol action list gains a new **ListLoop** action type for
+  repeating sequences of steps. The parameter adjustment UI now sorts
+  target objects, shows readable labels, and correctly handles integer and
+  float editors.
+
+- **Program-Wide Logging**
+
+  Structured logging replaces scattered print statements across the entire
+  codebase. Log level, file output, and console output are configurable via
+  the launcher UI or CLI flags (`--log-level`, `--no-log-file`,
+  `--no-log-console`). Logs are written per session under `./logs` for
+  easier troubleshooting.
+
+- **Image I/O & Data Handling**
+
+  Image handling has been refactored into a dedicated `microEye.images`
+  package. Zarr V3 is now fully supported for streaming and saving
+  acquisition data, with both zipped and directory store support.
+
+- **Multi-Viewer Improvements**
+
+  The Multi-Viewer gains an **"Opened Files" dock** for quick switching
+  between open datasets, a **Registration Tool** for stack alignment, and
+  new menu entries for the Dark Calibration and PTC tools — all accessible
+  as MDI subwindows.
+
+- **Display & Performance**
+
+  Focus widget plots have been rewritten to eliminate GUI freezes at high
+  framerates (tested at ~165 Hz). A new optional **crosshair overlay** can
+  be enabled on any camera display. OpenGL rendering is now used for image
+  display. Application startup is faster thanks to deferred initialization
+  of heavy components.
+
+- **Stability & Compatibility**
+  - GPU imports are safely guarded on CPU-only systems.
+  - Qt binding selection is configurable at launch via CLI or environment
+    variable.
+  - Spatial filters (DoG, PointGaussFilter, Fourier) are faster via FFT
+    convolution and Numba acceleration.
+  - Qt6 compatibility fixes for mouse event handling.
+  - `PiezoConcept FOC` stage adapter fixes a float/int mismatch that caused
+    random Z jumps.
+
+---
+
+> ⚠️ **Breaking Change:** Zarr V3 support requires **Python 3.11 or
+> newer**. Python 3.9 and 3.10 are no longer supported.
+
+## Table of Contents
+
+- [The microEye](#the-microeye)
+  - [What's New in microEye](#whats-new-in-microeye)
+  - [Table of Contents](#table-of-contents)
+  - [How to Install microEye](#how-to-install-microeye)
+    - [Troubleshooting Installation](#troubleshooting-installation)
+  - [microEye Launcher](#microeye-launcher)
+    - [Usage](#usage)
+  - [Modules](#modules)
+    - [The miEye Module](#the-mieye-module)
+      - [Experiment Designer (Beta)](#experiment-designer-beta)
+    - [The Multi Viewer Module](#the-multi-viewer-module)
+  - [Uses Packages](#uses-packages)
+  - [Microscope Scheme](#microscope-scheme)
+  - [Hardware](#hardware)
+    - [Supported Cameras](#supported-cameras)
+    - [Additional Hardware](#additional-hardware)
+  - [Pycro-Manager Integration](#pycro-manager-integration)
+    - [Features](#features)
+    - [Integrated Hardware](#integrated-hardware)
+    - [How to Use](#how-to-use)
+    - [Step-by-step Instructions](#step-by-step-instructions)
+  - [Authors](#authors)
+  - [People Involved](#people-involved)
+  - [Acknowledgement](#acknowledgement)
+  - [Citation](#citation)
+
+## How to Install [microEye](https://pypi.org/project/microEye/)
+
+1. **Install Python:**
+
+   Download and install the latest [`Python`](https://www.python.org/downloads/) stable release (version ≥3.11.9).
+
+2. **Install microEye package:**
+
+   Open a terminal and execute the following command to install microEye using pip:
+
+   ```powershell
+   pip install microEye --upgrade
+   ```
+
+   Or for a specific version:
+
+   ```powershell
+   pip install microEye==version
+   ```
+
+3. **Install specific hardware drivers: (Optional)**
+   - Allied Vision CMOS cameras:
+
+     Install the [`Vimba X SDK`](https://www.alliedvision.com/en/products/software/vimba-x-sdk/) (_avoid installing it inside the Program Files directory_). After installation, navigate to the `Python API` directory (e.g., `C:\Allied Vision\Vimba X\api\python`) where the `vmbpy` wheel file (`.whl`) is located, and install it using:
+
+     ```powershell
+     python -m pip install vmbpy-1.1.1-py3-none-win_amd64.whl
+     ```
+
+     **Important note**
+
+     It has been observed that `vmbpy` can hang when initializing `GenICAM` transport layers (TLs) if the `GENICAM_GENTL64_PATH` environment variable contains `.cti` folders from other providers (e.g., `IDS Peak` or `pylon`). To avoid this, restrict `Vimba X` to load only its own TLs by explicitly specifying the `Vimba X` `.cti` directory in `VmbC.xml`.
+
+     **Steps**
+     1. **Auto (recommended)**
+
+        Set the `VIMBA_X_HOME` environment variable to your `Vimba X` installation directory. `microEye` will read `VIMBA_X_HOME` at startup and use it to point the Vimba X transport-layer (`.cti`) configuration (e.g., `VIMBA_X_HOME/cti`).
+
+        > Note: On Windows the `Vimba X installer` typically creates this variable automatically — verify it before manually setting it.
+
+     2. **Manual**
+
+        If the automatic method is not prefered, create the environment variable `VIMBA_X_CTI` and point it to the directory (or directories) that contain the `Vimba X` `.cti` transport-layer files. Use directory paths (not individual `.cti` files). Multiple directories are allowed — separate them with the platform-specific path separator.
+
+   - Basler CMOS cameras: Install [`pylon`](https://www.baslerweb.com/en/downloads/software/?srsltid=AfmBOoqsMrbQT24hcWiCw-0ptD9PR7nCrPMBZSzi0YlI1CVItNQikMKW&downloadCategory.values.label.data=pylon) (_avoid installing it inside the Program Files directory_).
+   - IDS CMOS cameras:
+     - Install [`IDS Software Suite 4.96.1`](https://en.ids-imaging.com/download-details/AB00604.html?os=windows&version=win10&bus=64&floatcalc=) for Windows 32/64-bit.
+     - Alternatively, [`IDS Peak Extended Setup`](https://en.ids-imaging.com/download-peak.html) is prefered as it support old uEye models and the new uEye+ ones.
+
+       > - The installation package also includes the uEye camera drivers for UI models in addition to the standard setup. Therefore, no installation of the IDS Software Suite is required for the operation of UI models.
+       > - If the process cannot read the system-wide `GENICAM_GENTL_PATH`/`GENICAM_GENTL64_PATH`, add the same variable to your User environment variables (not just System) and restart any open terminals or applications for the change to take effect.
+
+   - Integrated Optics Lasers: Install [`Laser control software`](https://integratedoptics.com/downloads).
+
+   - PCO cameras: Install [`pco.sdk`, `pco.runtime`](https://www.excelitas.com/product/pco-software-development-kits).
+
+     > **Note:** Support is under development.
+
+   - Thorlabs CMOS cameras: Install [`Thorcam`](https://www.thorlabs.com/software_pages/ViewSoftwarePage.cfm?Code=ThorCam) in its default directory. Note: Some Thorlabs cameras may be identified as IDS uEye cameras by Windows and may run without Thorcam.
+
+   - Thorlabs hardware, install [`Kinesis® Software`](https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=10285) and [`Elliptec™ Software`](https://www.thorlabs.com/software_pages/ViewSoftwarePage.cfm?Code=ELL).
+
+4. **Open a terminal and execute microEye:** :partying_face:
+
+   ```powershell
+   usage: microEye.exe [-h] [--module {mieye,viewer}] [--QT_API {PySide6,PyQt6,PyQt5}] [--theme {None,qdarktheme,qdarkstyle,...}]
+                    [--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [--no-log-file] [--no-log-console]
+
+   options:
+     -h, --help            show this help message and exit
+     --module {mieye,viewer}
+                           The module to launch [mieye|viewer], If not specified, launcher is executed.
+     --QT_API {PySide6,PyQt6,PyQt5}
+                           Select QT API [PySide6|PyQT6|PyQt5], If not specified, the environment variable QT_API is used.
+     --theme {None,qdarktheme,qdarkstyle,...}
+                           The theme of the app, if not specified, the environment variable MITHEME is used.
+     --log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}
+                           Root logging level (default WARNING).
+     --no-log-file         Disable logging to file.
+     --no-log-console      Disable logging to console.
+   ```
+
+> **Note:** Ensure all necessary drivers are installed for microEye to function properly.
+
+### Troubleshooting Installation
+
+If you encounter any issues during the installation process, please check the following:
+
+- Ensure that you have the latest version of Python installed (`3.9 ≤ version ≤3.11`).
+- Try installing the required packages repeating step (2) or individually using `pip install <package_name>`.
+- Check the system requirements for specific hardware drivers and follow the installation instructions provided by the manufacturers.
+- Refer to the project's issue tracker on GitHub for any known installation issues and solutions.
+
+> If the issue persists, feel free to open a new issue on the project's GitHub repository, providing detailed information about the problem and any error messages you encountered.
+
+## microEye Launcher
+
+The microEye Launcher allows you to launch either the `miEye Module` or the `Viewer Module`, and provides options to select the Qt API and theme for the application.
+
+![Launcher Screenshot](https://github.com/samhitech/microEye/assets/89871015/385cc3d6-e3b8-44a4-a288-2471b6b34f7f)
+
+### Usage
+
+Upon running the launcher, you will be presented with the following interface:
+
+- **miEye Module**: Launches the miEye module for microscope control and acquisition.
+- **Viewer Module**: Launches the viewer module for image/data anlysis and visualization.
+- **QT API (dropdown)**: Select the `Qt API` to use. Options are `PySide6`, `PyQt6`, or `PyQt5`.
+- **Theme (dropdown)**: Select the `theme` for the application. Options are `None` (default), `qdarktheme`, or `qdarkstyle`.
+
+To launch a module, simply click on the respective button (`miEye Module` or `Viewer Module`). If you wish to change the `Qt API` or `theme`, select the desired option from the dropdown menus before launching.
+
+## Modules
+
+### The miEye Module
+
+The `miEye_module` provides the primary graphical user interface (GUI) for microscope control and data acquisition, combining the functionalities of the deprecated _Acquisition_ and _Control_ modules.
+
+| miEye module (NOT UP TO DATE)                                                                        | Acquisition Camera                                                                                      |
+| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| ![miEye](https://github.com/samhitech/microEye/assets/89871015/20c5573a-e489-478e-adfc-29410bc6d4c2) | ![CamStack](https://github.com/samhitech/microEye/assets/89871015/ead95989-54ce-4643-b5a3-4461c36f6b14) |
+
+**How to use:**
+
+To launch the miEye module, run the following command:
+
+```powershell
+microEye --module mieye
+```
+
+#### Experiment Designer (Beta)
+
+![Experiment Designer (Beta)](https://github.com/samhitech/microEye/assets/89871015/0693a620-6aed-4bf4-a723-7b0c7b143d1f)
+
+The Experiment Designer is a new feature within the `miEye Module` that allows users to create and manage complex acquisition protocols through a graphical interface.
+
+Key features include:
+
+- GUI-based design of acquisition protocols;
+- Support for loops and device parameter adjustments/actions;
+- Export and import capabilities for protocols;
+- Threaded execution with pause functionality;
+- Configurable delays between protocol steps
+- Context menu for easy adjustments
+- Nested protocol structure
+- Acquisition action wait option
+- Cell reordering and deletion via keyboard shortcuts
+- Real-time execution progress view
+
+To access the Experiment Designer:
+
+1. Launch the `miEye module`.
+2. Look for the `Protocols` view in the interface.
+
+Note: This feature is currently in beta. We value your feedback to enhance its functionality and improve the user experience.
+
+### The Multi Viewer Module
+
+The `multi_viewer` Module is an improved GUI that replaces the deprecated `tiff_viewer` module. It allows users to process multiple files and provides data analysis and visualization tools for super-resolution single-molecule localization microscopy and single-particle tracking.
+
+| Raw Data                                                                                                   | Localizations                                                                                           |
+| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| ![imagesStack](https://github.com/samhitech/microEye/assets/89871015/17421117-a633-4a20-ba38-e7adffcd7332) | ![locStack](https://github.com/samhitech/microEye/assets/89871015/713d9fc7-7f92-4341-adb2-17b83ac8fc34) |
+
+**How to use:**
+
+To launch the Multi Viewer module, run the following command:
+
+```powershell
+microEye --module viewer
+```
+
+## Uses Packages
+
+The `microEye` uses the following Python packages:
+
+| Code Quality and Formatting | Data Analysis and Visualization | File and Data Storage |   GUI and UI Development    | Image and Video Processing |  Microscopy  | Other Utilities |
+| :-------------------------: | :-----------------------------: | :-------------------: | :-------------------------: | :------------------------: | :----------: | :-------------: |
+|          autopep8           |              dask               |         h5py          |      PyQt5 (optional)       |       opencv_python        |     pco      |     hidapi      |
+|          pyflakes           |           matplotlib            |       ome_types       |      PyQt6 (optional)       |          PyOpenGL          | pycromanager |    mmpycorex    |
+|                             |              numba              |        tables         | PyQt6-QScintilla (optional) |                            |    pyueye    |    pyfiglet     |
+|                             |              numpy              |       tifffile        |           PySide6           |                            |   pypylon    |     pyjokes     |
+|                             |             pandas              |         zarr          |          pyqtgraph          |                            |              |    pyserial     |
+|                             |           pystackreg            |                       |        pyqtdarktheme        |                            |              |   setuptools    |
+|                             |          scikit-image           |                       |         QDarkStyle          |                            |              |    tabulate     |
+|                             |          scikit_learn           |                       |         QScintilla          |                            |              |      tqdm       |
+|                             |              scipy              |                       |                             |                            |              |                 |
+
+> **Note:** The VimbaPython package is bundled with the Vimba SDK and must be installed manually.
+>
+> **IMPORTANT:** Starting from microEye v2.4.0, the legacy Vimba SDK is no longer supported. Please use the Vimba X SDK and its accompanying _vmbpy_ Python package instead.
+
+## Microscope Scheme
+
+Schematic overview of the miEye instrument:
+
+- **A) Single-Mode Fiber (SMF):** Excitation path for TIRF-, HILO-, and Epi-mode.
+- **B) Multi-Mode Fiber (MMF):** Excitation path for Epi-mode when imaging MMF output on the sample plane.
+- **C) Fluorescence Emission:** Path for fluorescence emission.
+- **D) Automatic Focus Stabilization:** the automatic focus stabilization path using an IR laser in TIRF setting.
+
+| Scheme 1                                                                                                              | Scheme 2                                                                                                             |
+| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| ![Quad Scheme](https://user-images.githubusercontent.com/89871015/182302644-9fdf8615-75c3-4702-9913-d1a535f60e22.png) | ![Scheme GIT](https://user-images.githubusercontent.com/89871015/182302694-3f70d058-b1b6-4ef5-9cc2-aec9b58a05f0.png) |
+
+**Key Components:** _AC:_ Achromat lens, _AS:_ Aspheric lens, _BFP:_ Back-focal plane, _TL:_ Tube lens, _B:_ B-coated N-BK7 optics, _BS:_ Beamsplitter.
+
+## Hardware
+
+### Supported Cameras
+
+|          Camera           | Description                                                              |             Driver             |                                                     Link                                                      |
+| :-----------------------: | ------------------------------------------------------------------------ | :----------------------------: | :-----------------------------------------------------------------------------------------------------------: |
+| IDS uEye UI-3060CP Rev. 2 | IDS industrial-grade CMOS cameras                                        | `IDS uEye SDK 4.96.1` `pyueye` |            [Product Link](https://en.ids-imaging.com/store/products/cameras/ui-3060cp-rev-2.html)             |
+|     Thorlabs DCC1545M     | DCx camera using UC480 driver                                            |        `ThorCam 3.7.0`         |                 [Product Link](https://www.thorlabs.com/thorProduct.cfm?partNumber=DCC1545M)                  |
+| Allied Vision Alvium 1800 | Allied Vision industrial-grade CMOS cameras (U-158m, U-511m)             |     `Vimba X SDK` `vmbpy`      | [Product Link](https://www.alliedvision.com/en/products/alvium-configurator/alvium-1800-u/158/#_configurator) |
+|    Excelitas PCO sCMOS    | Excelitas pco.edge 4.2 LT USB sCMOS Camera                               |     `pco.sdk` `pco.python`     |               [Product Link](https://www.excelitas.com/product/pcoedge-42-lt-usb-scmos-camera)                |
+|       Pycro-camera        | Access to cameras via Micro-Manager drivers/adapters using Pycro-Manager |   `uManager` `Pycro-Manager`   |                                                       -                                                       |
+
+### Additional Hardware
+
+| Hardware                          | Description                                                                                                                                                           |  Driver  |                                                                                                  Link                                                                                                  |
+| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| Integrated Optics MatchBox        | Multi-wavelength Laser Combiner, Single Laser MatchBox                                                                                                                | `Native` |                                                              [Products Link](https://integratedoptics.com/products/wavelength-combiners)                                                               |
+| Piezo Concept FOC                 | Nanopositioner for microscope objectives                                                                                                                              | `Native` |                                                              [Piezo Concept FOC](https://piezoconcept-store.squarespace.com/1-axis/p/foc)                                                              |
+| Thorlabs Elliptec ELL6/ELL9/ELL12 | Dual/Four/Six-Position Slider                                                                                                                                         | `Native` | [ELL6](https://www.thorlabs.com/thorproduct.cfm?partnumber=ELL6), [ELL9](https://www.thorlabs.com/thorproduct.cfm?partnumber=ELL9), [ELL12](https://www.thorlabs.com/thorproduct.cfm?partnumber=ELL12) |
+| Thorlabs Elliptec ELL14           | Rotation Mount: SM1 Threaded                                                                                                                                          | `Native` |                                                                   [ELL14](https://www.thorlabs.com/thorproduct.cfm?partnumber=ELL14)                                                                   |
+| Thorlabs Elliptec ELL20           | Linear Stage: 60 mm Travel                                                                                                                                            | `Native` |                                                                   [ELL20](https://www.thorlabs.com/thorproduct.cfm?partnumber=ELL20)                                                                   |
+| Thorlabs KDC101                   | Kinesis Controller for Z825B/[Z925B](https://www.thorlabs.com/thorproduct.cfm?partnumber=Z925B) actuators (Activate USB VCP to access the COM port in device manager) | `Native` |                                                                  [KDC101](https://www.thorlabs.com/thorproduct.cfm?partnumber=KDC101)                                                                  |
+| Parallax TSL1401-DB (#28317)      | Linescan Camera Module                                                                                                                                                | `Native` |                                   [Parallax TSL1401-DB](https://eu.mouser.com/ProductDetail/Parallax/28317?qs=%2Fha2pyFaduiCRhuOAXMuCmQIeG1Q3R01m6Y1EH%252BmN80%3D)                                    |
+| RelayBox Arduino                  | For laser control using camera GPIO signals                                                                                                                           | `Native` |                                                                           [RelayBox](https://github.com/samhitech/RelayBox)                                                                            |
+| miEye OSF Project Parts List      | Parts list of miEye OSF Project                                                                                                                                       |    -     |                                                                                   [Repo Link](https://osf.io/j2fqy/)                                                                                   |
+
+## Pycro-Manager Integration
+
+Integration with Pycro-Manager is now implemented, providing support for managing headless instances and `Core` instances. This allows for seamless control and configuration of hardware devices through the Pycro-Manager framework.
+
+![pycromanager integration](https://github.com/user-attachments/assets/73893f9f-c1ef-438f-a884-ec3f60f00118)
+
+### Features
+
+- **Headless Manager**: Manage multiple headless Micro-Manager instances (JavaBackend), including starting, stopping, and saving configurations.
+- **Core Instances Manager**: Handle multiple `PycroCore` instances for device communication and control.
+
+### Integrated Hardware
+
+The following table lists the hardware devices that are integrated and supported by the `miEye module`:
+
+|  Device  | Description                                                                                 |
+| :------: | ------------------------------------------------------------------------------------------- |
+| `Camera` | Access Micro-Manager cameras (mainly done for focus stabilization).                         |
+| `ZStage` | Access Micro-Manager Z-stage devices for focus stabilization and axial positioning control. |
+
+### How to Use
+
+1. **Headless Manager**:
+   - Open the `miEye_module` and navigate to `Tools -> Micro-Manager Headless Manager` in the main menu.
+   - Start a new headless instance using a specific configuration file.
+   - Stop individual running instances or terminate all instances simultaneously.
+   - Save configurations for future use or load previously saved configurations for headless instances.
+
+2. **Core Instances**:
+   - Open the `miEye_module` and navigate to `Tools -> Micro-Manager Core Bridges` in the main menu.
+   - Click on `Add Core Bridge` and provide the port address in the dialog box.
+   - A list of connected devices will be displayed, allowing you to view each device's properties.
+   - Close the window and refresh the camera list to access Pycro-Manager cameras.
+
+     _Accessing other types of devices is under development!_
+
+     > **Note:** Currently, only acquisition and focus stabilization features are implemented. Support for additional hardware and stage-related controls is under active development.
+
+### Step-by-step Instructions
+
+For comprehensive step-by-step instructions, please refer to the [Pycro-Manager Integration Guide](https://github.com/samhitech/microEye/tree/main/guide/pycromanager).
+
+## Authors
+
+[`Mohammad Nour Alsamsam`](https://tutkuslab.github.io/team/MNA/)
+
+[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/samhightech.svg?style=social&label=Follow%20%40samhightech)](https://twitter.com/samhightech)
+
+## People Involved
+
+**PhD supervision:**
+
+[`Dr. Marijonas Tutkus`](https://tutkuslab.github.io/team/MT/)
+
+[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/MTutkus.svg?style=social&label=Follow%20%40MTutkus)](https://twitter.com/MTutkus)
+
+**Sample preparation, experiments and testing:**
+
+[`Aurimas Kopūstas`](https://tutkuslab.github.io/team/AK/)
+[`Tutkus Lab Team`](https://tutkuslab.github.io/team/)
+
+## Acknowledgement
+
+Research and access to intruments and samples is credited to:
+
+- Vilnius University, Lithuania.
+- Center For Physical Sciences and Technology, Vilnius, Lithuania.
+- Research Council of Lithuania.
+
+Special thanks to the following projects and libraries that make this work possible:
+
+- **SMAP/fit3Dcspline**: The original code, provided as a part of the Ries group [`SMAP software`](https://github.com/jries/SMAP/tree/master/fit3Dcspline). The `pyfit3Dcspline` module in our project is a Python adaptation of this functionality, offering both CPU and GPU accelerated fitting of Single-Molecule Localization Microscopy (SMLM) data. For more details, refer to the pyfit3Dcspline [`README`](https://github.com/samhitech/microEye/tree/main/src/microEye/analysis/fitting/pyfit3Dcspline/README.md).
+
+- **ACCéNT**: a partial implementation of the photon free calibration within the acquisition pipeline which generates pixel-wise mean and variance images.
+
+  > Robin Diekmann, Joran Deschamps, Yiming Li, Aline Tschanz, Maurice Kahnwald, Ulf Matti, Jonas Ries, "Photon-free (s)CMOS camera characterization for artifact reduction in high- and super-resolution microscopy", bioRxiv 2021.04.16.440125. [doi: 2021.04.16.440125](https://doi.org/10.1101/2021.04.16.440125)
+
+- **Phasor Fit**: We have implemented the 2D phasor fitting algorithm in Python for fast pre-fitting visualization of localizations.
+
+  > K.J.A. Martens, A.N. Bader, S. Baas, B. Rieger, J. Hohlbein. "Phasor based single-molecule localization microscopy in 3D (pSMLM-3D): an algorithm for MHz localization rates using standard CPUs," bioRxiv, 2017. [DOI: 10.1101/191957](https://doi.org/10.1101/191957).
+
+- **Endesfelder Lab/SMLMComputational**: A numba accelerated adaptation of Drift Correction, Fourier Ring Correlation (FRC) structural resolution and Nearest Neighbour Analysis (NeNA) for localization precision from [Endesfelder Lab](https://github.com/Endesfelder-Lab/SMLMComputational).
+
+  > Raw data to results: a hands-on introduction and overview of computational analysis for single-molecule localization microscopy", Martens et al., (2022), Frontiers in Bioinformatics. [Paper](https://www.frontiersin.org/articles/10.3389/fbinf.2021.817254)
+
+- **TARDIS (Temporal Analysis of Relative Distances)**: We have developed a partial Python implementation of TARDIS without fitting for now. For more information, refer to the [`TARDIS` software releases](https://github.com/kjamartens/TARDIS-public). The underlying algorithms and scientific details of TARDIS are detailed in the manuscript:
+  > Martens et al., “Temporal analysis of relative distances (TARDIS) is a robust, parameter-free alternative to single-particle tracking”, Nature Methods (2024). [Article](https://rdcu.be/dv1sr)
+
+**Note**: I'm committed to maintaining an accurate acknowledgment list for our project. However, if I inadvertently miss acknowledging your work, please don't hesitate to reach out to us. I appreciate your understanding, and I'm doing my best to manage all acknowledgments amidst my other responsibilities.
+
+> I make it a standard practice to cite and provide credit within a function's docstring whenever I draw inspiration from any external reference.
+
+## Citation
+
+If you find our work or software helpful in your research or project, we kindly request that you cite it appropriately. Here is the suggested citation format:
+
+> M.N. Alsamsam, A. Kopūstas, M. Jurevičiūtė, and M. Tutkus, “The miEye: Bench-top super-resolution microscope with cost-effective equipment,” HardwareX 12, e00368 (2022). [Paper](https://doi.org/10.1016/j.ohx.2022.e00368)
+
+Additionally, we would appreciate it if you could provide a link to our GitHub repository or any relevant publication associated with the software.
+
+> Alsamsam, M. N. microEye, <https://github.com/samhitech/microEye> [Computer software]
+
+Thank you for your support!