Metadata-Version: 2.4
Name: spectramap
Version: 0.6.2
Summary: Hyperspectral package for spectroscopists
Home-page: https://github.com/MicroscopeMaestro/spectramap
Author: Juan David Muñoz-Bolaños
Author-email: jmunozbolanos@gmail.com
Project-URL: Bug Tracker, https://github.com/MicroscopeMaestro/spectramap
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Software Development :: Bug Tracking
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: colorcet
Requires-Dist: spc-spectra
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary



## Features

<p align="justify">The package includes standard tools such as reading, preprocessing, processing and visualization. The designing was focused on working hyperspectral images from Raman datasets. The package is extended to other spectroscopies as long as the data follows the type data structure.  Some features are shown by the next figures.

- <p align="justify">Preprocessing: some tool such as smoothing, removal of spikes, normalization and advanced baseline corrections are included. Figure 1 illustrates a mean and standard deviation of a tissue signature.

<p align="center"><img src="https://raw.githubusercontent.com/MicroscopeMaestro/spectramap/main/docs/images/tissue_signature.png" />

<p align="center"> Figure 1 Visualization of tissue Raman signature

- <p align="justify">Processing: some tools such as unmixing, pca, pls, vca and hierarchical and kmeans clustering are included. Figure 2 displays application of clustering for locating microplastics on complex matrices.
  
  <p align="center"><img src="https://raw.githubusercontent.com/MicroscopeMaestro/spectramap/main/docs/images/clustering_map.png" /><br><img src="https://raw.githubusercontent.com/MicroscopeMaestro/spectramap/main/docs/images/clustering_stack.png" /></p>
  
  <p align="center"> Figure 2 Segmentation by clustering: (a) clustered image, (b) unmixing image, (c) image and (d) mean clusters

- <p align="justify">Visualization: the next examples shows the pca scores of several biomolecules.
  
  <p align="center"><img src="https://raw.githubusercontent.com/MicroscopeMaestro/spectramap/main/docs/images/pca_scores.png" />

<p align="center">Figure 3 PCA scores

## Further upcoming developments:

- [ ] Graphical User Interface

- [ ] Supervised tools

- [ ] Use of large language models

- [x] Optimizing speed and organizing main code 

- [x] More examples

## Installation

<p align="justify">The predetermined work interface is Python 3. The library comes with 8 different hyperspectral examples and analysis. A manual presents the relevant functions and examples <a href="https://github.com/MicroscopeMaestro/spectramap/tree/main/docs"> Manual</a>.
<p align="justify">Install the library and required packages: (admin rights):

```python
pip install spectramap
```

## Quick Start Examples

Below are quick examples demonstrating how to use `spectramap` for hyperspectral imaging analysis.

### Example 1: Microplastics Analysis (DBSCAN Clustering)
This example reads hyperspectral data of microplastics, applies density-based clustering, and displays the mapped clusters.
```python
from spectramap import spmap as sp

# Create hyper_object
micro = sp.hyper_object('MP')

# Read hyperspectral data
path = 'examples/microplastics_tissue/microplastics_tissue'
micro.read_csv_xz(path)

# Apply Hierarchical Density-Based Clustering
micro.dbscan(5, 0.5)

# Display 2D map and spectral cluster stack
colors = micro.show_map(['gray', 'k', 'r'], None, 1)
micro.show_stack(0, 0, colors)
```

### Example 2: Bladder Tissue Segmentation (K-Means Clustering)
This example demonstrates k-means clustering and background removal.
```python
from spectramap import spmap as sp

bladder = sp.hyper_object("bladder")
bladder.read_csv_xz("examples/bladder/bladder")

# Set step size resolution (e.g. 300 µm) and normalize
bladder.set_resolution(0.3)
bladder.vector()

# K-means clustering and label removal
bladder.kmeans(3)
bladder.remove_label([1]) # Removing background label

# Display
colors = bladder.show_map(['black', 'green'], None, 1)
bladder.show_stack(0, 0, colors)
```

## License

<p style="text-align: center;">
    MIT

<p align="justify">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:

<p align="justify">The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

<p align="justify">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.

## References

[1] F. Pedregosa, G. Varoquaux, and A. Gramfort, “Scikit-learn: Machine Learning in Python,” Journal of Machine Learning Research, vol. 12, pp. 2825-- 2830, 2011.

[2] J. M. P. Nascimento and J. M. B. Dias, “Vertex component analysis: A fast algorithm to unmix hyperspectral data,” IEEE Transactions on Geoscience and Remote Sensing, vol. 43, no. 4, pp. 898–910, 2005, doi: 10.1109/TGRS.2005.844293.

[3] Z. M. Zhang, S. Chen, and Y. Z. Liang, “Baseline correction using adaptive iteratively reweighted penalized least squares,” Analyst, vol. 135, no. 5, pp. 1138–1146, 2010, doi: 10.1039/b922045c.

[4] L. McInnes, J. Healy, S. Astels, *hdbscan: Hierarchical density based clustering* In: Journal of Open Source Software, The Open Journal, volume 2, number 11. 2017
