This repository contains the beta version of AlveolEye, which is created by the Sucre lab.
This code is authored by Joseph Hirsh, Samuel Hirsh, Nick Negretti, and Shawyon Shirazi.
This project is a Napari plugin that uses computer vision tools and classical image processing
to calculate mean linear intercept (MLI) and airspace volume density (ASVD) from histological images.
A primary goal of this tool is to be an aid to the researcher, and not be a complete automated annotation solution.
Installation
The target of this process is to create a conda environment that has both napari, and all of the AlveolEye requirements.
If you already have conda setup, you can skip step 1
Install miniconda by downlading the appropriate version from here
a. Choose the version that matches your processor
b. Download the "pkg" version for easy install
Open a terminal, or miniconda prompt, and clone this git repository by running:
git clone https://github.com/SucreLab/AlveolEye
Go to the AlveolEye directory
cd AlveolEye
Create the conda environment
conda env create -f ./environment.yml
Activate the new environment
conda activate AlveolEye
Install the plugin
pip install .
Launch napari, followed by locating the plugin in the plugin menu
napari
Running post-installation
Open a terminal, or miniconda prompt, activate the environment and run napari
conda activate AlveolEye
napari
AlveolEye Usage Tutorial
Annotated Diagram
Processing: Identify and segment vessel and airway epithelium with an AI computer vision model.
Select an image: The remaining steps will concern this image.
a. Click the “Import Image” button.
b. Use operating system default file dialogue to select an image (*.jpg, *.png, or *.tiff).
c. Check the image in the “Image” layer (of the Napari Viewer) and the file name (displayed to the right of the “Import Image” button) to confirm that the image loaded correctly.
Select a model: The selected model will run on the image and predict (segment) vessel and airway epithelium.
a. To use the default model, skip to step 3; otherwise, proceed to step 2b. Use the provided default model unless you have a specific reason not to.
b. Click the “Import Weights” button.
c. Use operating system file dialogue to select a model (*.pth).
d. Check the file name (displayed to the right of the “Import Weights” button) to confirm that the model loaded correctly.
Select a confidence level: Type a percentage and/or click the “-” and “+” buttons in the “Minimum confidence” input box to set the confidence level. Predictions with lower confidence then the set confidence level will not appear.
Run processing: Click the “Run Processing” button to run the model and segment vessel and airway epithelium filtered by confidence level. Once completed, manually edit the prediction as necessary with the built-in napari tools to the left of the displayed image layer. See Napari documentation for more information about how to use these tools.
Postprocessing: Identify alveolar tissue, and airwary and vessel lumens with “classical” (non-AI) methods; remove small particles and holes to prepare for assessments.
Toggle manual thresholding: To manually set a threshold value, toggle manual threshold; otherwise, a threshold value will be determined with Otsu's method.
a. To use manual thresholding, check the “Manual thresholding” box and proceed; to use automatic thresholding, leave the box unchecked and skip to step 2.
b. Type a percentage and/or click the “-” and “+” buttons in the “Manual thresholding” input box to set the threshold level.
Remove small particles: Type a percentage and/or click the “-” and “+” buttons in the “Remove small particles” input box to set the maximum size cutoff for particles to remove. Particles with fewer pixels than the set number will be removed.
Remove small holes: Type a percentage and/or click the “-” and “+” buttons in the “Remove small holes” input box to set the maximum size cutoff for holes to remove. Holes with fewer pixels than the set number will be removed.
Run postprocessing: Click “Run Postprocessing” button to identify alveolar tissue, airwary lumens, and vessel lumens, and to remove small particles and holes. Once completed, manually edit the post-processing layer as necessary with the built-in napari tools to the left of the displayed image layer. See Napari documentation for more information about how to use these tools.
Assessments: Calculate morphometry assessments—mean linear intercept (MLI) and airspace volume density (ASVD) on the fully classified image.
Select ASVD: To include ASVD calculations in results, check the “ASVD” checkbox; otherwise, leave the box unchecked. Leave the box unchecked to increase the speed of the assessments calculation or to exclude unnecessary data from the final export file.
Select MLI: To include MLI calculations in results, check the “MLI” checkbox; otherwise, leave the box unchecked. Leave the box unchecked to increase the speed of the assessments calculation or to exclude unnecessary data from the final export file.
Set number of lines: Type a number and/or click the “-” and “+” buttons in the “number of lines” input box to set the number of MLI lines.
Set minimum length: Type a number and/or click the “-” and “+” buttons in the “minimum length” input box to set the minimum length required for a chord to be included in the mean calculation.
Set scale: Type a number and/or click the “-” and “+” buttons in the “scale” input box to set the scale factor (i.e. a pixel to physical space multiplier).
Run Assessments: Click the “Run Assessments” button to calculate the selected assessments. The ASVD and MLI calculation results will display to the right of the assessment checkboxes.
Export Results: Collect assessment results for each image and export all the data into a file when done (*.csv or *.json).
Interpreting Results
MLI: Mean Linear Intercept for the given image
Standard deviation: The standard deviation of the lengths of the chord used to calculate MLI
Number of chords: The number of chords used to calculate MLI
ASVD: Airspace Volume Density calculation for the given image
Airspace pixels: The total number of airspace pixels
Non airspace pixels: The total number non-airspace pixels
Add last result: Click the “Add” button to add the assessment data to the final export file. Once the results are added, you can return to the "Processing" step and do another image.
Remove last result: Click the “Remove” button to remove the last results added to the export file.
Clear export data: Click the “Clear” button to clear the export data file.
Export Results: Click the “Export Results” button to open a file dialogue for saving the assessments results. Note that the plugin supports two export result file types, *.csv and *.json that you can choose between.
Manual Annotation Help: Information and tips to help you manually annotate your images
Annotated Diagram
Labels
Airway Epithelium: 5
Vessel Endothelium: 11
Airway Lumen: 3
Vessel Lumen: 17
Parenchyma: 18
Alveoli: 8
Blocking: 1
Annotation Tips
Eyedropper Tool: Quickly identify and switch to the correct label by using the eyedropper tool. Click on a part of the image to switch to the label of the pixel you clicked.
Select the Correct Layer: Before making annotations, ensure you're working on the proper layer. Select the appropriate layer under "layer list."
Optimize Your View: Hide unnecessary layers to make annotation easier. Toggle a layer's visibility by clicking the eye icon next to its name.
More
Light/Dark Mode: Change application appearance to a lighter or darker aesthetic according to personal preference.
On Windows/Linux: Ctrl + Shift + T
On macOS: Cmd + Shift + T
Switch theme through napari preferences
In the menu bar at the top of the screen, select "napari."
In the dropdown, select "Preferences."
In the menu on the left, click "Appearance."
Under the theme dropdown, select "dark," "light," or "system," according to personal preference.
Select an image: The remaining steps will concern this image.
Select a model: The selected model will run on the image and predict (segment) vessel and airway epithelium.
Select a confidence level: Type a percentage and/or click the “-” and “+” buttons in the “Minimum confidence” input box to set the confidence level. Predictions with lower confidence then the set confidence level will not appear.
Run processing: Click the “Run Processing” button to run the model and segment vessel and airway epithelium filtered by confidence level. Once completed, manually edit the prediction as necessary with the built-in napari tools to the left of the displayed image layer. See Napari documentation for more information about how to use these tools.
Set scale: Type a number and/or click the “-” and “+” buttons in the “scale” input box to set the scale factor (i.e. a pixel to physical space multiplier).
Run Assessments: Click the “Run Assessments” button to calculate the selected assessments. The ASVD and MLI calculation results will display to the right of the assessment checkboxes.
