Skip to main content

Open Raman Processing Library

Project description

ORPL

ORPL (read orpel) is the Open Raman Processing Library. It provides tools for the processing of Raman spectrum including;

  1. System calibration (x-axis and system response)
  2. Cosmic Ray removal
  3. Baseline removal (autofluorescence)
  4. Spectrum analysis (peak finding, ...)
  5. Synthetic spectrum generation (for testing and benchmarking)

Installation

ORPL is hosted and distributed through the python package index (https://pypi.org/project/orplib/) and can be installed with pip.

pip install orplib

If you have a virtual environment configured, don't forget to first activate the environment.

You can verify the installation by doing a pip list.

Building from source

This is the command you need to run if you want to build the .whl from the source code yourself (make sure you run it from orpl's project root directory):

python -m build

and to update the build on pypi (this is a reminder for me, it wont do anything if you do this),

python -m twine upload --repository pypi --skip-existing dist/*

Baseline removal

BubbleFill

Bubblefill is a morphological processing algorithm designed for the removal of baselines in spectroscopic signal. It was created and optimized specifically to remove autofluorescence baselines in Raman spectra measured on biological samples.

Bubblefill in action

The tuning parameter of Bubblefill is the size of the smallest bubble allowed to grow. In general, the smallest bubble width should be chosen to be larger than the widest Raman peak present in the signal. Otherwise, the baseline fit will grow inside the peaks and the output Raman signal will have under expressed peaks.

Note : Bubbles can become arbitrarily small if they are growing along the leftmost or rightmost edge of the signal.

Bubblefill with bubbles that are too small

Different smallest bubble widths can be specified for different regions of the spectrum. This enables nearly infinite tuninig of the algorithm and can be used to removed peaks that are known artifacts (for instance). In this example, the smallest bubble width for detector pixels 400 to 650 was set to 1 and to 100 for the rest of the x-axis.

Bubblefill with multiple smallest bubble widths

How to cite this work

Guillaume Sheehy, Fabien Picot, Frédérick Dallaire, Katherine Ember, Tien Nguyen, Kevin Petrecca, Dominique Trudel, and Frédéric Leblond "Open-sourced Raman spectroscopy data processing package implementing a baseline removal algorithm validated from multiple datasets acquired in human tissue and biofluids," Journal of Biomedical Optics 28(2), 025002 (21 February 2023). https://doi.org/10.1117/1.JBO.28.2.025002

BibTex (.bib)

@article{10.1117/1.JBO.28.2.025002,
author = {Guillaume Sheehy and Fabien Picot and Fr{\'e}d{\'e}rick Dallaire and Katherine Ember and Tien Nguyen and Kevin Petrecca and Dominique Trudel and Fr{\'e}d{\'e}ric Leblond},
title = {{Open-sourced Raman spectroscopy data processing package implementing a baseline removal algorithm validated from multiple datasets acquired in human tissue and biofluids}},
volume = {28},
journal = {Journal of Biomedical Optics},
number = {2},
publisher = {SPIE},
pages = {025002},
keywords = {Raman spectroscopy, fluorescence, tissue optics, open-sourced software, machine learning, optics, Raman spectroscopy, Data processing, Bubbles, Equipment, Tissues, Biological samples, Raman scattering, Fluorescence, Aluminum, Spectroscopy},
year = {2023},
doi = {10.1117/1.JBO.28.2.025002},
URL = {https://doi.org/10.1117/1.JBO.28.2.025002}
}

EndNote (.enw)

%0 Journal Article
%A Sheehy, Guillaume
%A Picot, Fabien
%A Dallaire, Frédérick
%A Ember, Katherine
%A Nguyen, Tien
%A Petrecca, Kevin
%A Trudel, Dominique
%A Leblond, Frédéric
%T Open-sourced Raman spectroscopy data processing package implementing a baseline removal algorithm validated from multiple datasets acquired in human tissue and biofluids
%V 28
%J Journal of Biomedical Optics
%N 2
%P 025002
%D 2023
%U https://doi.org/10.1117/1.JBO.28.2.025002
%DOI 10.1117/1.JBO.28.2.025002
%I SPIE

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orplib-1.0.1.tar.gz (50.8 kB view details)

Uploaded Source

Built Distribution

orplib-1.0.1-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

Details for the file orplib-1.0.1.tar.gz.

File metadata

  • Download URL: orplib-1.0.1.tar.gz
  • Upload date:
  • Size: 50.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.16

File hashes

Hashes for orplib-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6ca00616a90879e2eae99377c5c7bad51e3c23b1b56c76906729096c0fd82277
MD5 fd6b1a7a98cc267dbb3621b3491f369f
BLAKE2b-256 4c81ab8b4fda1a4907ef71bfeb38abcc5c0f4ed5ca29c4a647d8f27248ed71c8

See more details on using hashes here.

File details

Details for the file orplib-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: orplib-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 53.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.16

File hashes

Hashes for orplib-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2501b06a3f5029efd2d570efbdb77ae361e1e809d46df4bfae1709eb045165a2
MD5 030fcb8d752fdf5cfa043eea26f80fb3
BLAKE2b-256 09e0b5f422d4b99ffc2937ae9691c2a840ae524e2fd81f9314b984f0a34cd9cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page