Welcome to LumiSpy’s documentation!

LumiSpy is a Python package extending the functionality for multi-dimensional data analysis provided by the HyperSpy library. LumiSpy is aimed at helping with the analysis of luminescence spectroscopy data (cathodoluminescence, photoluminescence, electroluminescence, Raman, SNOM). Reading and writing of data from many relevant file types is provided by the library RosettaSciIO.

Check out the Installation section for further information on how to start using LumiSpy.

Complementing this documentation, the LumiSpy Demos repository contains curated Jupyter notebooks to provide tutorials and exemplary workflows.

Note

LumiSpy is under active development. Everyone is welcome to contribute. Please read our Contributing guidelines and get started!

Contents

User Guide

• Installation
  • Installation using conda
  • Installation using pip
  • Updating the package
• Introduction
  • What is LumiSpy
  • Signal types
  • Where are we heading?
• Non-uniform signal axes
  • The energy axis
  • The wavenumber axis/Raman shifts
  • Jacobian transformation
• Signal tools
  • Scaling and normalizing signal data
  • Peak positions and properties
  • Signal statistics and analytical operations
  • Replacing negative data values
  • Crop edges
• Fitting luminescence data
  • Signal variance (noise)
• Utility functions
  • Join spectra
  • Exporting text files
  • Mathematical routines
• LumiSpy metadata structure
  • General
  • Sample
  • Signal
  • Acquisition Instrument
  • Laser / SEM / TEM
  • Spectrometer
  • Detector
  • Spectral_image
• Bibliography

API reference

• lumispy
  • lumispy package

Tutorials

• Demo notebooks

Release Notes

• Changelog

Credits and citation

• Citing LumiSpy
• Contributing
• License
• On GitHub