waveorder 2.2.1__py3-none-any.whl → 3.0.0__py3-none-any.whl

waveorder-3.0.0.dist-info/METADATA

@@ -0,0 +1,350 @@
+Metadata-Version: 2.4
+Name: waveorder
+Version: 3.0.0
+Summary: Wave-optical simulations and deconvolution of optical properties
+Author-email: CZ Biohub SF <compmicro@czbiohub.org>
+Maintainer-email: Talon Chandler <talon.chandler@czbiohub.org>, Shalin Mehta <shalin.mehta@czbiohub.org>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Chan Zuckerberg Biohub
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+        ## License Notice for Dependencies
+        
+        This repository is licensed under the BSD License; however, it relies on certain 
+        third-party dependencies that are licensed under the GNU General Public License 
+        (GPL). Specifically:
+        
+        - PyQt5 is licensed under the GNU General Public License v3 or later (GPLv3+).
+        This library is not included in this repository but must be installed separately
+        by users. Please be aware that the GPL license terms apply to these 
+        dependencies, and certain uses of GPL-licensed code may have licensing 
+        implications for your own software.
+        
+Project-URL: Homepage, https://github.com/mehta-lab/waveorder
+Project-URL: Repository, https://github.com/mehta-lab/waveorder
+Project-URL: Issues, https://github.com/mehta-lab/waveorder/issues
+Keywords: simulation,optics,phase,scattering,polarization,label-free,permittivity,reconstruction-algorithm,qlipp,mipolscope,permittivity-tensor-imaging
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.1
+Requires-Dist: colorspacious>=1.1.2
+Requires-Dist: importlib-metadata
+Requires-Dist: iohub<0.4,>=0.2
+Requires-Dist: ipywidgets>=7.5.1
+Requires-Dist: matplotlib>=3.1.1
+Requires-Dist: natsort>=7.1.1
+Requires-Dist: numpy>=1.24
+Requires-Dist: psutil
+Requires-Dist: pyqtgraph>=0.12.3
+Requires-Dist: pydantic
+Requires-Dist: pywavelets>=1.1.1
+Requires-Dist: scipy>=1.3.0
+Requires-Dist: torch>=2.4.1
+Requires-Dist: qtpy
+Requires-Dist: wget>=3.2
+Provides-Extra: visual
+Requires-Dist: napari[pyqt6]; extra == "visual"
+Requires-Dist: PyQt6<6.8,>=6.5; extra == "visual"
+Requires-Dist: napari-ome-zarr>=0.3.2; extra == "visual"
+Requires-Dist: pycromanager==0.27.2; extra == "visual"
+Requires-Dist: jupyter; extra == "visual"
+Requires-Dist: jupytext; extra == "visual"
+Provides-Extra: dev
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: click>=8.2.0; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: napari[pyqt6]; extra == "dev"
+Requires-Dist: PyQt6<6.8,>=6.5; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-qt; extra == "dev"
+Requires-Dist: pytest>=5.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-video; extra == "docs"
+Requires-Dist: myst_parser; extra == "docs"
+Requires-Dist: sphinx_mdinclude; extra == "docs"
+Requires-Dist: linkify-it-py; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: sphinx_sitemap; extra == "docs"
+Requires-Dist: sphinx_gallery; extra == "docs"
+Requires-Dist: pydata_sphinx_theme; extra == "docs"
+Requires-Dist: matplotlib; extra == "docs"
+Requires-Dist: importlib_metadata; extra == "docs"
+Provides-Extra: all
+Requires-Dist: waveorder[visual]; extra == "all"
+Requires-Dist: waveorder[dev]; extra == "all"
+Requires-Dist: waveorder[docs]; extra == "all"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/00367e51-0e0a-445e-8d12-2a273f9014aa" alt="Image" width="50%">
+</p>
+
+[![Python package index](https://img.shields.io/pypi/v/waveorder.svg)](https://pypi.org/project/waveorder)
+[![PyPI monthly downloads](https://img.shields.io/pypi/dm/waveorder.svg)](https://pypistats.org/packages/waveorder)
+[![Total downloads](https://pepy.tech/badge/waveorder)](https://pepy.tech/project/waveorder)
+[![GitHub contributors](https://img.shields.io/github/contributors-anon/mehta-lab/waveorder)](https://github.com/mehta-lab/waveorder/graphs/contributors)
+![GitHub Repo stars](https://img.shields.io/github/stars/mehta-lab/waveorder)
+![GitHub forks](https://img.shields.io/github/forks/mehta-lab/waveorder)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/waveorder)
+
+Label-agnostic computational microscopy of architectural order.
+
+# Overview
+
+`waveorder` is a generalist framework for label-agnostic computational microscopy of architectural order, i.e., density, alignment, and orientation of biomolecules with the spatial resolution down to the diffraction limit. The framework implements wave-optical simulations and corresponding reconstruction algorithms for diverse label-free and fluorescence computational imaging methods that enable quantitative imaging of the architecture of dynamic cell systems.
+
+Our goal is to enable modular and user-friendly implementations of computational microscopy methods for dynamic imaging across the scales of organelles, cells, and tissues.
+
+
+The framework is described in the following [preprint](https://arxiv.org/abs/2412.09775).
+
+https://github.com/user-attachments/assets/4f9969e5-94ce-4e08-9f30-68314a905db6
+
+<details>
+`waveorder` enables simulations and reconstructions of label-agnostic microscopy data as described in the following [preprint](https://arxiv.org/abs/2412.09775)
+<summary> Chandler et al. 2024 </summary>
+<pre><code>
+@article{chandler_2024,
+    author = {Chandler, Talon and Hirata-Miyasaki, Eduardo and Ivanov, Ivan E. and Liu, Ziwen and Sundarraman, Deepika and Ryan, Allyson Quinn and Jacobo, Adrian and Balla, Keir and Mehta, Shalin B.},
+	title = {waveOrder: generalist framework for label-agnostic computational microscopy},
+	journal = {arXiv},
+	year = {2024},
+	month = dec,
+	eprint = {2412.09775},
+	doi = {10.48550/arXiv.2412.09775}
+}
+</code></pre>
+</details>
+
+# Computational Microscopy Methods
+
+ `waveorder` framework enables simulations and reconstructions of data for diverse one-photon (single-scattering based) computational microscopy methods, summarized below.
+
+## Label-free microscopy
+
+### Quantitative label-free imaging with phase and polarization (QLIPP)
+
+Acquisition, calibration, background correction, reconstruction, and applications of QLIPP are described in the following [E-Life Paper](https://elifesciences.org/articles/55502):
+
+[![Unveiling the invisible](https://github.com/mehta-lab/recOrder/blob/main/docs/images/comms_video_screenshot.png?raw=true)](https://www.youtube.com/watch?v=JEZAaPeZhck)
+
+<details>
+<summary> Guo et al. 2020 </summary>
+<pre><code>
+@article{guo_2020,
+	author = {Guo, Syuan-Ming and Yeh, Li-Hao and Folkesson, Jenny and Ivanov, Ivan E. and Krishnan, Anitha P. and Keefe, Matthew G. and Hashemi, Ezzat and Shin, David and Chhun, Bryant B. and Cho, Nathan H. and Leonetti, Manuel D. and Han, May H. and Nowakowski, Tomasz J. and Mehta, Shalin B.},
+	title = {Revealing architectural order with quantitative label-free imaging and deep learning},
+	journal = {eLife},
+	volume = {9},
+	pages = {e55502},
+	year = {2020},
+	doi = {10.7554/eLife.55502}
+}
+</code></pre>
+</details>
+
+### Permittivity tensor imaging (PTI)
+
+PTI provides volumetric reconstructions of mean permittivity ($\propto$ material density), differential permittivity ($\propto$ material anisotropy), 3D orientation, and optic sign. The following figure summarizes PTI acquisition and reconstruction with a small optical section of the mouse brain tissue:
+
+![Data_flow](https://github.com/mehta-lab/waveorder/blob/main/readme.png?raw=true)
+
+The acquisition, calibration, background correction, reconstruction, and applications of PTI are described in the following [paper](https://doi.org/10.1101/2020.12.15.422951) published in Nature Methods:
+
+<details>
+<summary> Yeh et al. 2024 </summary>
+<pre><code>
+@article{yeh_2024,
+	author = {Yeh, Li-Hao and Ivanov, Ivan E. and Chandler, Talon and Byrum, Janie R. and Chhun, Bryant B. and Guo, Syuan-Ming and Foltz, Cameron and Hashemi, Ezzat and Perez-Bermejo, Juan A. and Wang, Huijun and Yu, Yanhao and Kazansky, Peter G. and Conklin, Bruce R. and Han, May H. and Mehta, Shalin B.},
+	title = {Permittivity tensor imaging: modular label-free imaging of 3D dry mass and 3D orientation at high resolution},
+	journal = {Nature Methods},
+	volume = {21},
+	number = {7},
+	pages = {1257--1274},
+	year = {2024},
+	month = jul,
+	issn = {1548-7105},
+	publisher = {Nature Publishing Group},
+	doi = {10.1038/s41592-024-02291-w}
+}
+</code></pre>
+</details>
+
+
+### Quantitative phase imaging (QPI) from defocus
+__phase__ from a volumetric brightfield acquisition ([2D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-54-28-8566)/[3D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-57-1-a205))
+
+![Image](https://github.com/user-attachments/assets/caf7714b-59ee-40bb-9ee4-f13db4feece6)
+
+
+<details>
+<summary> Jenkins and Gaylord 2015 (2D QPI from defocus) </summary>
+<pre><code>
+	@article{Jenkins:15,
+	author = {Micah H. Jenkins and Thomas K. Gaylord},
+	journal = {Appl. Opt.},
+	keywords = {Phase retrieval; Partial coherence in imaging; Interferometric imaging ; Imaging systems; Microlens arrays; Optical transfer functions; Phase contrast; Spatial resolution; Three dimensional imaging},
+	number = {28},
+	pages = {8566--8579},
+	publisher = {Optica Publishing Group},
+	title = {Quantitative phase microscopy via optimized inversion of the phase optical transfer function},
+	volume = {54},
+	month = {Oct},
+	year = {2015},
+	url = {https://opg.optica.org/ao/abstract.cfm?URI=ao-54-28-8566},
+	doi = {10.1364/AO.54.008566},
+}
+</code></pre>
+</details>
+
+<details>
+<summary> Soto, Rodrigo, and Alieva 2018 (3D QPI from defocus) </summary>
+<pre><code>
+@article{Soto:18,
+author = {Juan M. Soto and Jos\'{e} A. Rodrigo and Tatiana Alieva},
+journal = {Appl. Opt.},
+keywords = {Coherence and statistical optics; Image reconstruction techniques; Optical transfer functions; Optical inspection; Three-dimensional microscopy; Acoustooptic modulators; Illumination design; Inverse design; LED sources; Three dimensional imaging; Three dimensional reconstruction},
+number = {1},
+pages = {A205--A214},
+publisher = {Optica Publishing Group},
+title = {Optical diffraction tomography with fully and partially coherent illumination in high numerical aperture label-free microscopy \[Invited\]},
+volume = {57},
+month = {Jan},
+year = {2018},
+url = {https://opg.optica.org/ao/abstract.cfm?URI=ao-57-1-A205},
+doi = {10.1364/AO.57.00A205},
+}
+</code></pre>
+</details>
+
+### QPI with differential phase contrast
+ __phase__ from differential phase contrast
+
+***Work in progress***
+
+* [2D](https://www.osapublishing.org/oe/fulltext.cfm?uri=oe-23-9-11394&id=315599) DPC
+* [3D](https://www.osapublishing.org/boe/fulltext.cfm?uri=boe-7-10-3940&id=349951) DPC
+
+
+## Fluorescence microscopy
+
+### Widefield deconvolution microscopy
+__fluorescence density__ from a widefield volumetric fluorescence acquisition.
+
+<details>
+<summary> Swedlow 2013 </summary>
+<pre><code>
+@article{Swedlow:13,
+author = {Swedlow, John R.},
+journal = {Methods Cell Biol.},
+title = {Quantitative fluorescence microscopy and image deconvolution},
+year = {2013},
+volume = {114},
+pages = {407--26},
+doi = {10.1016/B978-0-12-407761-4.00017-8}
+}
+</code></pre>
+</details>
+
+### Oblique plane light-sheet microscopy
+__fluorescence density__ from oblique plane light-sheet microscopy.
+
+<details>
+<summary> Ivanov, Hirata-Miyasaki, Chandler et al. 2024 </summary>
+<pre><code>
+@article{ivanov_2024,
+author = {Ivanov, Ivan E. and Hirata-Miyasaki, Eduardo and Chandler, Talon and Cheloor-Kovilakam, Rasmi and Liu, Ziwen and Pradeep, Soorya and Liu, Chad and Bhave, Madhura and Khadka, Sudip and Arias, Carolina and Leonetti, Manuel D. and Huang, Bo and Mehta, Shalin B.},
+title = {Mantis: High-throughput 4D imaging and analysis of the molecular and physical architecture of cells},
+journal = {PNAS Nexus},
+volume = {3},
+number = {9},
+pages = {pgae323},
+year = {2024},
+doi = {10.1093/pnasnexus/pgae323}
+</code></pre>
+</details>
+
+
+## Citation
+
+Please cite this repository, along with the relevant publications and preprints, if you use or adapt this code. The citation information can be found by clicking "Cite this repository" button in the About section in the right sidebar.
+
+## Installation
+
+Create a virtual environment:
+
+```sh
+conda create -y -n waveorder python=3.12
+conda activate waveorder
+```
+
+Most users should install `waveorder` with:
+```sh
+pip install waveorder[visual]
+```
+
+We also maintain three dependency sets for different interfaces:
+
+```sh
+pip install waveorder          # API, CLI
+pip install waveorder[visual]  # API, CLI, GUI
+pip install waveorder[all]     # API, CLI, GUI, docs, dev dependencies
+```
+
+
+
+(M1 users) `pytorch` has [incomplete GPU support](https://github.com/pytorch/pytorch/issues/77764),
+so please use `export PYTORCH_ENABLE_MPS_FALLBACK=1`
+to allow some operators to fallback to CPU if you plan to use GPU acceleration for polarization reconstruction.
+
+
+## Examples
+The [examples](https://github.com/mehta-lab/waveorder/tree/main/docs/examples) illustrate simulations and reconstruction for 2D QLIPP, 3D phase from brightfield, and 2D/3D PTI methods. To run examples, use
+
+```sh
+git clone https://github.com/mehta-lab/waveorder.git
+cd waveorder
+pip install -e .[all]
+python ./docs/examples/models/phase_thick_3d.py
+```

waveorder-3.0.0.dist-info/RECORD

@@ -0,0 +1,69 @@
+waveorder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+waveorder/_version.py,sha256=9fL11DDeXfhKmxyz_HrYU3Yy7BjMWrJklCddPlmAj6A,704
+waveorder/background_estimator.py,sha256=GFy3N0qqp5M6JVZBbIUvTYhSin8Njg7zA2WN69pKLAE,12398
+waveorder/correction.py,sha256=uAWDKXq-FYwi1obxxWq0A-suNVf1cvqUnPsDC-LIlsM,3460
+waveorder/filter.py,sha256=UatcxE3xqwwB1p0IVoEjH8Qw0CB6hvcXvnRR6IRNXsQ,7325
+waveorder/focus.py,sha256=4IenjsMfwDkZlSImNMB3mnyuDz4XF7VJWiaCmzDLseI,10928
+waveorder/napari.yaml,sha256=iqmzGwSopu-L38yxuAnhMTuBvDqKIm2mTWfxjn6Duks,1463
+waveorder/optics.py,sha256=RikR3kkPFoVUS86jiGQZey7Jtz5Ga-xKWnXsexo3Okc,44242
+waveorder/reconstruct.py,sha256=nF00-uxYF67QVcNClp1VIB31ElUfbjO3RNxbxc0ELH4,832
+waveorder/sampling.py,sha256=OAqlfjEemX6tQV2a2S8X0wQx9JCSykcvVxvKr1CY3H0,2521
+waveorder/stokes.py,sha256=G_hcqS-GbslVnCWmS13y77K1YZ8cvwIl-DDKyC84LSI,15184
+waveorder/util.py,sha256=axo2XvguW2UGb6IIXzgZVlP2IDxP4qUT_hi3DUTUwv8,71236
+waveorder/waveorder_reconstructor.py,sha256=-MluWmnZnCZm7Xu-8V8QWX9ma0_5oAZO2Xlyrg1bRes,152072
+waveorder/waveorder_simulator.py,sha256=uRRX_wcWzJzlVcfToLpIlh4e8Xt9NjTvdonyGEf2Z1c,45805
+waveorder/acq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+waveorder/acq/acq_functions.py,sha256=4GJCkxncFunsRbLesf1LErY7CaA26dMh2goVVUr72y0,5128
+waveorder/assets/HSV_legend.png,sha256=7k9l23V-is7TIVnKchIat9JE_UGSqjbRzgVROeNrNJU,12132
+waveorder/assets/JCh_legend.png,sha256=waQ980-7-APUqzuvBjKh5PKE91jaCbKire0NJf-y6AQ,14900
+waveorder/assets/waveorder_plugin_logo.png,sha256=3advwUtIqhXJmHrqXF3NmWB8OMjQP2N-Nsbi-IaIQw8,14686
+waveorder/calib/Calibration.py,sha256=Fl6zQOJg4V6nKtbAlNL7s9kslmrxk6q-LAueh59F1bA,52007
+waveorder/calib/Optimization.py,sha256=uBQRvZ3tsG52pOSwnRj3Lduf_wVTTYfcjegAZsN58UE,13909
+waveorder/calib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+waveorder/calib/calibration_workers.py,sha256=xI1Zg_D6m1wuls4af0Nlzl_3fADeAeHzSO2gWKGaORo,15325
+waveorder/cli/apply_inverse_models.py,sha256=8nrwj4bgHnha59uOvvV0PqdRyjyldWfUs_ZbfdtJ-ZE,10344
+waveorder/cli/apply_inverse_transfer_function.py,sha256=EgmzIoDX4o7GqYIQfk7wgJZ8DxqfXeTAJjDXbMOqWPY,13369
+waveorder/cli/compute_transfer_function.py,sha256=IfOtxVSYqcF9urDBxDftm8Txw3h6jNzAswIOgnXtRf0,14319
+waveorder/cli/gui_widget.py,sha256=bPbeAAQEFzD2WnlO_vKZ5RSdaFi6J3Psouzfuj7u9f4,1343
+waveorder/cli/main.py,sha256=uW18kwZOpYbgUKfGXexIF3LITxkUJeRMHnTmAwAPWjc,942
+waveorder/cli/monitor.py,sha256=XBhqyd7dxnXrfca23rm0oAILEnx8lEVPsS2oSfmt8kw,4757
+waveorder/cli/option_eat_all.py,sha256=GJgI4owf59IhZTtQiLsUy19WQJLJDXB-Gg7WIf5aREw,1823
+waveorder/cli/parsing.py,sha256=IWSjRCp2KQiEzw4T_aCvMSoPrKoRRbIJP0Tc8Pcb-R4,3476
+waveorder/cli/printing.py,sha256=tCWRE7YnE4ByROAhaYlCjJLnCwZ3IEcm3Bo6ZoO1uxI,326
+waveorder/cli/reconstruct.py,sha256=qbFCoMZC9utDofx8oU0BUljMC-MoN_ykrp1sXGe39zo,1792
+waveorder/cli/settings.py,sha256=d5EmqnzNjwDHVnP4xONAamBe6I4rdNHWS1pUXKyu1bw,6604
+waveorder/cli/utils.py,sha256=-7RYPUEzhTPhmgQUSptNxE1GmnAjzuucixEBWcRL0KI,5667
+waveorder/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+waveorder/io/_reader.py,sha256=l17s_-1aARCFn76VIpDljoOIL088uPx3A1mTl3T5l9o,1630
+waveorder/io/core_functions.py,sha256=g4HrkfcQinEhCPdt0FtRSXRXUjRL1ZQe5g0sClnjVZA,6553
+waveorder/io/metadata_reader.py,sha256=DiVqdJiwSduHa6eOrfJfcky1ZoFI3ySPEXJrbuFM8fg,5483
+waveorder/io/utils.py,sha256=ArmKCq5_Wj3tyiD9Zl6jaUkjgIslJffJj5xRUGtMcMM,4804
+waveorder/io/visualization.py,sha256=u_EGSc2s1pkB-xvGVxmmMr2zQObihjkV0PCB_7yizak,4753
+waveorder/models/inplane_oriented_thick_pol3d.py,sha256=bx5yViNz7wY5BBXUea1Tw0RhYsEzErENRnAbgpa34C0,5992
+waveorder/models/inplane_oriented_thick_pol3d_vector.py,sha256=Qh1E0fWHh6KThQnW3TYBGmDtNrO98n9W42t6G_nQO5w,9759
+waveorder/models/isotropic_fluorescent_thick_3d.py,sha256=0bu9OdYj2aP1phzRxod8tExURaYdgwddAD61BbGF-lg,10387
+waveorder/models/isotropic_fluorescent_thin_3d.py,sha256=uOxRTOKu5Viv_KTKlW7c91M7hREx3eER-owKFyrhRCQ,10239
+waveorder/models/isotropic_thin_3d.py,sha256=BPp0DR3Pu8b7NpnGXUJ1ZqdGbs_P7-H5iVGagVClPtg,11328
+waveorder/models/phase_thick_3d.py,sha256=eUmf_AbSDMwFNDfE8WPGr5sJShvL4YAjsZff_KO559k,12323
+waveorder/plugin/__init__.py,sha256=4Idw8HLl6LZ-E0cgW9mSsCAQk-D4Hnmoi0W9iaV6yrw,333
+waveorder/plugin/gui.py,sha256=NazopP-wb3Fup4FWfgH4zWdkOKvilpxWrOXgsI0xquI,50593
+waveorder/plugin/gui.ui,sha256=7_CUDI2Wqbh2EBal9-ZmNJcb7cCCxiZcQe-DO6NBnM4,49920
+waveorder/plugin/job_manager.py,sha256=FNQ9T-djbJM2SzRx99khybCjEF5vG-8pS6jEBHqo7og,1157
+waveorder/plugin/main_widget.py,sha256=Vf5Eve9ik_86mdsSbezacME96eFnDf7A9myDaCnHHt4,58098
+waveorder/plugin/tab_recon.py,sha256=kiMhTa6sxqmQAYw9gGpcu66y0vEB-_e5mMAP7V136qU,131698
+waveorder/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+waveorder/scripts/launch_napari.py,sha256=0Sx_2XCJ38pBfe7QvthUn0Vu8ZcqD6qHjwBvzR6V2JY,221
+waveorder/scripts/repeat-cal-acq-rec.py,sha256=XVdQSoTacNczd58MBty4Qa4umprdUkgiwCkWQQr7p4g,3908
+waveorder/scripts/repeat-calibration.py,sha256=mHLM-axQh2h8CE5F11-qfGLoZoHCKOh8IWThESqKgRI,725
+waveorder/scripts/samples.py,sha256=n5PEv2mLXmuuqYhjtzxu7SDeW3MJJgzoYPrGfnX_Poo,3076
+waveorder/scripts/simulate_zarr_acq.py,sha256=AGVKNsi46J0AyDJvgSCOMQqtOIhcNWY5yCMgyeCQTZw,6390
+waveorder/visuals/jupyter_visuals.py,sha256=6kxICjEtP1qc1EuETc_NJ6Y4A7nVaC-bP3wl_CQNPfg,58096
+waveorder/visuals/matplotlib_visuals.py,sha256=v1zi0ZlXEV5CcpNzTWL0vDJ2Md2-RSHnc3rAB61wimg,10915
+waveorder/visuals/napari_visuals.py,sha256=bDEgHvoexdsGW4pIbnLfBCU4e4be41PMyKx9Mq9so1c,2361
+waveorder/visuals/utils.py,sha256=QC5WSc2yzPMjk66IjA39iNFgO_0It6evma201hH8Lg4,1001
+waveorder-3.0.0.dist-info/licenses/LICENSE,sha256=MATRcU1PWMarfKd4-d4q6eMdy4JWzC6fpavJI_zXHeE,2068
+waveorder-3.0.0.dist-info/METADATA,sha256=rn2NzZgz2ev6HQupT9Y_M8-aRNU67ncoFTnx7FBHZBQ,15574
+waveorder-3.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+waveorder-3.0.0.dist-info/entry_points.txt,sha256=cOCI4v8cdinVJiyAMlYZtxK6GCS4GF6Qpk1hTsgW18Y,106
+waveorder-3.0.0.dist-info/top_level.txt,sha256=i3zReXiiMTnyPk93W7aEz_oEfsLnfR_Kzl7PW7kUslA,10
+waveorder-3.0.0.dist-info/RECORD,,

{waveorder-2.2.1.dist-info → waveorder-3.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

waveorder-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+waveorder = waveorder.cli.main:cli
+
+[napari.manifest]
+waveorder = waveorder:napari.yaml

{waveorder-2.2.1.dist-info → waveorder-3.0.0.dist-info}/licenses/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Chan Zuckerberg Biohub
+Copyright (c) 2025, Chan Zuckerberg Biohub
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
@@ -26,3 +26,15 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## License Notice for Dependencies
+
+This repository is licensed under the BSD License; however, it relies on certain 
+third-party dependencies that are licensed under the GNU General Public License 
+(GPL). Specifically:
+
+- PyQt5 is licensed under the GNU General Public License v3 or later (GPLv3+).
+This library is not included in this repository but must be installed separately
+by users. Please be aware that the GPL license terms apply to these 
+dependencies, and certain uses of GPL-licensed code may have licensing 
+implications for your own software.

waveorder-2.2.1.dist-info/METADATA

@@ -1,188 +0,0 @@
-Metadata-Version: 2.4
-Name: waveorder
-Version: 2.2.1
-Summary: Wave-optical simulations and deconvolution of optical properties
-Author-email: CZ Biohub SF <compmicro@czbiohub.org>
-Maintainer-email: Talon Chandler <talon.chandler@czbiohub.org>, Shalin Mehta <shalin.mehta@czbiohub.org>
-License: BSD 3-Clause License
-        
-        Copyright (c) 2019, Chan Zuckerberg Biohub
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        1. Redistributions of source code must retain the above copyright notice, this
-           list of conditions and the following disclaimer.
-        
-        2. Redistributions in binary form must reproduce the above copyright notice,
-           this list of conditions and the following disclaimer in the documentation
-           and/or other materials provided with the distribution.
-        
-        3. Neither the name of the copyright holder nor the names of its
-           contributors may be used to endorse or promote products derived from
-           this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
-Project-URL: Homepage, https://github.com/mehta-lab/waveorder
-Project-URL: Repository, https://github.com/mehta-lab/waveorder
-Project-URL: Issues, https://github.com/mehta-lab/waveorder/issues
-Keywords: simulation,optics,phase,scattering,polarization,label-free,permittivity,reconstruction-algorithm,qlipp,mipolscope,permittivity-tensor-imaging
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Image Processing
-Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: MacOS
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=1.24
-Requires-Dist: matplotlib>=3.1.1
-Requires-Dist: scipy>=1.3.0
-Requires-Dist: pywavelets>=1.1.1
-Requires-Dist: ipywidgets>=7.5.1
-Requires-Dist: torch>=2.4.1
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: black==25.1.0; extra == "dev"
-Provides-Extra: examples
-Requires-Dist: napari[all]; extra == "examples"
-Requires-Dist: jupyter; extra == "examples"
-Dynamic: license-file
-
-# waveorder
-
-[![Python package index](https://img.shields.io/pypi/v/waveorder.svg)](https://pypi.org/project/waveorder)
-[![PyPI monthly downloads](https://img.shields.io/pypi/dm/waveorder.svg)](https://pypistats.org/packages/waveorder)
-[![Total downloads](https://pepy.tech/badge/waveorder)](https://pepy.tech/project/waveorder)
-[![GitHub contributors](https://img.shields.io/github/contributors-anon/mehta-lab/waveorder)](https://github.com/mehta-lab/waveorder/graphs/contributors)
-![GitHub Repo stars](https://img.shields.io/github/stars/mehta-lab/waveorder)
-![GitHub forks](https://img.shields.io/github/forks/mehta-lab/waveorder)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/waveorder)
-
-
-This computational imaging library enables wave-optical simulation and reconstruction of optical properties that report microscopic architectural order.
-
-## Computational label-agnostic imaging
-
-https://github.com/user-attachments/assets/4f9969e5-94ce-4e08-9f30-68314a905db6
-
-`waveorder` enables simulations and reconstructions of label-agnostic microscopy data as described in the following [preprint](https://arxiv.org/abs/2412.09775)
-<details>	
-<summary> Chandler et al. 2024 </summary>
-<pre><code>
-@article{chandler_2024,
-    author = {Chandler, Talon and Hirata-Miyasaki, Eduardo and Ivanov, Ivan E. and Liu, Ziwen and Sundarraman, Deepika and Ryan, Allyson Quinn and Jacobo, Adrian and Balla, Keir and Mehta, Shalin B.},
-	title = {waveOrder: generalist framework for label-agnostic computational microscopy},
-	journal = {arXiv},
-	year = {2024},
-	month = dec,
-	eprint = {2412.09775},
-	doi = {10.48550/arXiv.2412.09775}
-}
-</code></pre>
-</details>
-
-Specifically, `waveorder` enables simulation and reconstruction of 2D or 3D:
-
-1. __phase, projected retardance, and in-plane orientation__ from a polarization-diverse volumetric brightfield acquisition ([QLIPP](https://elifesciences.org/articles/55502)),
-
-2. __phase__ from a volumetric brightfield acquisition ([2D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-54-28-8566)/[3D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-57-1-a205)),
-
-3. __phase__ from an illumination-diverse volumetric acquisition ([2D](https://www.osapublishing.org/oe/fulltext.cfm?uri=oe-23-9-11394&id=315599)/[3D](https://www.osapublishing.org/boe/fulltext.cfm?uri=boe-7-10-3940&id=349951) differential phase contrast),
-
-4. __fluorescence density__ from a widefield volumetric fluorescence acquisition (fluorescence deconvolution).  
-
-The [examples](https://github.com/mehta-lab/waveorder/tree/main/examples) demonstrate simulations and reconstruction for 2D QLIPP, 3D PODT, 3D fluorescence deconvolution, and 2D/3D PTI methods.
-
-If you are interested in deploying QLIPP, phase from brightfield, or fluorescence deconvolution for label-agnostic imaging at scale, checkout our [napari plugin](https://www.napari-hub.org/plugins/recOrder-napari),  [`recOrder-napari`](https://github.com/mehta-lab/recOrder).
-
-## Permittivity tensor imaging 
-
-Additionally, `waveorder` enabled the development of a new label-free imaging method, __permittivity tensor imaging (PTI)__, that measures density and  3D orientation of biomolecules with diffraction-limited resolution. These measurements are reconstructed from polarization-resolved images acquired with a sequence of oblique illuminations.
-
-The acquisition, calibration, background correction, reconstruction, and applications of PTI are described in the following [paper](https://doi.org/10.1101/2020.12.15.422951) published in Nature Methods:
-
-<details>
-<summary> Yeh et al. 2024 </summary>
-<pre><code>
-@article{yeh_2024,
-	author = {Yeh, Li-Hao and Ivanov, Ivan E. and Chandler, Talon and Byrum, Janie R. and Chhun, Bryant B. and Guo, Syuan-Ming and Foltz, Cameron and Hashemi, Ezzat and Perez-Bermejo, Juan A. and Wang, Huijun and Yu, Yanhao and Kazansky, Peter G. and Conklin, Bruce R. and Han, May H. and Mehta, Shalin B.},
-	title = {Permittivity tensor imaging: modular label-free imaging of 3D dry mass and 3D orientation at high resolution},
-	journal = {Nature Methods},
-	volume = {21},
-	number = {7},
-	pages = {1257--1274},
-	year = {2024},
-	month = jul,
-	issn = {1548-7105},
-	publisher = {Nature Publishing Group},
-	doi = {10.1038/s41592-024-02291-w}
-}
-</code></pre>
-</details>
-
-PTI provides volumetric reconstructions of mean permittivity ($\propto$ material density), differential permittivity ($\propto$ material anisotropy), 3D orientation, and optic sign. The following figure summarizes PTI acquisition and reconstruction with a small optical section of the mouse brain tissue:
-
-![Data_flow](https://github.com/mehta-lab/waveorder/blob/main/readme.png?raw=true)
-
-## Examples
-The [examples](https://github.com/mehta-lab/waveorder/tree/main/examples) illustrate simulations and reconstruction for 2D QLIPP, 3D phase from brightfield, and 2D/3D PTI methods.
-
-If you are interested in deploying QLIPP or phase from brightbrield, or fluorescence deconvolution for label-agnostic imaging at scale, checkout our [napari plugin](https://www.napari-hub.org/plugins/recOrder-napari),  [`recOrder-napari`](https://github.com/mehta-lab/recOrder).
-
-## Citation
-
-Please cite this repository, along with the relevant preprint or paper, if you use or adapt this code. The citation information can be found by clicking "Cite this repository" button in the About section in the right sidebar.
-
-## Installation
-
-Create a virtual environment:
-
-```sh
-conda create -y -n waveorder python=3.10
-conda activate waveorder
-```
-
-Install `waveorder` from PyPI:
-
-```sh
-pip install waveorder
-```
-
-Use `waveorder` in your scripts:
-
-```sh
-python
->>> import waveorder
-```
-
-(Optional) Install example dependencies, clone the repository, and run an example script:
-```sh
-pip install waveorder[examples]
-git clone https://github.com/mehta-lab/waveorder.git
-python waveorder/examples/models/phase_thick_3d.py
-```
-
-(M1 users) `pytorch` has [incomplete GPU support](https://github.com/pytorch/pytorch/issues/77764),
-so please use `export PYTORCH_ENABLE_MPS_FALLBACK=1`
-to allow some operators to fallback to CPU
-if you plan to use GPU acceleration for polarization reconstruction.