Welcome to LumiSpy’s documentation!

LumiSpy is a Python package extending the functionality for multi-dimensional data analysis provided by the HyperSpy library. It is aimed at helping with the analysis of luminescence spectroscopy data (cathodoluminescence, photoluminescence, electroluminescence, Raman, SNOM).

Check out the Installation section for further information, including how to start using this project.

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

Note

This project is under active development. Everyone is welcome to contribute. Please read our (see 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
• Fitting luminescence data
  • Signal variance (noise)
• Utility functions
  • Join spectra
  • Utilities for spectral maps
  • Unit conversion
  • Solving the grating equation
• 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