ramantools
Tools for analyzing Raman spectroscopy data, measured by a Witec confocal Raman microscope. It uses xarray DataArrays to effiently store and analyze spectroscopy maps and individual spectra, as well as their metadata. There are two containers for Raman spectroscopy data: ramanmap and singlespec, for use with spectroscopy maps and single spectra.
Documentation can be found here: zrbyte.github.io/ramantools
Installation:
pip install ramantools
If you use this package in your publication, consider citing it: Peter Nemes-I. (2023) “zrbyte/ramantools: v0.3.1”. Zenodo. doi: 10.5281/zenodo.10143138.
Summary of Core API
ramanmap
Container class for Raman maps exported from Witec software. Key attributes include:
mapxr:xarray.DataArraystoring intensity values, coordinates and metadatamap: rawnumpyarray of intensitiesramanshift: array of Raman shift valuesmask: boolean mask populated after background removalsamplenameandmapname: names extracted from metadata
singlespec
Container for individual Raman spectra. Important variables:
ssxr:xarray.DataArraywith spectral data and metadatacountsandramanshift: raw spectral datamask: background fit masksamplenameandspecname: metadata fields
Utility functions
gaussian,lorentzandlorentz2implement standard peak shapespolynomial_fitperforms polynomial baseline fittingbgsubtractremoves background using automatic peak detectionpeakfitfits peak functions to spectra or maps
Each class also provides methods for history tracking, background subtraction, calibration, normalization and cosmic ray removal as described in the module docstrings.
1 maintainer
Metadata
1 maintainer
Release files for ramantools 0.3.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ramantools-0.3.6.tar.gz | 28.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ramantools-0.3.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 56.9 kB
Release files / ramantools-0.3.6.tar.gz
| Download URL | ramantools-0.3.6.tar.gz |
|---|---|
| Size | 28.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
868d386a77eb3b15a1046f57a83d9a0cc9602a63d8c7a27be6ba2c83b1bf4527
|
|
BLAKE2b-256 checksum How to use checksums |
b2b7dd4b130dfe9fdf5bdb2ccfd38c73392206507781b5d106e86deeab0c41cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Release files / ramantools-0.3.6-py3-none-any.whl
| Download URL | ramantools-0.3.6-py3-none-any.whl |
|---|---|
| Size | 28.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8ed1533193fca04dfa93b3c929b2d2107783eb35e22bd3b4dc9bed7a06c4459f
|
|
BLAKE2b-256 checksum How to use checksums |
b1886cf03bf2fed8043d5031312c48b092afab9fa0ad62e4f2d8eab37b4e1730
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
