Skip to content

Commit 496cf81

Browse files
committed
Add comprehensive AI methods documentation
Create VisCy-style documentation for CAREamics and Spotiflow, and reorganize README with prominent AI methods section. New Documentation: - docs/careamics_denoising.md: Complete guide to CAREamics denoising * Noise2Void, CARE, N2V2, Struct N2V overview * Training and usage instructions * Parameter explanations and tuning guidelines * Hardware requirements and performance tips * Troubleshooting section * Example workflows and pipelines - docs/spotiflow_detection.md: Complete guide to Spotiflow spot detection * Pretrained models overview (general, hybiss, synth_3d, etc.) * 2D and 3D spot detection * Parameter tuning for different scenarios * smFISH analysis examples * Performance optimization * Custom model training guidance README Updates: - Add prominent '🤖 AI-Powered Processing Functions' section - Reorganize documentation links by category - Highlight key capabilities of each AI method - Better visual structure with emojis and clear grouping - Link all 5 AI methods (VisCy, CAREamics, Spotiflow, Cellpose, Trackastra) Documentation follows VisCy template: ✓ Overview and requirements ✓ Model information and references ✓ Installation and setup ✓ Basic and advanced usage examples ✓ Complete parameter documentation ✓ Typical workflows ✓ Hardware recommendations ✓ Comprehensive troubleshooting ✓ Tips and best practices ✓ Citations and resources
1 parent 4bec152 commit 496cf81

3 files changed

Lines changed: 874 additions & 20 deletions

File tree

README.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -94,32 +94,50 @@ Converts `.lif, .nd2, .czi, .ndpi` and Acquifer data to TIF or OME-Zarr formats.
9494
Note that whenever you click on an `Original File` or `Processed File` in the table, it will replace the one that is currently shown in the viewer. So naturally, you'd first select the original image, and then the processed image to correctly see the image pair that you want to inspect.
9595

9696

97-
#### Processing Function Credits
98-
99-
The image processing capabilities are powered by several excellent open-source tools:
100-
- [Cellpose 4](https://github.com/MouseLand/cellpose): Advanced cell segmentation
101-
- [Trackastra](https://github.com/weigertlab/trackastra): Cell tracking and analysis
102-
- [VisCy](https://github.com/mehta-lab/VisCy): Virtual staining using deep learning
103-
- [CAREamics](https://github.com/CAREamics/careamics): Content-aware image restoration and enhancement
104-
- [Spotiflow](https://github.com/weigertlab/spotiflow): Accurate and efficient spot detection for fluorescence microscopy
105-
106-
#### Processing Function Documentation
107-
108-
Detailed documentation for specific processing functions:
109-
110-
**Core Processing**
97+
#### AI-Powered Processing Functions 🤖
98+
99+
napari-tmidas integrates state-of-the-art deep learning methods for microscopy image analysis. Each method runs in a dedicated environment to prevent conflicts and is automatically installed on first use.
100+
101+
**🔬 Image Enhancement & Restoration**
102+
- **[VisCy Virtual Staining](docs/viscy_virtual_staining.md)** - Transform phase/DIC microscopy into virtual fluorescence (nuclei + membrane channels)
103+
- Powered by [VisCy](https://github.com/mehta-lab/VisCy)
104+
- VSCyto3D model for 3D/4D data
105+
- No labels needed - learn from transmitted light alone
106+
107+
- **[CAREamics Denoising](docs/careamics_denoising.md)** - Content-aware image restoration using Noise2Void/CARE
108+
- Powered by [CAREamics](https://github.com/CAREamics/careamics)
109+
- Train on noisy images (no ground truth needed)
110+
- Preserves fine structures while removing noise
111+
112+
**🎯 Detection & Segmentation**
113+
- **[Spotiflow Spot Detection](docs/spotiflow_detection.md)** - Accurate detection of spots/puncta in fluorescence images
114+
- Powered by [Spotiflow](https://github.com/weigertlab/spotiflow)
115+
- Multiple pretrained models (2D/3D)
116+
- Subpixel localization for precise coordinates
117+
118+
- **[Cellpose Segmentation](docs/cellpose_segmentation.md)** - Universal cell/nucleus segmentation
119+
- Powered by [Cellpose 4](https://github.com/MouseLand/cellpose)
120+
- Cellpose-SAM for improved generalization
121+
- Works on 2D, 3D, and time-lapse data
122+
123+
**🔍 Tracking & Analysis**
124+
- **[Trackastra Tracking](docs/trackastra_tracking.md)** - Cell tracking across time-lapse data
125+
- Powered by [Trackastra](https://github.com/weigertlab/trackastra)
126+
- Graph-based tracking with deep learning
127+
- Handles divisions and complex cell behavior
128+
129+
#### Additional Processing Functions
130+
131+
**Core Operations**
111132
- [Basic Processing Functions](docs/basic_processing.md) - Label and intensity operations, channel splitting/merging, time series
112-
- [Cellpose Segmentation](docs/cellpose_segmentation.md) - Deep learning cell/nucleus segmentation
113-
- [TrackAstra Tracking](docs/trackastra_tracking.md) - Cell tracking across time-lapse data
114-
- [VisCy Virtual Staining](docs/viscy_virtual_staining.md) - Virtual staining of phase/DIC images using deep learning
115133

116-
**Analysis and Quality Control**
134+
**Analysis & Quality Control**
117135
- [Grid View: Intensity + Labels Overlay](docs/grid_view_overlay.md) - Visual QC for segmentation results
118136
- [Intensity-Based Label Filtering](docs/intensity_label_filter.md) - Filter labels by signal intensity
119137
- [Regionprops Analysis](docs/regionprops_analysis.md) - Extract quantitative properties from labels
120138

121-
**Advanced Processing**
122-
- [Advanced Processing Functions](docs/advanced_processing.md) - Denoising (CAREamics), spot detection (Spotiflow), SciPy/scikit-image filters, compression, colocalization
139+
**Advanced Methods**
140+
- [Advanced Processing Functions](docs/advanced_processing.md) - SciPy/scikit-image filters, compression, colocalization
123141

124142
### Batch Label Inspection
125143
If you have already segmented a folder full of images and now you want to maybe inspect and edit each label image, you can use the `Plugins > T-MIDAS > Batch Label Inspection`, which automatically saves your changes to the existing label image once you click the `Save Changes and Continue` button (bottom right).

0 commit comments

Comments
 (0)