AlveolEye 0.1.2__py3-none-any.whl

AlveolEye-0.1.2.dist-info/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2022 <>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

AlveolEye-0.1.2.dist-info/METADATA

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: AlveolEye
+Version: 0.1.2
+Summary: Reads lung slides with AI-driven and classical methods
+Author: Joseph Hirsh
+Author-email: josephhirsh9@gmail.com
+License: MIT
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: napari
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: magicgui
+Requires-Dist: qtpy
+Provides-Extra: testing
+Requires-Dist: pytest ; extra == 'testing'
+Requires-Dist: pytest-cov ; extra == 'testing'
+Requires-Dist: pytest-qt ; extra == 'testing'
+Requires-Dist: napari ; extra == 'testing'
+Requires-Dist: qtpy ; extra == 'testing'
+
+<!--
+[![License MIT](https://img.shields.io/pypi/l/automated-lung-morphometry.svg?color=green)](https://github.com/Quooooooookka/automated-lung-morphometry/raw/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/automated-lung-morphometry.svg?color=green)](https://pypi.org/project/automated-lung-morphometry)
+[![Python Version](https://img.shields.io/pypi/pyversions/automated-lung-morphometry.svg?color=green)](https://python.org)
+[![tests](https://github.com/Quooooooookka/automated-lung-morphometry/workflows/tests/badge.svg)](https://github.com/Quooooooookka/automated-lung-morphometry/actions)
+[![codecov](https://codecov.io/gh/Quooooooookka/automated-lung-morphometry/branch/main/graph/badge.svg)](https://codecov.io/gh/Quooooooookka/automated-lung-morphometry)
+[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/automated-lung-morphometry)](https://napari-hub.org/plugins/automated-lung-morphometry)
+-->
+
+# AlveolEye: Automated lung morphometry made easy
+
+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
+
+1. Install miniconda by downlading the appropriate version from [here](https://docs.anaconda.com/free/miniconda/)
+
+   a. Choose the version that matches your processor
+
+   b. Download the "pkg" version for easy install
+2. Open a terminal, or miniconda prompt, and clone this git repository by running:
+
+    ```git clone https://github.com/SucreLab/AlveolEye```
+3. Go to the AlveolEye directory
+
+    ```cd AlveolEye```
+4. Create the conda environment
+
+    ```conda env create -f ./environment.yml```
+5. Activate the new environment
+
+    ```conda activate AlveolEye```
+6. Install the plugin
+
+    ```pip install .```
+7. Launch napari, followed by locating the plugin in the plugin menu
+
+    ```napari```
+
+## Running post-installation
+
+1. Open a terminal, or miniconda prompt, activate the environment and run napari
+
+```
+conda activate AlveolEye
+napari
+```
+
+
+# AlveolEye Usage Tutorial
+
+## Annotated Diagram
+![annotated diagram](./docs/Colored_AlveolEye.png)
+
+## Processing: Identify and segment vessel and airway epithelium with an AI computer vision model.
+1. ![#FF3333](https://placehold.co/15x15/FF3333/FF3333.png) **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.
+2. ![#FF9933](https://placehold.co/15x15/FF9933/FF9933.png) **Select a model**</span>: 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.
+3. ![#FFFF33](https://placehold.co/15x15/FFFF33/FFFF33.png) **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.
+4. ![#f03c15](https://placehold.co/15x15/33FF33/33FF33.png) **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.
+1. ![#FF3333](https://placehold.co/15x15/FF3333/FF3333.png) **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.
+2. ![#FF9933](https://placehold.co/15x15/FF9933/FF9933.png) **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.
+3. ![#FFFF33](https://placehold.co/15x15/FFFF33/FFFF33.png) **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.
+4. ![#f03c15](https://placehold.co/15x15/33FF33/33FF33.png) **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.
+1. ![#FF3333](https://placehold.co/15x15/FF3333/FF3333.png) **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.
+2. ![#FF9933](https://placehold.co/15x15/FF9933/FF9933.png) **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.
+3. ![#FFFF33](https://placehold.co/15x15/FFFF33/FFFF33.png) **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.
+4. ![#f03c15](https://placehold.co/15x15/33FF33/33FF33.png) **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.
+5. ![#f03c15](https://placehold.co/15x15/3359FF/3359FF.png) **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).
+6. ![#f03c15](https://placehold.co/15x15/C433FF/C433FF.png) **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.
+1. ![#FF3333](https://placehold.co/15x15/FF3333/FF3333.png) **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.
+2. ![#FF9933](https://placehold.co/15x15/FF9933/FF9933.png) **Remove last result**: Click the “Remove” button to remove the last results added to the export file.
+3. ![#FFFF33](https://placehold.co/15x15/FFFF33/FFFF33.png) **Clear export data**: Click the “Clear” button to clear the export data file.
+4. ![#f03c15](https://placehold.co/15x15/33FF33/33FF33.png) **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.
+

AlveolEye-0.1.2.dist-info/RECORD

@@ -0,0 +1,38 @@
+alveoleye/__init__.py,sha256=n4sTm_7myRcG7tZzxVzubSR5eO2Uy0o99zeZm191of0,323
+alveoleye/_action_box.py,sha256=6CuFgpjJQMgE4H2cOGMQHzzD0IwK9xU462_8emuHvs4,4443
+alveoleye/_boxes.py,sha256=rAQwjr-2uby8P-VNqGjITI4xfEutSB_WwJZWcns7umw,28900
+alveoleye/_export_operations.py,sha256=kaRaNTlQV1GylroLbsDP0ELsFOxiNmKZINA0qdgcAp8,2373
+alveoleye/_gui_creator.py,sha256=yYm7fToV3Y_zAeUIAXV-VgjzBvVOlLN1vvqwKE5ecYA,6217
+alveoleye/_layers_editor.py,sha256=_rRHVHE-qKLM9m2o1Nnx54nbI3p_-ppnD2TuJoXtlCE,1248
+alveoleye/_reader.py,sha256=0jmhZXJDGCxDd_DEk-05IQzIZcwHjfZ7tJLGQaPYP3I,603
+alveoleye/_rules.py,sha256=jKrsWxc1FPGp--BWIaeQI5QZFYJFQ9PI9TDM3iHpvQ0,1081
+alveoleye/_sample_data.py,sha256=xH1frjJRRlEdtBxJsebIYJ1FHq1hN53bMlL_--HaYfE,644
+alveoleye/_widget.py,sha256=Y1cFXoQIpPosh6WtSdOO_E2lc8zhIYKUqoP7ei3xA84,2545
+alveoleye/_workers.py,sha256=KWc4zA-tnZI2gj2Ci638qMG53H3C6WLf0js2ag4XoC8,9477
+alveoleye/_writer.py,sha256=iqoyFgN-IWctf3UrLp7RtvA0e9oaHfUNxk16qMuJh_A,923
+alveoleye/config.json,sha256=araY5GyTQ6oqqpeF_LpTVpX64rVhr2bAB6b3J2Ivrcg,4647
+alveoleye/dark_theme.css,sha256=n1OjjauuE834ywYNob9yvbcGbOL4uEQ-jYEN9j2pgfc,1473
+alveoleye/light_theme.css,sha256=gLJ_R831AlebX7DgX8Neyil_xF2umR5ubCqe1PNLD-0,1448
+alveoleye/napari.yaml,sha256=H5d6gcb5_AQ_4obgVqk7OKxZ1ckk4io81Le5un9pIIQ,1294
+alveoleye/_tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alveoleye/_tests/test_lungcv.py,sha256=CrhtbhQkfZMfiQuoyQvF1NDQlCPvxrsCs2rZSbNtjkQ,623
+alveoleye/_tests/test_reader.py,sha256=ssmS6ZO_e39HEBGz3BZfDw6cZGwDlC51F0T-b98fNWQ,219
+alveoleye/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alveoleye/lungcv/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alveoleye/lungcv/assessments.py,sha256=1JK248J8SDX_lcWv6AVVVs2-yhZChiWf6PCyTHFJV-I,2286
+alveoleye/lungcv/model_operations.py,sha256=nogggzDn-bWmEByrQ06jNS6bwoNiXiOSe1EThhqsIwo,4241
+alveoleye/lungcv/postprocessor.py,sha256=ukueii0XtW6Tr7whYp_8srgynkPueS8I6Cjf3iyA--c,6357
+alveoleye/lungcv/mrcnn/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alveoleye/lungcv/mrcnn/coco_eval.py,sha256=MUKHllRJL44qYm-cD20OWOtjk0P9WhDAPLhhxt_gvrs,6496
+alveoleye/lungcv/mrcnn/coco_utils.py,sha256=wws9NlCnUgCSV0NgdR2N5KnG6ecUy12fDSvPklzCE9Y,8437
+alveoleye/lungcv/mrcnn/engine.py,sha256=KIJ2vSfy_QMJzEGmrXAxHIlCstjrGDf9FvvoNgq0C-I,4188
+alveoleye/lungcv/mrcnn/group_by_aspect_ratio.py,sha256=TmUxvDCcS8LvyGS5t4WIez0H-JTGnOIK4k_RiCxMss4,7147
+alveoleye/lungcv/mrcnn/train.py,sha256=XacNPR6AZKxaREiYNaTlfLZhJ4p0H00PIuzYTv0JUNY,8409
+alveoleye/lungcv/mrcnn/transforms.py,sha256=lyRR2duoU4D_W5KVMxsmMuu3FY7fZR-3qKnIbE1m0eo,23630
+alveoleye/lungcv/mrcnn/utils.py,sha256=4tmArnpysH5Mjp3V3hAB41at3AtZn6R-48I_vAmOmTo,13587
+AlveolEye-0.1.2.dist-info/LICENSE,sha256=_rmYY1BpzHFTLw0NkYm9KhksluU0ap3_RNc45FMaVao,1070
+AlveolEye-0.1.2.dist-info/METADATA,sha256=k0pCTzaMxYMduVetF9pN-Ts-eHdVM9_j2CYRAeWaR3M,10638
+AlveolEye-0.1.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+AlveolEye-0.1.2.dist-info/entry_points.txt,sha256=4LaW7WCJHHGCae4CBhct4NKUJpNA6E-1k9z9PBH2gwA,52
+AlveolEye-0.1.2.dist-info/top_level.txt,sha256=lLQjkcOZaZzEG9ECpos8B4ZUYTn6fDiRtO4Tl_tqfAc,10
+AlveolEye-0.1.2.dist-info/RECORD,,

AlveolEye-0.1.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

AlveolEye-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[napari.manifest]
+AlveolEye = alveoleye:napari.yaml

AlveolEye-0.1.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+alveoleye

alveoleye/__init__.py

@@ -0,0 +1,14 @@
+__version__ = "0.1.2"
+
+from ._reader import napari_get_reader
+from ._sample_data import make_sample_data
+from ._widget import WidgetMain
+from ._writer import write_multiple, write_single_image
+
+__all__ = (
+    "napari_get_reader",
+    "write_single_image",
+    "write_multiple",
+    "make_sample_data",
+    "WidgetMain",
+)

alveoleye/_action_box.py

@@ -0,0 +1,137 @@
+from qtpy.QtCore import Qt, QTimer, QThread
+from qtpy.QtWidgets import QVBoxLayout, QPushButton, QGroupBox
+
+import alveoleye._rules as rules
+import alveoleye._gui_creator as gui_creator
+from alveoleye._workers import WorkerParent
+
+
+class ActionBox(QGroupBox):
+    current_results = []
+    file_name = None
+    all_action_boxes = []
+    step = 0
+
+    def __init__(self, config_data, napari_viewer):
+        super().__init__()
+
+        self.action_box_config_data = config_data["ActionBox"]
+        self.layers_config_data = config_data["Layers"]
+        self.labels_config_data = config_data["Labels"]
+        self.box_config_data = config_data[self.__class__.__name__]
+
+        ActionBox.all_action_boxes.append(self)
+        WorkerParent.layers_config_data = self.layers_config_data
+
+        self.name = self.box_config_data["TITLE"]
+        self.setTitle(self.name)
+
+        self.state = 0
+
+        self.layout = QVBoxLayout()
+        self.rules_engine = rules.RulesEngine()
+
+        self.worker = None
+        self.thread = None
+        self.action_button = None
+        self.animation_timer = None
+
+        self.box_id = None
+
+        self.napari_viewer = napari_viewer
+
+    class ActionButton(QPushButton):
+        def __init__(self, button_text, tooltip_text, action, *__args):
+            super().__init__(*__args)
+
+            self.button_text = button_text
+            self.tooltip_text = tooltip_text
+
+            self.setText(button_text)
+            self.setToolTip(tooltip_text)
+            self.clicked.connect(action)
+
+            self.setCursor(Qt.PointingHandCursor)
+
+        def set_state(self, state):
+            self.setText([self.button_text, "Cancel", "Canceling..."][state])
+            self.setToolTip([self.tooltip_text, "Cancel operation", "Operation is canceling"][state])
+
+    def broadcast_cancel_message(self):
+        for box in ActionBox.all_action_boxes:
+            if box is not self:
+                box.cancel_action()
+
+    def broadcast_step_change_message(self, box_id=None):
+        for box in ActionBox.all_action_boxes:
+            if box is not self:
+                ActionBox.step = self.box_id if box_id is None else box_id
+                box.rules_engine.evaluate_rules()
+
+    def create_action_box_layout(self, elements, button_text, tooltip_text):
+        self.action_button = self.ActionButton(button_text, tooltip_text, self.on_action_button_press)
+        elements.append(self.action_button)
+        gui_creator.create_sub_layout(self.layout, elements)
+        self.setLayout(self.layout)
+
+    def start_animation(self):
+        self.animation_timer = QTimer()
+        self.animation_timer.timeout.connect(self.on_animation)
+        self.animation_timer.start(self.action_box_config_data["ANIMATION_INTERVAL"])
+
+    def stop_animation(self):
+        self.setTitle(self.name)
+        self.animation_timer.stop()
+
+    def on_animation(self):
+        current_dot_count = self.title().count(".") - self.name.count(".")
+        new_dot_count = (current_dot_count + 1) % (self.action_box_config_data["ANIMATION_DOTS"] + 1)
+        new_title = f"{self.name}{'.' * new_dot_count}"
+
+        self.setTitle(new_title)
+
+    def thread_worker(self):
+        self.thread = QThread()
+        self.worker.moveToThread(self.thread)
+
+        self.worker.results_ready.connect(self.on_results_ready)
+        self.worker.finished.connect(self.thread.quit)
+
+        self.thread.started.connect(self.worker.run)
+        self.thread.finished.connect(self.on_thread_completed)
+
+        self.thread.start()
+
+    def set_state(self, state):
+        self.state = state
+        self.action_button.set_state(state)
+        self.rules_engine.evaluate_rules()
+
+    def cancel_action(self):
+        if self.state == 1:
+            self.worker.cancel()
+            self.set_state(2)
+
+    def on_action_button_press(self):
+        self.broadcast_cancel_message()
+
+        if self.state:
+            self.cancel_action()
+            return
+
+        self.start_animation()
+        self.thread_worker()
+        self.set_state(1)
+
+    def on_results_ready(self, *__args):
+        self.broadcast_step_change_message()
+
+    def on_thread_completed(self):
+        self.thread.deleteLater()
+        self.stop_animation()
+        self.set_state(0)
+
+    def create_ui_rules(self):
+        self.rules_engine.add_rule(lambda: self.state == 2, lambda: rules.toggle(False, self.action_button))
+
+        self.rules_engine.evaluate_rules()