Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nanthony21 authored Aug 11, 2022
1 parent 6b62ce4 commit 76509bf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PWSpy
A Python module dedicated to analysis of Partial Wave Spectroscopic Microscopy data.
A Python module dedicated to analysis of Partial Wave Spectroscopic Microscopy data. Read the paper [here](https://joss.theoj.org/papers/10.21105/joss.03957)

## Statement of need
Any analysis of raw data generated by PWS and related imaging modes requires loading image data and metadata from a large variety of file formats, performing complex pre-processing steps before any of the real analysis begins. Any minor variations in how this pre-processing is performed can result in major differences in final analysis results. PWSpy provides an object-oriented interface for performing all common file I/O and analysis tasks related to PWS. This allows users to write succinct and readable scripts/software that function identically regardless of the file format of the raw data and which are guaranteed to perform all basic operations properly. The analysis steps described in previous publications ([1](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC5348632/), [2](https://www.nature.com/articles/s41467-019-09717-6), [3](https://www.osapublishing.org/ol/viewmedia.cfm?uri=ol-45-17-4810&seq=0&html=true)) can be found written out clearly in Python under the `analysis` package. Classes providing uniform file handling for the current file format used by the [PWS Acquisition plugin for Micro-Manager](https://github.com/nanthony21/PWSAcquisition) as well as all known legacy formats can be found under the `dataTypes` package. This library provides support for the backend code of [PWSpy_GUI](https://github.com/nanthony21/pwspy_gui).
Expand Down

0 comments on commit 76509bf

Please sign in to comment.