Logo

User Guide

  • Installation
    • Installation using conda
      • 1. Creating a conda environment
      • 2. Installing the package in the new environment
      • 3. Getting Started
    • 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
      • Transformation of the variance
    • Interpolation to uniform axes
  • Signal tools
    • Scaling and normalizing signal data
    • Peak positions and properties
      • Peak identification
      • Peak Width
      • Calculating the centroid of a spectrum (centre of mass)
    • Signal statistics and analytical operations
    • Replacing negative data values
    • Crop edges
  • Working with streak images
    • Transition to one-dimensional signals
    • Iteration over the spectral or time dimension
  • Fitting luminescence data
    • Signal variance (noise)
  • Utility functions
    • Join spectra
    • Exporting text files
    • Mathematical routines
      • Unit conversion
      • Solving the grating equation
    • Cropping multiple signals in the navigation axis
  • LumiSpy metadata structure
    • General
    • Sample
    • Signal
    • Acquisition Instrument
    • Laser / SEM / TEM
      • Laser
      • Filter
    • Spectrometer
      • Grating
      • Filter
    • Detector
    • Spectral_image
  • Bibliography

Examples

  • Gallery of Examples
  • Data Processing
    • Remove Pixels
    • Remove Background
    • Remove Spikes
    • Rebinning
    • Data Smoothing
  • Plotting
    • Chromatic Imaging
    • Extraction of linescan

API reference

  • lumispy
    • lumispy package
      • Subpackages
        • lumispy.data package
        • lumispy.signals package
        • lumispy.utils package
      • Module contents

Tutorials

  • Demo notebooks

Release Notes

  • Changelog
    • UNRELEASED
      • 0.2.3.dev173+g6521492c9 [UNRELEASED] (2026-06-11)
        • New features
        • Enhancements
        • Improved Documentation
        • Maintenance
    • 0.3.0 (2025-02-23)
      • New features
      • Enhancements
      • Improved Documentation
      • Maintenance
    • 2023-03-15 - version 0.2.2
      • Changed
      • Maintenance
    • 2022-11-02 - version 0.2.1
      • Added
      • Changed
      • Maintenance
    • 2022-04-29 - version 0.2.0
      • Added
      • Changed
    • 2021-11-23 - version 0.1.3
      • Changed
    • 2021-08-22 - version 0.1.2
      • Added
      • Changed
    • 2021-03-26 - version 0.1.0
      • Added

Credits and citation

  • Citing LumiSpy
  • Contributing
    • Issues
    • Pull Requests
      • Reviewing
    • Documentation
    • Code style
    • Writing tests
    • Releasing a new version
  • License
  • On GitHub
LumiSpy
  • Search

© Copyright 2019-2026, The LumiSpy developers.

Built with Sphinx using a theme provided by Read the Docs.